Skip to content

Commit 119a98a

Browse files
authored
Merge pull request #928 from run-ai/small-fixes3
small-fixes3
2 parents cd21d97 + 8c8a3da commit 119a98a

File tree

3 files changed

+13
-4
lines changed

3 files changed

+13
-4
lines changed

docs/Researcher/cli-reference/new-cli/runai.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,15 @@ authors:
66
date: 2024-Jun-18
77
---
88

9+
## The new Command-line interface
10+
11+
This command-line interface is a complete revamp of the command-line interface. Few highlights:
12+
13+
* The CLI internally uses the [Control-plane API](../../../developer/admin-rest-api/overview.md). This provides a single point of view on Workloads removing dissemilarities between the user interface and the command-line interface.
14+
* As such, it also removes the need to configure the [Kubernetes API server](../../../admin/authentication/researcher-authentication.md) for authentication.
15+
* The CLI is only available for Run:ai cluster version 2.18 and up.
16+
* The new CLI is backward compatible with the older CLI.
17+
918
## Summary
1019

1120
The Run:ai Command-line Interface (CLI) tool for a Researcher to send deep learning workloads, acquire GPU-based containers, list jobs, and access other features in the Run:ai platform.

docs/developer/admin-rest-api/overview.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Control Plane REST API
22

3-
The purpose of the Administrator REST API is to provide an easy-to-use programming interface for administrative tasks.
3+
The purpose of the Control Plane REST API is to provide an easy-to-use programming interface for administrative tasks.
44

55
## Endpoint URL for API
66

7-
The domain used for Administrator REST APIs is the same domain used to browse for the Run:ai User Interface. Either `<company>.run.ai`, or `app.run.ai` for older tenants or a custom URL used for Self-hosted installations.
7+
The domain used for Control Plane REST APIs is the same domain used to browse for the Run:ai User Interface. Either `<company>.run.ai`, or `app.run.ai` for older tenants or a custom URL used for Self-hosted installations.
88

99
## Authentication
1010

@@ -41,7 +41,7 @@ For example, if you have an Administrator role, you can get a list of clusters b
4141
```
4242
(replace `<ACCESS-TOKEN>` with the bearer token from above).
4343

44-
For an additional example, see the [following](https://github.com/run-ai/docs/blob/master/examples/create-user-and-project.py){target=_blank} code. It is an example of how to use the Run:ai Administrator REST API to create a User and a Project and set the User to the Project.
44+
For an additional example, see the [following](https://github.com/run-ai/docs/blob/master/examples/create-user-and-project.py){target=_blank} code. It is an example of how to use the Run:ai Control Plane REST API to create a User and a Project and set the User to the Project.
4545

4646
## Control Plane API Documentation
4747

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11

2-
For a full reference for the YAML API parameters see the [YAML Reference](Workload-YAML-Reference-v1.pdf).
2+
For a full reference for the YAML API parameters see the [YAML Reference](Workload-YAML-Reference-v1.pdf) document.

0 commit comments

Comments
 (0)