Admin Guide¶
The DKubeX admin page allows any user with the admin credentials to modify a pre-existing DKubeX setup. From the Admin page, you can access data such as authentication, list & details of every user accessing the setup, metrics of DKubeX and the clusters, etc.
Logging In¶
To access the Admin page, add /admin at the end of your DKubeX setup URL.
Example: If your DKubeX setup URL is;
https://a1183e6450d4e4d138415gaf0d11b362-62d15cf634758ebd.elb.us-east-1.amazonaws.com
Then, to access the Admin page, add /admin at the end as shown below;
https://a1183e6450d4e4d138415gaf0d11b362-62d15cf634758ebd.elb.us-east-1.amazonaws.com/admin
Enter your credentials when prompted, after updating the URL.
After entering the credentials and logging in, you can access the DKubeX Admin page.
Auth¶
DKubeX currently supports multiple types of authentication - Azure, Keycloak & ADFS, Okta, Github & Google.
To authenticate a user to a particular DKubeX setup via Okta, you will need to provide:
Issuer URL of the OAuth App.
Client ID of the OAuth App.
Client Secret associated with the Client ID of the OAuth .
To authenticate a user to a particular DKubeX setup via Okta, you will need to provide:
Issuer URL of the OAuth App.
Client ID of the OAuth App.
Client Secret associated with the Client ID of the OAuth.
Tenant ID of your Azure account.
To authenticate a user to a particular DKubeX setup via GitHub, you will need to provide:
Client ID of the OAuth App.
Client Secret associated with the Client ID of the OAuth App.
Note
Both the ClientId & the Client Secret can be obtained from the DKubeX-OAuth App from Github.
A Redirect URL to access the DKubeX page.
Your Organization details. [OPTIONAL]
Your Organization’s Email Domain. [OPTIONAL]
To authenticate a user to a particular DKubeX setup via Google, you will need to provide:
Client ID of the OAuth App.
Client Secret associated with the Client ID of the OAuth App.
A Redirect URL to access the DKubeX page.
Your Organization’s Email Domain. [OPTIONAL]
To authenticate a user to a particular DKubeX setup via Okta, you will need to provide:
Issuer URL of the OAuth App.
Client ID of the OAuth App.
Client Secret associated with the Client ID of the OAuth.
Realm name of your Keycloak account.
Your Organization’s Email Domain. [OPTIONAL]
User Group of the user.
Allowed role of the user.
A Redirect URL to access the DKubeX page.
To authenticate a user to a particular DKubeX setup via Okta, you will need to provide:
Issuer URL of the OAuth App.
Client ID of the OAuth App.
Client Secret associated with the Client ID of the OAuth .
A Redirect URL to access the DKubeX page.
User¶
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.
