Skip to content

control-plane-api #912

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.

Sign up for GitHub

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 1 commit into from
Aug 6, 2024
Merged

control-plane-api #912

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions docs/developer/admin-rest-api/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,10 @@ For example, if you have an Administrator role, you can get a list of clusters b

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.

## Administrator API Documentation
## Control Plane API Documentation

The Administrator API provides the developer interfaces for getting and manipulating the Run:ai metadata objects such as Projects, Departments, Clusters, and Users.
The Control Plane API provides the developer interfaces for getting and manipulating the Run:ai metadata objects such as Projects, Departments, Clusters, and Users.

Detailed API documentation can be found at [https://app.run.ai/api/docs](https://app.run.ai/api/docs){target=_blank}. This represents the latest control-plane documentation. If you are running a self-hosted version, see `https://<runai-company-url>/api/docs`.

[Administrator API Documentation](https://app.run.ai/api/docs){target=_blank .md-button .md-button--primary }
[Control Plane API Documentation](https://app.run.ai/api/docs){target=_blank .md-button .md-button--primary }
6 changes: 3 additions & 3 deletions docs/developer/overview-developer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,19 +22,19 @@ Run:ai is composed of a single, multi-tenant control plane. Each tenant can be c

Below is a diagram of the Run:ai API Architecture. A developer may:

1. Access the control plane via the _Administrator API_.
1. Access the control plane via the _Control Plane API_.
2. Access any one of the GPU clusters via _Cluster API_.
3. Access cluster metrics via the _Metrics API_.

![api architecture image](img/api-architecture.png)

## Administrator API
## Control Plane API

Add, delete, modify and list Run:ai meta-data objects such as Projects, Departments, Users, and more.

The API is provided as REST and is accessible via the control plane endpoint.

For more information see [Administrator REST API](admin-rest-api/overview.md).
For more information see [Control Plane REST API](admin-rest-api/overview.md).

## Cluster API

Expand Down
2 changes: 1 addition & 1 deletion docs/developer/rest-auth.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,4 +79,4 @@ The API response will look as follows:
To call APIs, the application must pass the retrieved `accessToken` as a *Bearer token* in the Authorization header of your HTTP request.

* To retrieve and manipulate Workloads, use the [Cluster API](cluster-api/workload-overview-dev.md). Researcher API works at the cluster level and you will have different endpoints for different clusters.
* To retrieve and manipulate other metadata objects, use the [Administrator REST API](admin-rest-api/overview.md). Administrator API works at the control-plane level and you have a single endpoint for all clusters.
* To retrieve and manipulate other metadata objects, use the [Control Plane REST API](admin-rest-api/overview.md). Control Plane API works at the control-plane level and you have a single endpoint for all clusters.
Loading