Getting Started

DKube Trial Installation

If you are running DKube from a trial installation, the account is set up for DKube use.

  • The DKube application is pre-installed on the target system
    • A URL, and all of the necessary credentials for the application, will be provided
    • If you are the DKube Operator, a license token will be provided
  • The system is initially set up for local use. A single user is enabled.
    • If more than one user is required, GitHub authorization must be enabled, as described in section Credentials & Roles
  • Example models & datasets for DKube are available as part of the installation
    • The models and datasets can be imported from the GitHub repositories (See Repos)
    • The test images are located in the same GitHub repository
  • An initial guide to getting started with the platform is provided in at Using DKube

Initiating Dashboard and Workflow Screens

  • Access the DKube site at the URL provided
    • Chrome and Firefox browsers are supported
  • If the DKube instance has not yet been signed in, sign in with the credentials provided. The login will be either local or through GitHub, as described below.

Note

If you get a message that your connection is not private, it is because the certificate is self-signed. Please proceed to the url.

Note

If you get an “Authentication Failed” or “Network Error” message after reaching the login page, simply refresh your browser window. This is not a valid error.

  • If the login flow asks for the account to be authorized, please select the authorize button and provide the credentials.
  • This will bring up the DKube dashboard. For subsequent launches, the GitHub credentials will be remembered, and the login screen will not appear.

Providing the License Token

If the system is being used for the first time, a license token needs to be entered in order to use the system. If you an Operator, you will be provided with a token to use when this happens. Paste in the token provided and select submit.

_images/Operator_Renew_License_Popup.png

The same process is used to renew the license if it expires.

Credentials & Roles

There are 2 authorization mechanisms for accessing DKube.

Local Authorization

Local authorization is used to access DKube after installation. It is based on a username and password. The credentials were provided as part of the installation process, and you will receive them from the cluster manager.

Local authorization allows the user to operate as both an Operator and Data Scientist (see below DKube User Roles ). Most of the functions of DKube are active when locally authorized, and it is meant to allow the product to be tested, or to allow one organization to install DKube and then hand it over to another organization.

In order to allow other users to be added to the system, and before doing significant work, the GitHub authorization should be activated. Once the GitHub authorization is activated, DKube cannot go back to local authorization.

Note

After activating the GitHub credentials, the work performed as part of the local authorization is lost.

GitHub Authorization

GitHub authorization allows Users to be added to Groups and share Pools, as described in the section Using DKube. All of the functions of DKube are available in this mode. In order to move from local to GitHub authorization, the Operator selects the OAuth menu item on the left.

This will bring up the “OAuth Providers” screen.

_images/Operator_OAuth.jpg

The “Activate” button should be selected under the “Actions” column, and this will bring up the GitHub authorization popup screen.

_images/Operator_OAuth_Popup.jpg

The GitHub credentials are as follows:

Git User Name GitHub user name for operator
Organization Name GitHub organization name
Client ID GitHub Client ID from OAuth app (see Create OAuth App)
Client Secret GitHub Client Secret from OAuth app (see Create OAuth App)
Access Token GitHub access token (see Create GitHub Token)
OAuth Details

For the OAuth App, the following field definitions are required. The “access url” is the url that is used to run DKube from your browser.

Homepage URL https://<Access url>:32222
Authorization callback URL https://<Access url>:32222/callback

Important

Note that the access url needs be “https://

_images/OAuth_Fields.jpg
Access Token Details

During the creation of the GitHub access token, the “repo” permissions should be selected.

_images/GitHub_Access_Token.jpg

Important

The GitHub access token should be saved for future use. It cannot be viewed after the initial token creation is completed.

DKube User Roles

There are 2 roles for a User:

Operator Can access both the Operator & Data Scientist screens & workflow
Data Scientist Can only access the Data Scientist screens & workflow

Dashboards

Operator Manages the infrastructure for Nodes, Devices, Users, Groups, Pools, and Devices
Data Scientist Provides a flexible workflow for Programs, Datasets, Notebooks, Jobs, Inference, and Pipelines

If the User is logged in as an Operator, the dashboards can be selected with a left-click on the User icon in the top right-hand side of the screen (circled in the screen shot). Once selected, the dashboards toggle between the Operator & Data Scientist views. The details of the dashboards are provided in the pertinent sections.

_images/User_Type_Toggle.jpg _images/Operator_Right_Menu_Toggle.jpg