Configuring Integrations with CLI

  • Integrations must be connected to the platform or service through an authentication method offered by the service or platform, e.g. personal access token.

  • You have to configure the integration for a private GitLab server by hand because the metadata, i.e. hostname, can’t be known beforehand.

  • NGC, GitHub and GitLab integrations are immediately available in NVIDIA AI Workbench and only require a connection to the platform.

Assumptions for these instructions

  • You have the appropriate API key or token to make the desired connection.

Listing Integrations

Run the following command:

Copy
Copied!
            

nvwb list integrations

Example Output:

Copy
Copied!
            

workbench@NV-2G4NGG3:~$ nvwb list integrations Verifying credentials NAME │ DESCRIPTION │ CREDENTIALS │ CONNECTED ─────────┼────────────────┼─────────────────────────┼──────────── NGC │ ngc.nvidia.com │ container-registry │ false Github │ Github.com │ git, container-registry │ false Gitlab │ Gitlab.com │ git │ false

What Can Go Wrong

NA

Connecting to NGC

Run the following command, select NGC from the drop down list, and then enter your NGC API key at the prompt.

Copy
Copied!
            

nvwb connect integration

Example Output:

Copy
Copied!
            

workbench@NV-2G4NGG3:~$ nvwb connect integration ? (Optional) What is the PAT or API Key to use <my-key-here> NAME │ DESCRIPTION │ CREDENTIALS │ CONNECTED ─────────┼────────────────┼─────────────────────────┼──────────── NGC │ ngc.nvidia.com │ container-registry │ true Github │ Github.com │ git, container-registry │ false Gitlab │ Gitlab.com │ git │ false

What Can Go Wrong

NA

Connecting to a Git Server With a Personal Access Token

Run the following command, select the desired Git server from the drop-down list, and then enter your PAT at the prompt.

Copy
Copied!
            

nvwb connect integration

Example Output:

Copy
Copied!
            

(nvwb:local) workbench@NV-2G4NGG3:~$ nvwb connect integration ? Choose an integration to connect to AI Workbench Github ? (Optional) What is the PAT or API Key to use <my-pat-here> NAME │ DESCRIPTION │ CREDENTIALS │ CONNECTED ─────────┼────────────────┼─────────────────────────┼──────────── NGC │ ngc.nvidia.com │ container-registry │ false Github │ Github.com │ git, container-registry │ true Gitlab │ Gitlab.com │ git │ false

What Can Go Wrong

NA

Disconnecting an Integration

Run the following command, and select the integration of interest from the drop-down list.

Copy
Copied!
            

nvwb disconnect integration

Example Output:

Copy
Copied!
            

(nvwb:local) workbench@NV-2G4NGG3:~$ nvwb disconnect integration ? Choose an integration to disconnect NGC NAME │ DESCRIPTION │ CREDENTIALS │ CONNECTED ─────────┼────────────────┼─────────────────────────┼──────────── NGC │ ngc.nvidia.com │ container-registry │ false Github │ Github.com │ git, container-registry │ true Gitlab │ Gitlab.com │ git │ false

What Can Go Wrong

NA

NGC Account and API Key

  1. Login to your NGC account.

  2. Select the dropdown menu on the top-right, then select Setup.

  3. Under “Generate API Key”, select Get API Key.

  4. Select Generate API Key. Follow any instructions and keep the generated API key in a safe location.

Note

Generating a new NGC API Key may invalidate previous keys.

GitHub Personal Access Token

  1. Login to your GitHub account.

  2. Select the profile picture on the top-right, then select Settings.

  3. Select Developer Settings on the bottom of the left taskbar.

  4. Select Personal access tokens, then select Tokens (classic).

  5. Select Generate New Token and Generate new token (classic). Fill in the permissions and click Generate token Keep the generated PAT in a safe location.

GitLab Personal Access Token

  1. Login to your GitLab account.

  2. Select the profile picture on top of the left taskbar, then select Edit Profile.

  3. Select Access Tokens on the left taskbar.

  4. Select Add new token under “Personal Access Tokens”.

  5. Fill in the details and click Create personal access token Keep the generated PAT in a safe location.

Previous Managing Locations with CLI
Next Developing Projects in CLI
© Copyright 2023-2024, NVIDIA. Last updated on Jan 21, 2024.