diff --git a/docs/odh-rhoai/kueue-premption/Makefile b/docs/odh-rhoai/kueue-preemption/Makefile similarity index 90% rename from docs/odh-rhoai/kueue-premption/Makefile rename to docs/odh-rhoai/kueue-preemption/Makefile index 1b5156d6..6ec8a8e7 100644 --- a/docs/odh-rhoai/kueue-premption/Makefile +++ b/docs/odh-rhoai/kueue-preemption/Makefile @@ -1,9 +1,9 @@ BASE:=$(shell dirname $(realpath $(lastword $(MAKEFILE_LIST)))) SHELL=/bin/sh -.PHONY: teardown-kueue-premption setup-kueue-premption +.PHONY: teardown-kueue-preemption setup-kueue-preemption -teardown-kueue-premption: +teardown-kueue-preemption: -oc delete -f $(BASE)/team-a-ray-cluster-prod.yaml -f $(BASE)/team-b-ray-cluster-dev.yaml -oc delete -f $(BASE)/team-a-cq.yaml -f $(BASE)/team-b-cq.yaml -f $(BASE)/shared-cq.yaml @@ -18,7 +18,7 @@ teardown-kueue-premption: @echo "Deleting all resourceflavors" oc delete resourceflavor --all --all-namespaces -setup-kueue-premption: +setup-kueue-preemption: oc create -f $(BASE)/team-a-ns.yaml -f $(BASE)/team-b-ns.yaml oc create -f $(BASE)/team-a-rb.yaml -f $(BASE)/team-b-rb.yaml diff --git a/docs/odh-rhoai/kueue-premption/clean-kueue.sh b/docs/odh-rhoai/kueue-preemption/clean-kueue.sh similarity index 100% rename from docs/odh-rhoai/kueue-premption/clean-kueue.sh rename to docs/odh-rhoai/kueue-preemption/clean-kueue.sh diff --git a/docs/odh-rhoai/kueue-premption/default-flavor.yaml b/docs/odh-rhoai/kueue-preemption/default-flavor.yaml similarity index 100% rename from docs/odh-rhoai/kueue-premption/default-flavor.yaml rename to docs/odh-rhoai/kueue-preemption/default-flavor.yaml diff --git a/docs/odh-rhoai/kueue-premption/gpu-flavor.yaml b/docs/odh-rhoai/kueue-preemption/gpu-flavor.yaml similarity index 100% rename from docs/odh-rhoai/kueue-premption/gpu-flavor.yaml rename to docs/odh-rhoai/kueue-preemption/gpu-flavor.yaml diff --git a/docs/odh-rhoai/kueue-premption/readme.md b/docs/odh-rhoai/kueue-preemption/readme.md similarity index 95% rename from docs/odh-rhoai/kueue-premption/readme.md rename to docs/odh-rhoai/kueue-preemption/readme.md index b31c53de..c477fb85 100644 --- a/docs/odh-rhoai/kueue-premption/readme.md +++ b/docs/odh-rhoai/kueue-preemption/readme.md @@ -1,6 +1,6 @@ # Introduction -In [this repo](https://github.com/opendatahub-io-contrib/ai-on-openshift/tree/main/docs/odh-rhoai/kueue-premption), we will demostrate how to use quota allocation with Kueue with preemption. +In [this repo](https://github.com/opendatahub-io-contrib/ai-on-openshift/tree/main/docs/odh-rhoai/kueue-preemption), we will demostrate how to use quota allocation with Kueue with preemption. ## Overview In this example, there are 2 teams that work in their own namespace: @@ -90,7 +90,7 @@ Team A will preempt team B because it has insufficient resources to run. ```bash git clone https://github.com/opendatahub-io-contrib/ai-on-openshift - cd ai-on-openshift/docs/odh-rhoai/kueue-premption + cd ai-on-openshift/docs/odh-rhoai/kueue-preemption ``` 5. Run the makefile target to setup the example. This will setup 2 namespaces: team-a and team-b. @@ -101,7 +101,7 @@ Team A will preempt team B because it has insufficient resources to run. To teardown the example, you can use: ```bash -make teardown-kueue-premption +make teardown-kueue-preemption ``` !!! warning The setup script will delete all clusterqueues and resourceflavors in the cluster. diff --git a/docs/odh-rhoai/kueue-premption/shared-cq.yaml b/docs/odh-rhoai/kueue-preemption/shared-cq.yaml similarity index 100% rename from docs/odh-rhoai/kueue-premption/shared-cq.yaml rename to docs/odh-rhoai/kueue-preemption/shared-cq.yaml diff --git a/docs/odh-rhoai/kueue-premption/team-a-cq.yaml b/docs/odh-rhoai/kueue-preemption/team-a-cq.yaml similarity index 100% rename from docs/odh-rhoai/kueue-premption/team-a-cq.yaml rename to docs/odh-rhoai/kueue-preemption/team-a-cq.yaml diff --git a/docs/odh-rhoai/kueue-premption/team-a-local-queue.yaml b/docs/odh-rhoai/kueue-preemption/team-a-local-queue.yaml similarity index 100% rename from docs/odh-rhoai/kueue-premption/team-a-local-queue.yaml rename to docs/odh-rhoai/kueue-preemption/team-a-local-queue.yaml diff --git a/docs/odh-rhoai/kueue-premption/team-a-ns.yaml b/docs/odh-rhoai/kueue-preemption/team-a-ns.yaml similarity index 100% rename from docs/odh-rhoai/kueue-premption/team-a-ns.yaml rename to docs/odh-rhoai/kueue-preemption/team-a-ns.yaml diff --git a/docs/odh-rhoai/kueue-premption/team-a-ray-cluster-prod.yaml b/docs/odh-rhoai/kueue-preemption/team-a-ray-cluster-prod.yaml similarity index 100% rename from docs/odh-rhoai/kueue-premption/team-a-ray-cluster-prod.yaml rename to docs/odh-rhoai/kueue-preemption/team-a-ray-cluster-prod.yaml diff --git a/docs/odh-rhoai/kueue-premption/team-a-rb.yaml b/docs/odh-rhoai/kueue-preemption/team-a-rb.yaml similarity index 100% rename from docs/odh-rhoai/kueue-premption/team-a-rb.yaml rename to docs/odh-rhoai/kueue-preemption/team-a-rb.yaml diff --git a/docs/odh-rhoai/kueue-premption/team-b-cq.yaml b/docs/odh-rhoai/kueue-preemption/team-b-cq.yaml similarity index 100% rename from docs/odh-rhoai/kueue-premption/team-b-cq.yaml rename to docs/odh-rhoai/kueue-preemption/team-b-cq.yaml diff --git a/docs/odh-rhoai/kueue-premption/team-b-local-queue.yaml b/docs/odh-rhoai/kueue-preemption/team-b-local-queue.yaml similarity index 100% rename from docs/odh-rhoai/kueue-premption/team-b-local-queue.yaml rename to docs/odh-rhoai/kueue-preemption/team-b-local-queue.yaml diff --git a/docs/odh-rhoai/kueue-premption/team-b-ns.yaml b/docs/odh-rhoai/kueue-preemption/team-b-ns.yaml similarity index 100% rename from docs/odh-rhoai/kueue-premption/team-b-ns.yaml rename to docs/odh-rhoai/kueue-preemption/team-b-ns.yaml diff --git a/docs/odh-rhoai/kueue-premption/team-b-ray-cluster-dev.yaml b/docs/odh-rhoai/kueue-preemption/team-b-ray-cluster-dev.yaml similarity index 100% rename from docs/odh-rhoai/kueue-premption/team-b-ray-cluster-dev.yaml rename to docs/odh-rhoai/kueue-preemption/team-b-ray-cluster-dev.yaml diff --git a/docs/odh-rhoai/kueue-premption/team-b-rb.yaml b/docs/odh-rhoai/kueue-preemption/team-b-rb.yaml similarity index 100% rename from docs/odh-rhoai/kueue-premption/team-b-rb.yaml rename to docs/odh-rhoai/kueue-preemption/team-b-rb.yaml diff --git a/docs/odh-rhoai/kueue-premption/workloadpriority.yml b/docs/odh-rhoai/kueue-preemption/workloadpriority.yml similarity index 100% rename from docs/odh-rhoai/kueue-premption/workloadpriority.yml rename to docs/odh-rhoai/kueue-preemption/workloadpriority.yml diff --git a/docs/whats-new/whats-new.md b/docs/whats-new/whats-new.md index 7e32cef2..500d9206 100644 --- a/docs/whats-new/whats-new.md +++ b/docs/whats-new/whats-new.md @@ -1,6 +1,6 @@ # What's new? -**2024-07-29**: Add [Kueue preemption](**/odh-rhoai/kueue-premption/readme.md) example. +**2024-07-29**: Add [Kueue preemption](../odh-rhoai/kueue-preemption/readme.md) example. **2024-07-16**: Add [ODH Tools and Extensions Companion](../odh-rhoai/odh-tools-and-extensions-companion.md) documentation. diff --git a/mkdocs.yml b/mkdocs.yml index f1565a84..a7935222 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -116,7 +116,7 @@ nav: - Single stack serving certificate: odh-rhoai/single-stack-serving-certificate.md - OpenShift Group Management: odh-rhoai/openshift-group-management.md - Accelerator Profiles: odh-rhoai/accelerator-profiles.md - - Kueue premption: odh-rhoai/kueue-premption/readme.md + - Kueue preemption: odh-rhoai/kueue-preemption/readme.md - Tools: - GPU pruner: odh-rhoai/gpu-pruner.md - ODH Tools and Extensions Companion: odh-rhoai/odh-tools-and-extensions-companion.md