Secrets (Sensitive Environment Variables)

Secrets are environment variables that contain sensitive information. Once secret variables are created, their value is always masked and never displayed to the user. Unlike Environment Variables, values for Secrets are handled by AI Workbench and not made available via a file in the project repository.

If a secret is created/ deleted/ updated while the project container is running, you must restart the project container for the changes to take effect.

Desktop

Creating a Secret

Open AI Workbench window and select the location
Select an existing project
Select the Environment tab on the left
Navigate to the Secrets section and click on the Add button
Enter the Name and Value for the secret and click on the Add button to create the secret
Click on Configure and enter the Value for the secret

Deleting a Secret

Open AI Workbench window and select the location
Select an existing project
Select the Environment tab on the left
Navigate to the Secrets section and click on the 3 dots and select Remove Secret
Click on Remove to delete the secret

Updating a Secret

Open AI Workbench window and select the location
Select an existing project
Select the Environment tab on the left
Navigate to the Secrets section and click on the 3 dots and select Edit Secret
Enter the new value for the secret and click on Save to update the secret

CLI

Note

Creating a secret through the CLI only creates the definition for it. Secrets have to be configured with values by running nvwb configure secrets before they can be used.

Creating a Secret

Open the terminal and activate the desired context (location)
Run nvwb open to open an existing project
Run nvwb create secret
Enter the secret name
Enter an optional description for the secret
Run nvwb configure secrets. Select the secret to configure
Enter the value for the secret

Deleting a Secret

Open the terminal and activate the desired context (location)
Run nvwb open to open an existing project
Run nvwb delete secret
Select the secret to delete. You are not prompted for confirmation

Updating a Secret

Open the terminal and activate the desired context (location)
Run nvwb open to open an existing project
Run nvwb configure secrets. Select the secret to update
Enter the updated value for the secret

Next Steps

Mounts

Common Questions

How are Secrets different from Environment Variables?: Secrets are environment variables that contain sensitive information. Once secret variables are created, their value is always masked and never displayed to the user. Unlike Environment Variables, values for Secrets are handled by AI Workbench and not made available via a file in the project repository.

Previous Environment Variables

Next AI Workbench Mounts