From caab671d686c2b00c5ccbc8c663536683dbda386 Mon Sep 17 00:00:00 2001 From: Michael Date: Tue, 22 Oct 2024 13:25:48 +0800 Subject: [PATCH] [YUNIKORN-2941] Remove the introduction of plugin mode from the install section of Get Started --- docs/get_started/get_started.md | 11 +++++++++++ .../version-1.6.0/get_started/get_started.md | 11 +++++++++++ 2 files changed, 22 insertions(+) diff --git a/docs/get_started/get_started.md b/docs/get_started/get_started.md index 4fea77da33..118e547b83 100644 --- a/docs/get_started/get_started.md +++ b/docs/get_started/get_started.md @@ -43,6 +43,17 @@ By default, the helm chart will install the scheduler, web-server and the admiss When `admission-controller` is installed, it simply routes all traffic to YuniKorn. That means the resource scheduling is delegated to YuniKorn. You can disable it by setting `embedAdmissionController` flag to `false` during the helm install. +The YuniKorn scheduler can also be deployed as a Kubernetes scheduler plugin by setting the Helm `enableSchedulerPlugin` +flag to `true`. This will deploy an alternate Docker image which contains YuniKorn compiled together with the default +scheduler. This new mode offers better compatibility with the default Kubernetes scheduler and is suitable for use with the +admission controller delegating all scheduling to YuniKorn. Because this mode is still very new, it is not enabled by default. + +***NOTE:*** **Plugin mode is now deprecated and will be removed in a future release. +It is strongly recommended to use the standard mode instead. +Refer to [plugin mode](user_guide/deployment_modes#plugin-mode) for more details.** + +If you are unsure which deployment mode you should use, refer to our [side-by-side comparison](user_guide/deployment_modes). + If you want to use a specific version of YuniKorn, you can add the `--version` flag to the `helm install` command as follows: ```shell script helm install yunikorn yunikorn/yunikorn --namespace yunikorn --version {version} diff --git a/versioned_docs/version-1.6.0/get_started/get_started.md b/versioned_docs/version-1.6.0/get_started/get_started.md index 6d5c1e2123..e8124e2df6 100644 --- a/versioned_docs/version-1.6.0/get_started/get_started.md +++ b/versioned_docs/version-1.6.0/get_started/get_started.md @@ -43,6 +43,17 @@ By default, the helm chart will install the scheduler, web-server and the admiss When `admission-controller` is installed, it simply routes all traffic to YuniKorn. That means the resource scheduling is delegated to YuniKorn. You can disable it by setting `embedAdmissionController` flag to `false` during the helm install. +The YuniKorn scheduler can also be deployed as a Kubernetes scheduler plugin by setting the Helm `enableSchedulerPlugin` +flag to `true`. This will deploy an alternate Docker image which contains YuniKorn compiled together with the default +scheduler. This new mode offers better compatibility with the default Kubernetes scheduler and is suitable for use with the +admission controller delegating all scheduling to YuniKorn. Because this mode is still very new, it is not enabled by default. + +***NOTE:*** **Plugin mode is now deprecated and will be removed in a future release. +It is strongly recommended to use the standard mode instead. +Refer to [plugin mode](user_guide/deployment_modes#plugin-mode) for more details.** + +If you are unsure which deployment mode you should use, refer to our [side-by-side comparison](user_guide/deployment_modes). + If you want to use a specific version of YuniKorn, you can add the `--version` flag to the `helm install` command as follows: ```shell script helm install yunikorn yunikorn/yunikorn --namespace yunikorn --version {version}