Gradient Docs
Gradient HomeHelp DeskCommunitySign up free
Gradient Next
Gradient Next
  • About Gradient
  • Get Started
    • Quick Start
      • Install the Gradient CLI
    • Core Concepts
    • Organizing Projects
      • Secrets
      • Storing an API key as a Secret
    • Tutorials
      • Gradient Notebooks Tutorial
      • Gradient Workflows Tutorial
      • Gradient Deployments Tutorial
    • FAQ
    • Common Errors
  • Gradient Platform
    • Gradient Notebooks
      • Runtimes
      • Files and storage
      • Machines
      • Terminal
      • Shortcuts
      • Sharing
      • TensorBoard
      • Run on Gradient
    • Gradient Workflows
      • Basic operations
      • Understanding Inputs & Outputs
      • Workflow Spec
      • Gradient Actions
      • Environment Variables
      • Using YAML for Data Science
    • Gradient Deployments
      • Basic operations
      • Deployment Spec
  • Artifacts
    • Container Management
      • Custom Containers
    • Data
      • Versioned Data
        • Public Datasets Repository
        • Storage Providers
      • Persistent Storage
    • Models
      • Managing Models
        • Model Types & Metadata
        • Public Models
    • Code
    • Metrics
      • Push Metrics
      • View & Query Metrics
  • Gradient Cluster
    • Overview
      • Setup
        • Managed Private Clusters
        • Self-Hosted Clusters
          • Pre-installation steps
          • Gradient Installer CLI
          • Terraform
            • Pre-installation steps
            • Install on AWS
            • Install on bare metal / VMs
            • Install on NVIDIA DGX
          • Let's Encrypt DNS Providers
          • Updating your cluster
      • Usage
  • More
    • SDK
      • Projects Client
      • Models Client
      • Deployments Client
      • Workflows Client
      • SDK Examples
      • Full SDK Reference
    • Machine Types
      • Machine Tiers
      • Free Machines (Free Tier)
    • Your Account
      • Teams
        • Creating a Team
        • Upgrading to a Team Plan
      • Hotkeys
      • Billing & Subscriptions
        • Storage Billing
      • Public Profiles
    • Release notes
    • Roadmap
Powered by GitBook
On this page
  • Managing and Using Secrets
  • Set a Secret
  • List Secrets
  • Delete a Secret
  • Secret scoping
  1. Get Started
  2. Organizing Projects

Secrets

PreviousOrganizing ProjectsNextStoring an API key as a Secret

Last updated 3 years ago

Managing and Using Secrets

Secrets allow you to store sensitive information at the team, private cluster, and project level. The secrets you create are available to use in Workflows run on private clusters.

Secrets can be created at the following levels:

  • Team: these secrets are applied to all projects and all clusters

  • Project: these secrets are applied to all Workflows in a project

  • Cluster: these secrets are applied to all Workflows in a cluster

Secrets can be set from the Settings tab in the web UI or through the CLI.

View the full CLI/SDK Docs for Secrets here:

Set a Secret

Navigate to one of:

  • The Secrets tab under Team settings

  • The Settings tab under a Project

  • The Secrets tab in the details of a Cluster under the Team settings Clusters tab

These correspond to Team, Project, and Cluster secrets respectively. Type in the name and value of the secret, and click Add to save.

Set team secret

gradient secrets set team --name=<name> --value=<secret>

Set project secret

gradient secrets set project --id=<project_id> --name=<name> --value=<secret>

Set cluster secret

gradient secrets set cluster --id=<cluster_id> --name=<name> --value=<secret>

List Secrets

Navigate to the Project, Team, or Cluster page, as with setting a secret above. The names of secrets in that scope that are already stored are listed.

List team secrets

gradient secrets list team

List project secrets

gradient secrets list project --id=<Project ID>

List cluster secrets

gradient secrets list cluster --id=<Cluster ID>

Delete a Secret

Navigate to the Project, Team, or Cluster page, as with setting a secret above. Click the Delete button and confirm the dialog.

Delete team secret

gradient secrets delete team --name=<name>

Delete project secret

gradient secrets delete project --id=<Project ID> --name=<name>

Delete cluster secrets

gradient secrets delete cluster --id=<Cluster ID> --name=<name>

Secret scoping

If the same secret name is created for more than one scope, only one will be applied.

Secrets with the same name have the following precedence:

  • Cluster secrets take precedence over Team secrets

  • Project secrets take precedence over both Cluster secrets and Team secrets.

For the full list of options, see the .

CLI reference
https://paperspace.github.io/gradient-cli/gradient.cli.html#gradient-secrets