Instances Management¶

The instances management page allows admins to create, edit, and delete workstation/workload templates. Including the ability to assign workstation/workload templates to specific groups, and projects. Each template row in the table, can be expanded so show additional details for the instance.

Pre-requisites¶

Before continuing, ensure you have installed a workstation template schema from Terra. You can find the instructions for this in the Terra Plugin Installation documentation.

Template Creation¶

Create button

At the top left of the table will be a create button, clicking this button opens a template creation wizard.

Schema Version

The first drop down, will list the available schema template versions. These will be filtered based on the instance type (workstation/workload) you are creating the template for. Once selected The template schema fields will appear for you to fill out.

Schema Fields

The schema fields available may differ between the schema version selected. The UI will prompt you for all required fields for the schema. Once the fields are filled out simply click submit at the bottom right, and the workstation template will now be created.

Extra Notes

Add Env Variables to each workstation independently
Assign workstation template to both user and project groups. Workstations will only be available for users if they share a group, and are assigned for the specific project.

Schema Field Types

When authoring a workstation/workload template via Terra The author of the plugin, can define additional fields within the configMaps data. These are then populated into the Genesis Front end UI.

Please note: Not all Genesis release versions have full field support. Field type and support is continuously added in newer release versions as we find the need for additional field handling.

Field Properties

name - name of the field
description - description of the field used for the tooltip
type - The type of field, which will determine how the front end handles the field. See below for our different types.
default - a default hardcoded value that will be auto filled upon opening the template creation form. This is None by default
required - True or False boolean defining whether or not the field is required for template creation. This is False by default
options - A list of options for our Multi and Select field types

Field Types

string - string text field input.
int - integer text field input
env - Environment Variable field. This is a default field that is automatically set for all schemas
boolean - True/False boolean type field
multi - A multi selection field. Using multi will require the field to include the options property for the user to have a list of options to select.
select - A single selection field. Using multi will require the field to include the options property for the user to have a list of options to select.
k8sPriority - A selection field for Kubernetes PriorityClasses. If set, we will automatically query all available priority class names from the cluster, and populate the available options

Actions¶

Edit

From the main table, admin users can choose to edit a workstation template, by clicking the pencil icon on the templates row. Doing so will pull up the same creation form, pre-filled in with the current template values. Users can edit any field as needed, the schema version will default to the current templates version, and is not editable. If a new version is needed, users can create a new workstation via the CREATE WORKSTATION button.

Delete

Admin users can also choose to delete a workstation template by click the red trash can icon, on the templates row. The user will be prompted with a confirmation before proceeding.