diff --git a/docs/Researcher/Walkthroughs/quickstart-inference.md b/docs/Researcher/Walkthroughs/quickstart-inference.md index 40fd3dc1b3..318891dc20 100644 --- a/docs/Researcher/Walkthroughs/quickstart-inference.md +++ b/docs/Researcher/Walkthroughs/quickstart-inference.md @@ -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. diff --git a/docs/Researcher/Walkthroughs/quickstart-vscode.md b/docs/Researcher/Walkthroughs/quickstart-vscode.md index 4599b66e5e..9707d5de17 100644 --- a/docs/Researcher/Walkthroughs/quickstart-vscode.md +++ b/docs/Researcher/Walkthroughs/quickstart-vscode.md @@ -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. diff --git a/docs/Researcher/Walkthroughs/walkthrough-build.md b/docs/Researcher/Walkthroughs/walkthrough-build.md index 4f1442d58d..3dc0e9cd25 100644 --- a/docs/Researcher/Walkthroughs/walkthrough-build.md +++ b/docs/Researcher/Walkthroughs/walkthrough-build.md @@ -100,8 +100,7 @@ To complete this Quickstart __via the CLI__, you will need to have the Run:ai CL 4. `` 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`. diff --git a/docs/Researcher/scheduling/launching-workloads-with-dynamic-gpu-fractions.md b/docs/Researcher/scheduling/launching-workloads-with-dynamic-gpu-fractions.md index 36ad28477d..75a09a0118 100644 --- a/docs/Researcher/scheduling/launching-workloads-with-dynamic-gpu-fractions.md +++ b/docs/Researcher/scheduling/launching-workloads-with-dynamic-gpu-fractions.md @@ -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 @@ -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 diff --git a/docs/Researcher/scheduling/launching-workloads-with-gpu-fractions.md b/docs/Researcher/scheduling/launching-workloads-with-gpu-fractions.md index 63e89f72c2..9093591197 100644 --- a/docs/Researcher/scheduling/launching-workloads-with-gpu-fractions.md +++ b/docs/Researcher/scheduling/launching-workloads-with-gpu-fractions.md @@ -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 diff --git a/docs/Researcher/scheduling/launching-workloads-with-gpu-memory-swap.md b/docs/Researcher/scheduling/launching-workloads-with-gpu-memory-swap.md index dd68a3f74e..d280452996 100644 --- a/docs/Researcher/scheduling/launching-workloads-with-gpu-memory-swap.md +++ b/docs/Researcher/scheduling/launching-workloads-with-gpu-memory-swap.md @@ -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 @@ -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 @@ -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 @@ -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 diff --git a/docs/Researcher/workloads/inference/inference-overview.md b/docs/Researcher/workloads/inference/inference-overview.md index a778687950..083e8b79e2 100644 --- a/docs/Researcher/workloads/inference/inference-overview.md +++ b/docs/Researcher/workloads/inference/inference-overview.md @@ -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 @@ -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). diff --git a/docs/Researcher/workloads/training/standard-training/quickstart-standard-training.md b/docs/Researcher/workloads/training/standard-training/quickstart-standard-training.md index 4d15450430..8e5043228a 100644 --- a/docs/Researcher/workloads/training/standard-training/quickstart-standard-training.md +++ b/docs/Researcher/workloads/training/standard-training/quickstart-standard-training.md @@ -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. diff --git a/docs/Researcher/workloads/workspaces/quickstart-jupyter.md b/docs/Researcher/workloads/workspaces/quickstart-jupyter.md index 953dc25ae6..39e87a5351 100644 --- a/docs/Researcher/workloads/workspaces/quickstart-jupyter.md +++ b/docs/Researcher/workloads/workspaces/quickstart-jupyter.md @@ -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. diff --git a/docs/admin/authentication/researcher-authentication.md b/docs/admin/authentication/researcher-authentication.md index df7612c4cf..6c0a3c6778 100644 --- a/docs/admin/authentication/researcher-authentication.md +++ b/docs/admin/authentication/researcher-authentication.md @@ -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 diff --git a/docs/admin/troubleshooting/troubleshooting.md b/docs/admin/troubleshooting/troubleshooting.md index 53029c52b2..60d0217c0a 100644 --- a/docs/admin/troubleshooting/troubleshooting.md +++ b/docs/admin/troubleshooting/troubleshooting.md @@ -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. diff --git a/docs/developer/cluster-api/other-resources.md b/docs/developer/other-resources/other-resources.md similarity index 100% rename from docs/developer/cluster-api/other-resources.md rename to docs/developer/other-resources/other-resources.md diff --git a/docs/developer/overview-developer.md b/docs/developer/overview-developer.md index 11f8ba33fc..7912050f91 100644 --- a/docs/developer/overview-developer.md +++ b/docs/developer/overview-developer.md @@ -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. | @@ -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 diff --git a/docs/home/whats-new-2-18.md b/docs/home/whats-new-2-18.md index 6708c07fde..2ddf711be0 100644 --- a/docs/home/whats-new-2-18.md +++ b/docs/home/whats-new-2-18.md @@ -55,7 +55,7 @@ date: 2024-June-14 #### YAML Workload Reference table -* 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. +* 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 @@ -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 diff --git a/docs/platform-admin/integrations/integration-overview.md b/docs/platform-admin/integrations/integration-overview.md index e0973d7cfe..806653cc90 100644 --- a/docs/platform-admin/integrations/integration-overview.md +++ b/docs/platform-admin/integrations/integration-overview.md @@ -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). diff --git a/docs/platform-admin/workloads/policies/old-policies.md b/docs/platform-admin/workloads/policies/old-policies.md index 96ac7374b4..4802f37b8c 100644 --- a/docs/platform-admin/workloads/policies/old-policies.md +++ b/docs/platform-admin/workloads/policies/old-policies.md @@ -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) diff --git a/docs/developer/cluster-api/Workload-YAML-Reference-v1.pdf b/graveyard/deprecated/cluster-api/Workload-YAML-Reference-v1.pdf similarity index 100% rename from docs/developer/cluster-api/Workload-YAML-Reference-v1.pdf rename to graveyard/deprecated/cluster-api/Workload-YAML-Reference-v1.pdf diff --git a/docs/developer/cluster-api/reference.md b/graveyard/deprecated/cluster-api/reference.md similarity index 100% rename from docs/developer/cluster-api/reference.md rename to graveyard/deprecated/cluster-api/reference.md diff --git a/docs/developer/cluster-api/submit-rest.md b/graveyard/deprecated/cluster-api/submit-rest.md similarity index 100% rename from docs/developer/cluster-api/submit-rest.md rename to graveyard/deprecated/cluster-api/submit-rest.md diff --git a/docs/developer/cluster-api/submit-yaml.md b/graveyard/deprecated/cluster-api/submit-yaml.md similarity index 100% rename from docs/developer/cluster-api/submit-yaml.md rename to graveyard/deprecated/cluster-api/submit-yaml.md diff --git a/docs/developer/cluster-api/workload-overview-dev.md b/graveyard/deprecated/cluster-api/workload-overview-dev.md similarity index 100% rename from docs/developer/cluster-api/workload-overview-dev.md rename to graveyard/deprecated/cluster-api/workload-overview-dev.md diff --git a/mkdocs.yml b/mkdocs.yml index 2e2bd0b35c..89c8dca514 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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' @@ -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'