You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/admin/researcher-setup/cli-install.md
+11-12Lines changed: 11 additions & 12 deletions
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Install the Run:ai Command-line Interface
2
2
3
-
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.
3
+
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.
4
4
5
5
The instructions below will guide you through the process of installing the CLI. The Run:ai CLI runs on Mac and Linux. You can run the CLI on Windows by using Docker for Windows. See the end of this document.
6
6
@@ -11,33 +11,32 @@ When enabled, Researcher authentication requires additional setup when installin
11
11
12
12
## Prerequisites
13
13
14
-
*When installing the command-line interface, it is worth considering future upgrades:
15
-
* Install the CLI on a dedicated _Jumpbox_ machine. Researchers will connect to the Jumpbox from which they can submit Run:ai commands
14
+
* When installing the command-line interface, it is worth considering future upgrades:
15
+
* Install the CLI on a dedicated *Jumpbox* machine. Researchers will connect to the Jumpbox from which they can submit Run:ai commands
16
16
* Install the CLI on a shared directory that is mounted on Researchers' machines.
17
-
* A __Kubernetes configuration file__.
18
-
17
+
* A **Kubernetes configuration file**.
19
18
20
19
## Setup
21
20
22
21
### Kubernetes Configuration
23
22
24
-
* On the Researcher's root folder, create a directory _.kube_. Copy the Kubernetes configuration file into the directory. Each Researcher should have a __separate copy__ of the configuration file. The Researcher should have _write_ access to the configuration file as it stores user defaults.
25
-
*If you choose to locate the file at a different location than `~/.kube/config`, you must create a shell variable to point to the configuration file as follows:
23
+
*In the Researcher's root folder, create a directory *.kube*. Copy the Kubernetes configuration file into the directory. Each Researcher should have a **separate copy** of the configuration file. The Researcher should have *write* access to the configuration file as it stores user defaults.
24
+
* If you choose to locate the file at a different location than `~/.kube/config`, you must create a shell variable to point to the configuration file as follows:
26
25
27
26
```
28
27
export KUBECONFIG=<Kubernetes-config-file>
29
28
```
30
29
31
-
*Test the connection by running:
30
+
* Test the connection by running:
32
31
33
32
```
34
33
kubectl get nodes
35
34
```
36
35
37
-
### Install Run:ai CLI
36
+
### Install Run:ai CLI
38
37
39
38
* Go to the Run:ai user interface. On the top right select `Researcher Command Line Interface`.
40
-
* Select `Mac`, `Linux` or `Windows`.
39
+
* Select `Mac`, `Linux` or `Windows`.
41
40
* Download directly using the button or copy the file to run it on a remote machine
42
41
43
42
=== "Mac or Linux"
@@ -48,7 +47,7 @@ kubectl get nodes
48
47
sudo mv runai /usr/local/bin/runai
49
48
```
50
49
51
-
=== "Windows"
50
+
=== "Windows"
52
51
Rename the downloaded file to have a `.exe` extension and move the file to a folder that is a part of the `PATH`.
53
52
54
53
!!! Note
@@ -63,7 +62,7 @@ To verify the installation run:
63
62
runai list jobs
64
63
```
65
64
66
-
## Install Command Auto-Completion
65
+
## Install Command Auto-Completion
67
66
68
67
It is possible to configure your Linux/Mac shell to complete Run:ai CLI commands. This feature works on _bash_ and _zsh_ shells only.
0 commit comments