Skip to content

Updates #1432

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 1 commit into from
Feb 27, 2025
Merged

Updates #1432

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
2 changes: 1 addition & 1 deletion docs/Researcher/Walkthroughs/quickstart-inference.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ Under `Environments` Select __NEW ENVIRONMENT__. Then select:


!!! Note
* The above API snippet will only work with Run:ai clusters of 2.18 and above. For older clusters, use, the now deprecated [Cluster API](../../developer/cluster-api/submit-rest.md).
* The above API snippet will only work with Run:ai clusters of 2.18 and above.
* For more information on the Inference Submit API see [API Documentation](https://app.run.ai/api/docs#tag/Inferences)

This would start a triton inference server with a maximum of 2 instances, each instance consumes half a GPU.
Expand Down
3 changes: 1 addition & 2 deletions docs/Researcher/Walkthroughs/quickstart-vscode.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,8 +124,7 @@ Under `Environments` Select __NEW ENVIRONMENT__. Then select:
6. `toolName` text will show when connecting to the Visual Studio tool via the user interface.

!!! Note
* The above API snippet will only work with Run:ai clusters of 2.18 and above. For older clusters, use, the now deprecated [Cluster API](../../developer/cluster-api/submit-rest.md).
* For more information on the Training Submit API see [API Documentation](https://app.run.ai/api/docs#tag/Trainings/operation/create_training1)
For more information on the Training Submit API see [API Documentation](https://app.run.ai/api/docs#tag/Trainings/operation/create_training1)

This would start a Workspace with a pre-configured Visual Studio Code image with an allocation of a single GPU.

Expand Down
3 changes: 1 addition & 2 deletions docs/Researcher/Walkthroughs/walkthrough-build.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,8 +100,7 @@ To complete this Quickstart __via the CLI__, you will need to have the Run:ai CL
4. `<CLUSTER-UUID>` is the unique identifier of the Cluster. You can get the Cluster UUID by adding the "Cluster ID" column to the Clusters view.

!!! Note
* The above API snippet will only work with Run:ai clusters of 2.18 and above. For older clusters, use, the now deprecated [Cluster API](../../developer/cluster-api/submit-rest.md).
* For more information on the Workspace Submit API see [API Documentation](https://app.run.ai/api/docs#tag/Workspaces/operation/create_workspace1){target=_blank}
For more information on the Workspace Submit API see [API Documentation](https://app.run.ai/api/docs#tag/Workspaces/operation/create_workspace1){target=_blank}

* This would start a workload of type Workspace for `team-a` with an allocation of a single GPU.
* We named the Workload `build1`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ Before you start, make sure:
}'
```
!!! Note
The above API snippet runs with Run:ai clusters of 2.18 and above only. For older clusters, use the now deprecated [Cluster API](https://docs.run.ai/v2.20/developer/cluster-api/workload-overview-dev/).
The above API snippet runs with Run:ai clusters of 2.18 and above only.


## Step 3: Submitting the second workspace
Expand Down Expand Up @@ -203,7 +203,7 @@ Before you start, make sure:
```

!!! Note
The above API snippet runs with Run:ai clusters of 2.18 and above only. For older clusters, use the now deprecated [Cluster API.](https://docs.run.ai/v2.20/developer/cluster-api/workload-overview-dev/)
The above API snippet runs with Run:ai clusters of 2.18 and above only.


## Step 4: Connecting to the Jupyter Notebook
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ Before you start, make sure:
This would start a workspace with a pre-configured Jupyter image with 10% of the GPU memory allocated.

!!! Note
The above API snippet runs with Run:ai clusters of 2.18 and above only. For older clusters, use the now deprecated [Cluster API](https://docs.run.ai/v2.20/developer/cluster-api/workload-overview-dev/).
The above API snippet runs with Run:ai clusters of 2.18 and above only.


## Step 3: Connecting to the Jupyter Notebook
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ Before you start, make sure:
```

!!! Note
The above API snippet runs with Run:ai clusters of 2.18 and above only. For older clusters, use the now deprecated [Cluster API](https://docs.run.ai/v2.20/developer/cluster-api/workload-overview-dev/).
The above API snippet runs with Run:ai clusters of 2.18 and above only.


## Step 3: Submitting the second inference workload
Expand Down Expand Up @@ -191,7 +191,7 @@ Before you start, make sure:


!!! Note
The above API snippet runs with Run:ai clusters of 2.18 and above only. For older clusters, use the now deprecated [Cluster API](https://docs.run.ai/v2.20/developer/cluster-api/workload-overview-dev/).
The above API snippet runs with Run:ai clusters of 2.18 and above only.


## Step 4: Submitting the first workspace
Expand Down Expand Up @@ -285,7 +285,7 @@ Before you start, make sure:
```

!!! Note
The above API snippet runs with Run:ai clusters of 2.18 and above only. For older clusters, use the now deprecated [Cluster API](https://docs.run.ai/v2.20/developer/cluster-api/workload-overview-dev/).
The above API snippet runs with Run:ai clusters of 2.18 and above only.


## Step 5: Submitting the second workspace
Expand Down Expand Up @@ -346,7 +346,7 @@ Before you start, make sure:
```

!!! Note
The above API snippet runs with Run:ai clusters of 2.18 and above only. For older clusters, use the now deprecated [Cluster API](https://docs.run.ai/v2.20/developer/cluster-api/workload-overview-dev/).
The above API snippet runs with Run:ai clusters of 2.18 and above only.


## Step 6: Connecting to Chatbot-UI
Expand Down
4 changes: 2 additions & 2 deletions docs/Researcher/workloads/inference/inference-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Run:ai provides *Inference* services as an equal part together with the other tw

* Multiple replicas will appear in Run:ai as a single *Inference* workload. The workload will appear in all Run:ai dashboards and views as well as the Command-line interface.

* Inference workloads can be submitted via Run:ai user interface as well as [Run:ai API](../../developer/cluster-api/workload-overview-dev.md). Internally, spawning an Inference workload also creates a Kubernetes *Service*. The service is an end-point to which clients can connect.
* Inference workloads can be submitted via Run:ai user interface as well as [Run:ai API](https://api-docs.run.ai/latest/tag/Inferences). Internally, spawning an Inference workload also creates a Kubernetes *Service*. The service is an end-point to which clients can connect.

## Autoscaling

Expand Down Expand Up @@ -110,4 +110,4 @@ The resources (GPUs, CPUs) are not occupied by a new Knative revision until it s

* To set up *Inference*, see [Cluster installation prerequisites](../../../admin/runai-setup/cluster-setup/cluster-prerequisites.md#inference).
* For running *Inference* see [Inference quick-start](../../Walkthroughs/quickstart-inference.md).
* To run *Inference* using API see [Workload overview](../../../developer/cluster-api/workload-overview-dev.md).
* To run *Inference* using API see [Inferences API](https://api-docs.run.ai/latest/tag/Inferences).
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ Before you start, make sure:
This would start a standard training workload based on a sample docker image, runai.jfrog.io/demo/quickstart, with one GPU allocated.

!!! Note
The above API snippet will only work with Run:ai clusters of 2.18 and above. For older clusters, use, the now deprecated [Cluster API](../../../../developer/cluster-api/submit-rest.md).
The above API snippet will only work with Run:ai clusters of 2.18 and above.



Expand Down
2 changes: 1 addition & 1 deletion docs/Researcher/workloads/workspaces/quickstart-jupyter.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ Before you start, make sure:
6. `toolName` text will show when connecting to the Jupyter tool via the user interface.

!!! Note
The above API snippet will only work with Run:ai clusters of 2.18 and above. For older clusters, use, the now deprecated [Cluster API](../../../developer/cluster-api/submit-rest.md).
The above API snippet will only work with Run:ai clusters of 2.18 and above.



Expand Down
4 changes: 2 additions & 2 deletions docs/admin/authentication/researcher-authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ The following instructions explain how to complete the configuration of access c


!!! Important
* As of Run:ai version 2.16, you only need to perform these steps when accessing Run:ai from the [command-line interface](../researcher-setup/cli-install.md) or sending [YAMLs directly](../../developer/cluster-api/submit-yaml.md) to Kubernetes
* As of Run:ai version 2.18, you only need to perform these steps when if using the older command-line interface or sending [YAMLs directly](../../developer/cluster-api/submit-yaml.md) to Kubernetes.
* As of Run:ai version 2.16, you only need to perform these steps when accessing Run:ai from the [command-line interface](../researcher-setup/cli-install.md).
* As of Run:ai version 2.18, you only need to perform these steps when if using the older command-line interface.


## Kubernetes Configuration
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/troubleshooting/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,7 @@ See [Cluster Health Troubleshooting](..//config/clusters.md#troubleshooting-scen
__Symptoms:__

* The `New workload type` -> `Inference` button is grayed out.
* Cannot create a deployment via [Inference API](../../developer/cluster-api/submit-yaml.md#inference-workload-example).


__Root Cause:__ Run:ai Inference prerequisites have not been met.

Expand Down
12 changes: 0 additions & 12 deletions docs/developer/overview-developer.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ The following programming interfaces are available:
| API | Description | Purpose |
|---------|--------------|--------------|
| __Run:ai REST API__ | Get and Modify any Run:ai business object | This is the API mostly used by system developers. The API is also used by the Run:ai user interface as well as the __new__ command-line interface |
| __Cluster API (Deprecated)__ | Submit Workloads directly to the Cluster | A YAML-based API allowing submittion of Workloads directly to the Cluster. With Run:ai 2.18, this API is replaced by the above Run:ai, which is now the recommended method |
| __Metrics API (deprecated)__ | Get cluster metrics | Get utilization metrics. |


Expand All @@ -42,17 +41,6 @@ For more information see [Run:ai REST API](admin-rest-api/overview.md).

For details, see the [Deprecation notifications](../home/whats-new-2-17.md#deprecation-notifications).

## Cluster API (Deprecated)

The [Cluster API](cluster-api/workload-overview-dev.md) allows you to submit and delete Workloads directly to the cluster itself.

The API is provided as [Kubernetes API](./cluster-api/submit-yaml.md).

Cluster API is accessible via the GPU cluster itself. As such, **multiple clusters may have multiple endpoints**.

!!! Important
* This API is replaced by a Run:ai REST API to submit jobs, which is now the recommended method for cluster versions of 2.18 and above.
* If you are looking to automate tasks with older versions of Run:ai, it's best to use the [Run:ai Command-line interface](../Researcher/cli-reference/Introduction.md) which provides forward compatibility.

## Metrics API

Expand Down
4 changes: 2 additions & 2 deletions docs/home/whats-new-2-18.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ date: 2024-June-14

#### YAML Workload Reference table

* <!-- RUN-17487/RUN-17656 -->Added a new YAML reference document that contains the value types and workload YAML references. Each table contains the field name, its description and the supported Run:ai workload types. The YAML field details contains information on the value type and currently available example workload snippets. For more information see, [YAML Reference](../developer/cluster-api/submit-yaml.md) PDF.
* <!-- RUN-17487/RUN-17656 -->Added a new YAML reference document that contains the value types and workload YAML references. Each table contains the field name, its description and the supported Run:ai workload types. The YAML field details contains information on the value type and currently available example workload snippets. For more information see, [YAML Reference](https://docs.run.ai/v2.18/developer/cluster-api/submit-yaml/) PDF.

#### Email Notifications - Workload Status and timeouts

Expand Down Expand Up @@ -131,7 +131,7 @@ The endpoints and parameters specified in the API reference are the ones that ar

##### Cluster API Deprecation

Run:ai REST API now supports job submission. The older, [Cluster API](../developer/cluster-api/workload-overview-dev.md) is now deprecated.
Run:ai REST API now supports job submission. The older, [Cluster API](https://docs.run.ai/v2.18/developer/cluster-api/workload-overview-dev/) is now deprecated.


##### Departments API
Expand Down
2 changes: 1 addition & 1 deletion docs/platform-admin/integrations/integration-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,5 +47,5 @@ Examples of such resources are a *Deployment* that manages a stateless applicati

Run:ai natively runs Run:ai Workloads. A Run:ai workload encapsulates all the resources needed to run, creates them, and deletes them together. However, Run:ai, being an **open platform** allows the scheduling of **any** Kubernetes Workflow.

For more information see [Kubernetes Workloads Integration](../../developer/cluster-api/other-resources.md).
For more information see [Kubernetes Workloads Integration](../../developer/other-resources/other-resources.md).

2 changes: 0 additions & 2 deletions docs/platform-admin/workloads/policies/old-policies.md
Original file line number Diff line number Diff line change
Expand Up @@ -362,6 +362,4 @@ kubectl delete InteractivePolicy interactive-policy -n runai

To access _project-specific_ policies, replace the `-n runai` parameter with the namespace of the relevant project.

## See Also

* For creating workloads based on policies, see the Run:ai [submitting workloads](../../../developer/cluster-api/workload-overview-dev.md)
8 changes: 2 additions & 6 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,7 @@ plugins:
'platform-admin/workloads/policies/README.md' : 'platform-admin/workloads/policies/overview.md'
'platform-admin/workloads/inference-overview.md' : 'Researcher/workloads/inference/inference-overview.md'
'developer/deprecated/inference/submit-via-yaml.md' : 'developer/cluster-api/other-resources.md'
'developer/cluster-api/other-resources.md' : 'developer/other-resources/other-resources.md'
'developer/admin-rest-api/data-volumes.md' : 'platform-admin/workloads/assets/data-volumes.md'
'developer/cluster-api/submit-cron-yaml.md' : 'developer/cluster-api/other-resources.md'
'Researcher/scheduling/using-node-pools.md' : 'platform-admin/aiinitiatives/resources/node-pools.md'
Expand Down Expand Up @@ -452,12 +453,7 @@ nav:
- 'User Applications' : 'developer/user-applications.md'
- 'API Authentication' : 'developer/rest-auth.md'
- 'REST API' : 'developer/admin-rest-api/overview.md'
- 'Cluster API (Deprecated)' :
- 'Overview' : 'developer/cluster-api/workload-overview-dev.md'
- 'Submit Workload via YAML' : 'developer/cluster-api/submit-yaml.md'
- 'Submit Workload via HTTP/REST' : 'developer/cluster-api/submit-rest.md'
- 'Reference' : 'developer/cluster-api/reference.md'
- 'Metrics' :
- 'Metrics via API' : 'developer/metrics/metrics-api.md'
- '(Deprecated) Metrics via Prometheus' : 'developer/metrics/metrics.md'
- 'Kubernetes Workloads Integration' : 'developer/cluster-api/other-resources.md'
- 'Kubernetes Workloads Integration' : 'developer/other-resources/other-resources.md'
Loading