Skip to content

small-fixes3 #928

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/Researcher/cli-reference/new-cli/runai.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions docs/developer/admin-rest-api/overview.md
Original file line number Diff line number Diff line change
@@ -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 `<company>.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 `<company>.run.ai`, or `app.run.ai` for older tenants or a custom URL used for Self-hosted installations.

## Authentication

Expand Down Expand Up @@ -41,7 +41,7 @@ For example, if you have an Administrator role, you can get a list of clusters b
```
(replace `<ACCESS-TOKEN>` 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

Expand Down
2 changes: 1 addition & 1 deletion docs/developer/cluster-api/reference.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@

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