Admin Guide¶

The DKubeX Admin Page provides administrators with control over an existing DKubeX setup. From the Admin page, you can configure OAuth and license, manage cloud, vectorstore and datasource settings, view user and workspace details, and monitor logs and metrics for clusters, nodes, and the DKubeX setup.

Accessing DKubeX Admin Page¶

To access the DKubeX Admin page, add /admin at the end of your DKubeX setup URL.
https://<DKubeX-URL>/admin
https://dkubex.example.com/admin
Provide your DKubeX admin username and password and click on the Login button.

Admin page login screen¶

Components¶

The Admin page consists of the following components:

Auth

Configure OAuth settings for DKubeX.

./admin.html#auth

Settings

Configure workspace, SMTP, cloud and vectorstore settings.

./admin.html#settings

Users

View, configure and control user-specific details, roles and workspace configurations.

./admin.html#users

Templates

Create app images and compute resource templates for workspaces.

./admin.html#templates

Datasources

Configure and manage AWS S3 bucket mounts.

./admin.html#datasources

Nodes

Monitor node-specific details.

./admin.html#nodes

License

Configure and update DKubeX license settings.

./admin.html#license-admin

Metrics

Monitor DKubeX setup and cluster statistics.

./admin.html#metrics

Logs

Monitor DKubeX controller logs.

./admin.html#logs

Auth¶

In the Auth tab, you can configure OAuth settings for DKubeX. DKubeX currently supports 6 OAuth providers: ADFS, Azure, GitHub, Google, Keycloak, and Okta.

For detailed information regarding setting up OAuth, refer to the following page:

OAuth

Learn how to set up OAuth for DKubeX.

./post-install.html#oauth

Settings¶

The Settings tab in the Admin page allows you to configure workspace, SMTP, cloud provider and vectorstore settings. Click on the appropriate tab below to know more about these settings.

In the General tab, you can configure settings regarding DKubeX address, workspace and app timeouts, and workspace log retention limit.

General Settings¶
Field	Description
`DKubeX Address`	Your DKubeX URL. This address will be used by SkyPilot jobs to contact your DKubeX cluster from remote Sky cluster.
`App Idle Time Alert (seconds)`	The time in seconds after which the user will be alerted if the app is idle.
`App Idle Auto Shutdown Timeout (seconds)`	The time in seconds after which the app will be automatically shut down if it is idle.
`Workspace Idle Time Alert (seconds)`	The time in seconds after which the user will be alerted if the workspace is idle.
`Workspace Idle Auto Shutdown Timeout (seconds)`	The time in seconds after which the workspace will be automatically shut down if it is idle.
`Log retention period (days)`	The number of days for which the logs will be retained.

Additionally, you can also enable workspace creation for newly onboarded users by checking the Do you want to enable workspace? checkbox.

In the SMTP tab, you can configure the SMTP settings for DKubeX. This will enable sending emails to users regarding apps or workspace idle status or auto shutdown.

Check the SMTP Enable checkbox to enable SMTP settings, and provide the following details.

SMTP Settings¶
Field	Description
`Server`	SMTP server address.
`Port`	SMTP server port.
`Username`	SMTP server username.
`Password`	SMTP server password.

In the Cloud Provider tab, you can configure the cloud provider settings for DKubeX. This will enable users to run SkyPilot workflows.

Cloud Provider Settings¶
Field	Description
`Choose the cloud provider`	Cloud provider name (currently AWS is only configurable here).
`Access Key ID`	Cloud provider access key.
`Access Key Secret`	Cloud provider secret key.

In the Vectorstore tab, you can configure the vectorstore settings for DKubeX.

Vectorstore Settings¶
Field	Description
`Choose the vector store provider`	Vectorstore provider name (currently `weaviate_grpc` is only configurable here).
`Hostname`	Vectorstore host IP.
`Port Number`	Vectorstore host port.

Users¶

In this tab, you can view details regarding all users who have logged in to DKubeX. The following details are displayed:

User Details¶
Field	Description
`User Name`	DKubeX username of the user.
`Role`	Whether the user has been assigned admin role.
`Status`	Whether the user has been onboarded on or being deboarded from DKubeX, or whether ownership has been transferred.
`First Name`/`Last Name`	First and last name of the user.
`Email`	Email address of the user.

Along with these details, the following options are available on the right side of the page for each user:

Additional User Options¶
Field	Description
`Add Admin Role`	User is non-admin. Assign admin role to user by clicking on this option. Users with admin access can delete and archive MLFlow experiments and models.
`Remove Admin Role`	User is admin. Remove admin role from the user by clicking on this option.
`Workspace Enabled`	Workspace is currently enabled for the user. Disable workspace for the user by clicking on this option.
`Workspace Disabled`	Workspace is currently disabled for the user. Enable workspace for the user by clicking on this option.

You can offboard users from DKubeX by selecting them on the left checkboxes and clicking on the Offboard User button on the top right corner.
Clicking on the username opens a pop-up window containing the workspace details for that respective user. You can select the workspace to access options to either stop or delete the workspace.

User Workspace Details¶

Templates¶

The templates tab allows you to create app images that can be used by users to launch different workspaces as well as create a template to compute resources to be used by a workspace from the Apps and Instance tabs respectively.

The Apps tab allows you to control the apps available in a workspace by default.

To edit the default apps, click on the three dots in any of the displayed options & choose the edit option.

Datasources¶

The Datasources tab will allow you to mount any pre-existing S3 bucket, from which data can be extracted and used in DKubeX workflows.

Datasources Details¶
Field	Description
`Name`	The name of the S3 bucket.
`Description`	Displays the description of the bucket (if any).
`S3 URL`	The URL of the S3 bucket.
`Access Mode`	Displays whether the given user has Read only or Read and Write access to the mounted S3 bucket.
`Added By`	Displays name of the user that has added the S3 bucket.

By clicking on the + at the top right corner, you can mount any pre-existing S3 bucket.

Datasource Mounting Details¶
Field	Description
`Name`	The name of the S3 bucket.
`Description`	The description of the S3 bucket.
`Bucket Name`	The name of the S3 bucket.
`Bucket path`	The path to the S3 bucket.
`Access key id`	Your AWS access key id.
`Secret access key`	Your AWS secret access key.
`Access Mode`	Displays whether the given user has Read only or Read and Write access to the mounted S3 bucket.

Nodes¶

The Nodes tab contains the list of all nodes & your details, such as:

Node Details¶
Field	Description
`Name`	The name of the node.
`Age`	The duration of time that has passed since the node’s creation.
`Status`	Whether the node is Ready or not.
`Workspaces`	Number of Workspaces on the Node.
`CPU`	CPU cores of the node.
`Memory`	The Memory used by each node.
`Disk`	The Disk space used by each node.

You can view more details regarding a particular node by clicking on the node’s name. In the popup window, you can also view the workspaces on the node along with their status & ages.

License¶

The License tab allows you to view and update the current DKubeX license settings. For more information regarding DKubeX license settings, refer to the following page: Step 1: Provide DKubeX License.

Metrics¶

In the Metrics tab, you can monitor the DKubeX stats & Cluster stats of every user at any given time.

You can monitor the DKubeX stats such as App Usage, Active Workspaces, etc. at any given time. Furthermore, by clicking on any point on the graphs, you can get a more detailed view of any individual user’s data at that time on the graph.

Logs¶

You can view the controller pod logs on this page.

Click on the drop down option at the start of each log to view all the details of the log.

Logging Out¶

Click on the profile icon on the top right corner and choose the option Logout to log out of the admin page.