Skip to content

Commit

Permalink
[YUNIKORN-2941] Remove the introduction of plugin mode from the insta…
Browse files Browse the repository at this point in the history
…ll section of Get Started
  • Loading branch information
Michael committed Oct 22, 2024
1 parent 0d1e9e3 commit caab671
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/get_started/get_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down
11 changes: 11 additions & 0 deletions versioned_docs/version-1.6.0/get_started/get_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down

0 comments on commit caab671

Please sign in to comment.