Skip to content

Commit

Permalink
[Doc] [KubeRay] Update v0.6.0 to v1.0.0-rc.0 (#39285)
Browse files Browse the repository at this point in the history
Analogous to #37833, this PR updates the default KubeRay version in the docs to 1.0.0-rc.0. We will release KubeRay 1.0.0-rc.0 before the Ray 2.7 docs go live.

---------

Signed-off-by: Archit Kulkarni <[email protected]>
  • Loading branch information
architkulkarni committed Sep 6, 2023
1 parent 3328c87 commit 573251b
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 16 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,10 @@ kubectl apply -f https://raw.githubusercontent.com/GoogleCloudPlatform/container
# (Method 2) "gcloud container clusters get-credentials <your-cluster-name> --region <your-region> --project <your-project>"
# (Method 3) "kubectl config use-context ..."

# Install both CRDs and KubeRay operator v0.6.0.
# Install both CRDs and KubeRay operator v1.0.0-rc.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
helm install kuberay-operator kuberay/kuberay-operator --version 1.0.0-rc.0

# Create a Ray cluster
kubectl apply -f https://raw.githubusercontent.com/ray-project/ray/master/doc/source/cluster/kubernetes/configs/ray-cluster.gpu.yaml
Expand Down Expand Up @@ -116,7 +116,7 @@ It is optional.
# 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
helm install kuberay-operator kuberay/kuberay-operator --version 1.0.0-rc.0

# Create a Ray cluster
kubectl apply -f https://raw.githubusercontent.com/ray-project/ray/master/doc/source/cluster/kubernetes/configs/ray-cluster.gpu.yaml
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ Deploy the KubeRay operator with the [Helm chart repository](https://github.com/
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
# Install both CRDs and KubeRay operator v1.0.0-rc.0.
helm install kuberay-operator kuberay/kuberay-operator --version 1.0.0-rc.0

# Confirm that the operator is running in the namespace `default`.
kubectl get pods
Expand All @@ -43,7 +43,7 @@ Once the KubeRay operator is running, we are ready to deploy a RayCluster. To do

```sh
# Deploy a sample RayCluster CR from the KubeRay Helm chart repo:
helm install raycluster kuberay/ray-cluster --version 0.6.0
helm install raycluster kuberay/ray-cluster --version 1.0.0-rc.0

# Once the RayCluster CR has been created, you can view it by running:
kubectl get rayclusters
Expand Down
12 changes: 6 additions & 6 deletions doc/source/cluster/kubernetes/k8s-ecosystem/ingress.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Ingress

Two examples show how to use ingress to access your Ray cluster:
Three examples show how to use ingress to access your Ray cluster:

* [AWS Application Load Balancer (ALB) Ingress support on AWS EKS](kuberay-aws-alb)
* [GKE Ingress support](kuberay-gke-ingress)
Expand All @@ -25,10 +25,10 @@ Two examples show how to use ingress to access your Ray cluster:
# 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
helm install kuberay-operator kuberay/kuberay-operator --version 1.0.0-rc.0

# Step 2: Install a RayCluster
helm install raycluster kuberay/ray-cluster --version 0.6.0
helm install raycluster kuberay/ray-cluster --version 1.0.0-rc.0

# Step 3: Edit the `ray-operator/config/samples/ray-cluster-alb-ingress.yaml`
#
Expand Down Expand Up @@ -113,10 +113,10 @@ Now run the following commands:
# 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
helm install kuberay-operator kuberay/kuberay-operator --version 1.0.0-rc.0

# Step 2: Install a RayCluster
helm install raycluster kuberay/ray-cluster --version 0.6.0
helm install raycluster kuberay/ray-cluster --version 1.0.0-rc.0

# Step 3: Edit ray-cluster-gclb-ingress.yaml to replace the service name with the name of the head service from the RayCluster. (Output of `kubectl get svc`)

Expand Down Expand Up @@ -176,7 +176,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
helm install kuberay-operator kuberay/kuberay-operator --version 1.0.0-rc.0

# Step 4: Install RayCluster and create an ingress separately.
# More information about change of setting was documented in https://github.com/ray-project/kuberay/pull/699
Expand Down
2 changes: 1 addition & 1 deletion doc/source/cluster/kubernetes/k8s-ecosystem/kubeflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ kustomize version --short
```sh
# Create a RayCluster CR, and the KubeRay operator will reconcile a Ray cluster
# with 1 head Pod and 1 worker Pod.
helm install raycluster kuberay/ray-cluster --version 0.6.0 --set image.tag=2.2.0-py38-cpu
helm install raycluster kuberay/ray-cluster --version 1.0.0-rc.0 --set image.tag=2.2.0-py38-cpu

# Check RayCluster
kubectl get pod -l ray.io/cluster=raycluster-kuberay
Expand Down
4 changes: 2 additions & 2 deletions doc/source/cluster/kubernetes/user-guides/rayserve-dev-doc.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Follow [this document](kuberay-operator-deploy) to install the latest stable Kub
# Step 2: Create a RayCluster CR

```sh
helm install raycluster kuberay/ray-cluster --version 0.6.0
helm install raycluster kuberay/ray-cluster --version 1.0.0-rc.0
```

# Step 3: Log in to the head Pod
Expand Down Expand Up @@ -50,7 +50,7 @@ the second `mobilenet` is the name of the Python file in the directory `mobilene
helm uninstall raycluster

# Install the RayCluster CR with the Ray image `rayproject/ray-ml:${RAY_VERSION}`
helm install raycluster kuberay/ray-cluster --version 0.6.0 --set image.repository=rayproject/ray-ml
helm install raycluster kuberay/ray-cluster --version 1.0.0-rc.0 --set image.repository=rayproject/ray-ml
```

The error message in Step 4 indicates that the Ray image `rayproject/ray:${RAY_VERSION}` does not have the TensorFlow package.
Expand Down
2 changes: 1 addition & 1 deletion doc/source/cluster/kubernetes/user-guides/tls.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ This [YouTube video](https://youtu.be/T4Df5_cojAs) is a good start.
your CA private key in a Kubernetes Secret in your production environment.

```sh
# Install v0.6.0 KubeRay operator
# Install v1.0.0-rc.0 KubeRay operator
# `ray-cluster.tls.yaml` will cover from Step 1 to Step 3

# Download `ray-cluster.tls.yaml`
Expand Down

0 comments on commit 573251b

Please sign in to comment.