Install the Run:AI Command-line Interface¶

The Run:AI Command-line Interface (CLI) is one of the ways for a researcher to send deep learning workloads, acquire GPU-based containers, list jobs, etc.

The instructions below will guide you through the process of installing the CLI.

Prerequisites¶

• Run:AI CLI runs on Mac and Linux.

• When installing the command-line interface its worth considering future upgrades:

  • Install the CLI on a dedicated Jumpbox machine. Researches will connect to the Jumpbox from which they can submit Run:AI commands
  • Install the CLI on a shared directory that is mounted on Researchers' machines.

• Kubectl (Kubernetes command-line interface) installed and configured to access your cluster. Please refer to https://kubernetes.io/docs/tasks/tools/install-kubectl/

• Helm. See https://helm.sh/docs/intro/install/ on how to install Helm. Run:AI works with Helm version 3 only (not helm 2).
• A Kubernetes configuration file obtained from a computer previously connected to the Kubernetes cluster

Kubernetes Configuration¶

• Create a directory .kube. Copy the Kubernetes configuration file into the directory

• Create a shell variable to point to the above configuration file. Example:

  export KUBECONFIG=~/.kube/config
  

• Test the connection by running:

  kubectl get nodes
  

Run:AI CLI Installation¶

• Download the latest release from the Run:AI releases page
• Unarchive the downloaded file

• Install by running:

  sudo ./install-runai.sh
  

• To verify the installation run:

  runai list jobs
  

Troubleshooting the CLI Installation¶

See Troubleshooting a CLI installation

Updating the Run:AI CLI¶

To update the CLI to the latest version run:

sudo runai update