Cluster UI

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

Settings

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

../_images/cluster_ui_settings.png

Jobs

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.

../_images/genvid_ui_cluster.png

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.

../_images/cluster_ui_settings_job.png

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.
../_images/cluster_ui_settings_job_form.png

Logs

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.

../_images/genvid_ui_logs.png

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

../_images/cluster_ui_settings_log.png

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.
../_images/cluster_ui_settings_log_form.png

Events

This page enables you to view the events results.

../_images/genvid_ui_events.png

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

../_images/cluster_ui_settings_event.png

Config

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

../_images/cluster_ui_settings_config.png

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.
../_images/cluster_ui_settings_configKey.png

Click the Submit button before leaving the page to save your changes.