Cluster UI

Cluster UI is a website responsible for managing a Genvid cluster. It is a GUI over the cluster-api


This page enables you to see and edit the system configuration.



This page manages the jobs in the bastion cluster. From this page, you can:
  • See the status of each job.
  • Start and stop the stacks and jobs.
  • Go to the corresponding hashi-ui Job page.

Once the jobs are started, you are presented with the project links to the website.


If you wish to edit the jobs, go to the Settings page and navigate to the Jobs section. There are job templates that are available for download in text format with the extension of .nomad.tmpl.


When configuring a job:

  • Name
    The name of the job should match the name of the template file as well as the name of the job in the template file.
  • Dependencies
    A list of services to wait on before starting the job. The default is None.
  • Autostart
    Check this option if the job must automatically start on a start command without arguments.
  • Template
    You can drag and drop an ASCII file to update the template. The job name must be the same as the template name for the scripts to work correctly. See Nomad Templates for more information.


This page shows the task logs. When the service is running, the log will refresh automatically. You can set the log level to either the default or per allocation logger log level.


If you wish to edit the logs, go to the Settings page and navigate to the Logs section.


When configuring a log:

  • ID
    The log ID. Once the ID is created, it can’t be changed.
  • File Name
    The file name. Example: stderr, stdout.
  • Job
    The ID of the job.
  • Group
    The ID of the task group.
  • Task
    The ID of the task.
  • Log Level
    Check this option if the log should support dynamic log levels that change the amount of information on a log. The log level can be debug, info, warning, error, fatal, or panic.


This page enables you to view the events results.


If you wish to edit the events and/or their categories, go to the Settings page and navigate to the Events section.



This page shows the configuration keys loaded for this project. It also lets you modify existing keys, create new ones, and delete existing ones.


When creating a new key or modifying an existing key:

  • Key Name
    The key name which is divided by / to indicate the proper config level.
  • Key Value
    The content of the key.
  • Click the Submit button before leaving the page to save your changes.

Any modified keys not yet saved to the server are highlighted in yellow. Click SAVE to save your changes and sync them with the server configuration.



This page displays the cluster-api is connected or not. All pages will be redirected here if the cluster-api is not able to connect to the cluster. This will be the case when the status of a cluster is not UP. The cluster-api should be able to connect automatically to the cluster when its status changes to UP.


For the cluster-UI to work properly:

  • The cluster must be UP.
  • A Terraform output variable named server_public_ips must be present with a list of IPs.
  • Consul must be running on those IPs and exposed as port 8500 to the bastion server.
  • A Terraform output variable named private_key_pem must be present with the SSH private key.


Display the services’ health.

The column on the left shows the services and their instances. The instances have a different color according to their health.

  • Green: All the health checks are passing.
  • Orange: At least one health checks is in a working state.
  • Red: At least one health checks is in a critical state.

In this page you can:

  • Hide the system services to focus on the important services.
  • Refresh the status.
  • Click on a service instance to see it’s details.

In the detail section you can see:

  • The service information.
  • The node on which the service is running.
  • The health checks for this service.