Introduction¶

Genesis is the official dashboard for managing your entire Orion ecosystem. From here, users can create, manage, and connect to projects. It provides tools for user and group management across projects, services, and roles. Storage, network capabilities, and custom workstations and workloads can all be configured on a per-project basis. Additionally, apps can be installed via Terra, and the Orion license can be managed directly from the dashboard.

intro

Main links/Installed Cluster Apps¶

On the left side of the screen, users will find a sidebar. To expand it, click the icon in the top-left corner of the page. To collapse the sidebar, click the arrow at the top. Here you will find the main links, Cluster Installed apps (If you have any), and help links which are located at the bottom of the side bar

Sidebar

Help Links¶

These links are located at the bottom of the side bar.

Link Name	Definition
Help	Starts a help stepper that will guide you on how to use the main functionalities of the genesis UI.
Documentation	Links you to our Official Orion Documentation.
Feature Request	Links you to our Github report repo where you can open a ticket for a new feature.
Report a Bug	Links you to our GitHub report repo where you can open a ticket for an issue you encounter.

helplinks

Click the user icon located in the top right of genesis to open the user menu. Here you can access the settings page, create an api token, development page and log out.

Settings page¶

Here you can update the current version of each service deployment and restart the deployment. Submitting an empty value will have the service inherit the version from the Genesis-Deployment targetRevision value. Refreshing will restart the service.

settings-page

Create API Token¶

If you want to hit our service API's you will need to generate an API token. Open the user menu and click Create API Token.

create-api-token

Development¶

We use FastAPI under the hood for our services. You can navigate to our development page to directly use the FastAPI Swagger UI to hit our services. Each service is available specifically to admin users or users assigned to the respective group. This can be used for testing or development purposes.

development-page

Dashboard widgets¶

The homepage of genesis will have two widgets displayed. These are used for quick access/viewing.

Your Projects¶

This widget displays your active projects. For a project to appear in this widget, your user must be assigned to the project group, and the project must be active. Learn more about user group assignment here.

Nodes¶

This widget displays the following types of nodes

Node type	Description
Service nodes	Represent projects.
Workstation nodes	Show all active running workstations and workloads.
Headless nodes	Represent workloads running without a user interface (e.g. render node).

Learn more about the nodes and network page here.