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
/adminat the end of your DKubeX setup URL.https://<DKubeX-URL>/adminhttps://dkubex.example.com/adminProvide 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:
Configure OAuth settings for DKubeX.
Configure workspace, SMTP, cloud and vectorstore settings.
View, configure and control user-specific details, roles and workspace configurations.
Create app images and compute resource templates for workspaces.
Configure and manage AWS S3 bucket mounts.
Monitor node-specific details.
Configure and update DKubeX license settings.
Monitor DKubeX setup and cluster statistics.
Monitor DKubeX controller logs.
Auth¶
OAuth settings¶
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:
Learn how to set up OAuth for DKubeX.
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.
General Workspace Settings¶
In the General tab, you can configure settings regarding DKubeX address, workspace and app timeouts, and workspace log retention limit.
Field |
Description |
|---|---|
|
Your DKubeX URL. This address will be used by SkyPilot jobs to contact your DKubeX cluster from remote Sky cluster. |
|
The time in seconds after which the user will be alerted if the app is idle. |
|
The time in seconds after which the app will be automatically shut down if it is idle. |
|
The time in seconds after which the user will be alerted if the workspace is idle. |
|
The time in seconds after which the workspace will be automatically shut down if it is idle. |
|
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.
SMTP Settings¶
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.
Field |
Description |
|---|---|
|
SMTP server address. |
|
SMTP server port. |
|
SMTP server username. |
|
SMTP server password. |
Cloud Provider Settings¶
In the Cloud Provider tab, you can configure the cloud provider settings for DKubeX. This will enable users to run SkyPilot workflows.
Field |
Description |
|---|---|
|
Cloud provider name (currently AWS is only configurable here). |
|
Cloud provider access key. |
|
Cloud provider secret key. |
Vectorstore Settings¶
In the Vectorstore tab, you can configure the vectorstore settings for DKubeX.
Field |
Description |
|---|---|
|
Vectorstore provider name (currently |
|
Vectorstore host IP. |
|
Vectorstore host port. |
Users¶
User Settings¶
In this tab, you can view all the users that have accessed your setup. The data regarding the users that you can view:
Username - The DKubeX workspace username of the users.
Role - Shows Whether a user is and Admin or not.
Status - Check whether a user has been onboarded or not.
First Name & Last Name - Full Names of the users.
Email ID - The Email ID the users used to access the setup.
Inactive Workspaces - Number of inactive workspaces of a user.
Any user can be made an admin by clicking on the Add admin role button at the end of each username tab.
By clicking on a username, you can access further details regarding the workspaces of that particular user such as:
User Name - Name of the workspace.
Status - Whether the workspace is running or not.
Apps - The icons of the apps available on the workspace.
Last Used - When the workspace was last used.
Age - The amount of time that has passed since the creation of the workspace.
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.
These templates can then be used in the DKubeX page, as shown above.
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.
In the Instance tab, you can control the resources allocated to a workspace.
To edit the templates, click on the three dots in any of the displayed options & choose the edit option. you can edit the CPUs, GPUs & Memory (In GB) that can be allotted.
Datasources¶
The Datasources tab will allow you to mount any pre-existing S3 bucket.
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.
Name - The datasource name.
Description - the datasource description of the bucket (if any).
Bucket Name - The name 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.
Added By - Displays name of the user that has added the S3 bucket.
Nodes¶
The Nodes tab contains the list of all nodes & your details, such as:
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.
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.
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.
Example: Selecting a point on the workspaces graph in the image below provided the total number of workspaces active.
You can monitor the Cluster stats such as CPU utilization, Memory usage, etc. of all of the users at any given time. By selecting any point on the graphs, you can view more detailed information about that user’s stats at that particular time.
Example: In the second Image below, the memory utilized by a user at a particular time has been displayed.
Logs¶
You can view the d3X Controller 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.
