From a331d30acd103e55f958b1c4721da8bf720b3e1c Mon Sep 17 00:00:00 2001 From: Yaron Date: Wed, 7 Aug 2024 16:48:05 +0300 Subject: [PATCH 1/3] small-fixes3 --- docs/developer/cluster-api/reference.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/developer/cluster-api/reference.md b/docs/developer/cluster-api/reference.md index 190378e24f..09e92bc6b4 100644 --- a/docs/developer/cluster-api/reference.md +++ b/docs/developer/cluster-api/reference.md @@ -1,2 +1,2 @@ -For a full reference for the YAML API parameters see the [YAML Reference](Workload-YAML-Reference-v1.pdf). \ No newline at end of file +For a full reference for the YAML API parameters see the [YAML Reference](Workload-YAML-Reference-v1.pdf) document. \ No newline at end of file From 4611ba0b1df83a9de787da821970e2078395abb9 Mon Sep 17 00:00:00 2001 From: Yaron Date: Wed, 7 Aug 2024 16:56:27 +0300 Subject: [PATCH 2/3] new-cli-intro --- docs/Researcher/cli-reference/new-cli/runai.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/Researcher/cli-reference/new-cli/runai.md b/docs/Researcher/cli-reference/new-cli/runai.md index c0d5f20e1f..2dc35bb703 100644 --- a/docs/Researcher/cli-reference/new-cli/runai.md +++ b/docs/Researcher/cli-reference/new-cli/runai.md @@ -6,6 +6,15 @@ authors: date: 2024-Jun-18 --- +## The new Command-line interface + +This command-line interface is a complete revamp of the command-line interface. Few highlights: + +* 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. +* As such, it also removes the need to configure the [Kubernetes API server](../../../admin/authentication/researcher-authentication.md) for authentication. +* The CLI is only available for Run:ai cluster version 2.18 and up. +* The new CLI is backward compatible with the older CLI. + ## Summary 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. From 8c8a3da9b43fed9291dcc6f7a5e16c1684c15ba1 Mon Sep 17 00:00:00 2001 From: Yaron Date: Wed, 7 Aug 2024 16:57:49 +0300 Subject: [PATCH 3/3] api-name-change --- docs/developer/admin-rest-api/overview.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/developer/admin-rest-api/overview.md b/docs/developer/admin-rest-api/overview.md index 60a7f232b2..187373a974 100644 --- a/docs/developer/admin-rest-api/overview.md +++ b/docs/developer/admin-rest-api/overview.md @@ -1,10 +1,10 @@ # Control Plane REST API -The purpose of the Administrator REST API is to provide an easy-to-use programming interface for administrative tasks. +The purpose of the Control Plane REST API is to provide an easy-to-use programming interface for administrative tasks. ## Endpoint URL for API -The domain used for Administrator REST APIs is the same domain used to browse for the Run:ai User Interface. Either `.run.ai`, or `app.run.ai` for older tenants or a custom URL used for Self-hosted installations. +The domain used for Control Plane REST APIs is the same domain used to browse for the Run:ai User Interface. Either `.run.ai`, or `app.run.ai` for older tenants or a custom URL used for Self-hosted installations. ## Authentication @@ -41,7 +41,7 @@ For example, if you have an Administrator role, you can get a list of clusters b ``` (replace `` with the bearer token from above). -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. +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. ## Control Plane API Documentation