[Doc] [KubeRay] Add "helm repo update" to installation instructions (#…

…39070) In my experience helm repo update is necessary to make the installation instructions idempotent. If you've already run helm repo add in the past (say a few months ago) and then follow these instructions, it might not work because the repo might not have been updated to get the latest kuberay version. From my memory the error message wasn't that clear. Adding helm repo update prevents the error. --------- Signed-off-by: Archit Kulkarni <[email protected]>
ray-project · Sep 6, 2023 · d856d3f · d856d3f
1 parent 056ad5d
commit d856d3f
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 0 deletions.
diff --git a/doc/source/cluster/kubernetes/examples/gpu-training-example.md b/doc/source/cluster/kubernetes/examples/gpu-training-example.md
@@ -42,6 +42,7 @@ kubectl apply -f https://raw.githubusercontent.com/GoogleCloudPlatform/container
 
 # Install both CRDs and KubeRay operator v0.6.0.
 helm repo add kuberay https://ray-project.github.io/kuberay-helm/
+helm repo update
 helm install kuberay-operator kuberay/kuberay-operator --version 0.6.0
 
 # Create a Ray cluster
@@ -114,6 +115,7 @@ It is optional.
 # Step 2: Deploy a Ray cluster on Kubernetes with the KubeRay operator.
 # Create the KubeRay operator
 helm repo add kuberay https://ray-project.github.io/kuberay-helm/
+helm repo update
 helm install kuberay-operator kuberay/kuberay-operator --version 0.6.0
 
 # Create a Ray cluster

diff --git a/doc/source/cluster/kubernetes/getting-started/raycluster-quick-start.md b/doc/source/cluster/kubernetes/getting-started/raycluster-quick-start.md
@@ -24,6 +24,7 @@ Deploy the KubeRay operator with the [Helm chart repository](https://github.com/
 
 ```sh
 helm repo add kuberay https://ray-project.github.io/kuberay-helm/
+helm repo update
 
 # Install both CRDs and KubeRay operator v0.6.0.
 helm install kuberay-operator kuberay/kuberay-operator --version 0.6.0

diff --git a/doc/source/cluster/kubernetes/k8s-ecosystem/ingress.md b/doc/source/cluster/kubernetes/k8s-ecosystem/ingress.md
@@ -24,6 +24,7 @@ Two examples show how to use ingress to access your Ray cluster:
 ```sh
 # Step 1: Install KubeRay operator and CRD
 helm repo add kuberay https://ray-project.github.io/kuberay-helm/
+helm repo update
 helm install kuberay-operator kuberay/kuberay-operator --version 0.6.0
 
 # Step 2: Install a RayCluster
@@ -111,6 +112,7 @@ Now run the following commands:
 ```bash
 # Step 1: Install KubeRay operator and CRD
 helm repo add kuberay https://ray-project.github.io/kuberay-helm/
+helm repo update
 helm install kuberay-operator kuberay/kuberay-operator --version 0.6.0
 
 # Step 2: Install a RayCluster
@@ -173,6 +175,7 @@ kubectl wait --namespace ingress-nginx \
 
 # Step 3: Install KubeRay operator and CRD
 helm repo add kuberay https://ray-project.github.io/kuberay-helm/
+helm repo update
 helm install kuberay-operator kuberay/kuberay-operator --version 0.6.0
 
 # Step 4: Install RayCluster and create an ingress separately.