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
  • Prerequisites
  • Installation
  • Profiles
  • Usage
  • Additional Prerequisites
  • Setting up a new cluster
  • Setting up or upgrading an existing cluster
  • Uninstalling a cluster
  1. Gradient Cluster
  2. Overview
  3. Setup
  4. Self-Hosted Clusters

Gradient Installer CLI

PreviousPre-installation stepsNextTerraform

Last updated 3 years ago

Gradient Installer is a CLI to set up and manage Gradient private clusters on AWS, GCP, Azure, NVIDIA DGX, and bare metal.

Terraform is used under the hood to setup all the infrastructure. Terraform modules can also be used directly to integrate Gradient into an existing Terraform setup.

Prerequisites

  • Paperspace account with an appropriate billing plan and API key

  • to store Terraform state

Installation

To install the Gradient Installer CLI, run the following command:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/paperspace/gradient-installer/master/bin/install)"
gradient-installer update

Profiles

Gradient Installer CLI support multiple profiles. To setup the CLI with a different profile run:

export PAPERSPACE_PROFILE=favorite-team
gradient-installer setup

Usage

Additional Prerequisites

  • AWS credentials to an S3 bucket to store cluster state information

  • Domain where Gradient will be accessed

  • DNS provider information to register your Gradient domain

  • (Optional): Service account credentials for a container registry such as Docker Hub.

Setting up a new cluster

gradient-installer clusters up

This will prompt you for information to register and create your private cluster.

Setting up or upgrading an existing cluster

gradient-installer clusters up CLUSTER_HANDLE

Uninstalling a cluster

gradient-installer clusters down CLUSTER_HANDLE

From : artifacts bucket and credentials, SSL certificates or Let's Encrypt Settings

AWS S3 bucket
Pre-installation steps