[YUNIKORN-2836] Simplify YuniKorn version selection in Getting Starte…

…d page Closes: #466 Signed-off-by: Craig Condit <[email protected]>
apache · Aug 28, 2024 · 4399ca2 · 4399ca2
1 parent 3082d30
commit 4399ca2
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 19 deletions.
diff --git a/docs/get_started/get_started.md b/docs/get_started/get_started.md
@@ -50,28 +50,12 @@ admission controller delegating all scheduling to YuniKorn. Because this mode is
 
 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 specific YuniKorn version, you can update helm chart via helm upgrade.
+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 upgrade -f custom.yml  -install yunikorn yunikorn/yunikorn -n yunikorn --create-namespace
+helm install yunikorn yunikorn/yunikorn --namespace yunikorn --version {version}
 ```
 
-The custom.yml is
-```yml
-image:
-  tag: scheduler-{version}    # default depends on YuniKorn version
-
-admissionController:
-  image:
-    tag: admission-{version}  # default depends on YuniKorn version
-
-web:
-  image:
-    tag: web-{version}        # default depends on YuniKorn version
-```
-
-You can check available `{version}` on [DockerHub](https://hub.docker.com/r/apache/yunikorn/tags).
-
-Further configuration options for installing YuniKorn via Helm are available in the [YuniKorn Helm hub page](https://hub.helm.sh/charts/yunikorn/yunikorn).
+You can check [YuniKorn Helm hub page](https://artifacthub.io/packages/helm/yunikorn/yunikorn) to see the available versions and further configuration options for YuniKorn Helm chart.
 
 If you don't want to use helm charts, you can find our step-by-step
 tutorial [here](developer_guide/deployment.md).

diff --git a/docs/user_guide/service_config.md b/docs/user_guide/service_config.md
@@ -66,6 +66,9 @@ admissionController:
     tag: admission-{version}        # default depends on YuniKorn version
     pullPolicy: Always
 ```
+
+You can check [Docker Hub](https://hub.docker.com/r/apache/yunikorn/tags) to see the available tag versions for YuniKorn images.
+
 ### Kubernetes configuration
 
 #### affinity