-
Notifications
You must be signed in to change notification settings - Fork 8k
[cherry-pick][2.58.0][docs] Backport KubeRay v1.7 feature docs #65730
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
dstrodtman
wants to merge
7
commits into
releases/2.58.0
Choose a base branch
from
kuberay-v1-7-doc-backport
base: releases/2.58.0
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+588
−18
Open
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
dbe2c83
[Doc] KubeRay SidecarSubmitterRestart User Guide (#64303)
justinyeh1995 17b904f
[Docs] Support rollback in zero-downtime incremental upgrade (#65249)
win5923 88b52c0
[doc][KubeRay] Add NetworkPolicy user guide + kuberay namespace note …
chipspeak 02567e3
[doc] Pin the RocksDB GCS example to the release that introduced it (…
dstrodtman 174e0b4
[Doc] Fix docs for KubeRay v1.7 (#65513)
machichima 3039837
[doc][KubeRay] document ingressOptions for the built-in Ingress (#65483)
wuallen57730 28aa2c3
Re-run CI without docs-go label
dstrodtman File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -14,26 +14,29 @@ kind create cluster --image=kindest/node:v1.26.0 | |||||||||
|
|
||||||||||
| ### Method 1: Helm (Recommended) | ||||||||||
|
|
||||||||||
| Install the operator into a dedicated `ray-system` namespace rather than `default` to isolate the operator's service account from workload pods. | ||||||||||
|
|
||||||||||
| ```sh | ||||||||||
| helm repo add kuberay https://ray-project.github.io/kuberay-helm/ | ||||||||||
| helm repo update | ||||||||||
| # Install both CRDs and KubeRay operator v1.6.0. | ||||||||||
| helm install kuberay-operator kuberay/kuberay-operator --version 1.6.0 | ||||||||||
| kubectl create namespace ray-system | ||||||||||
| helm install kuberay-operator kuberay/kuberay-operator --version 1.6.0 -n ray-system | ||||||||||
| ``` | ||||||||||
|
|
||||||||||
| ### Method 2: Kustomize | ||||||||||
|
|
||||||||||
| ```sh | ||||||||||
| # Install CRD and KubeRay operator. | ||||||||||
| kubectl create -k "github.com/ray-project/kuberay/ray-operator/config/default?ref=v1.6.0" | ||||||||||
| # Install CRD and KubeRay operator into the ray-system namespace. | ||||||||||
| kubectl create namespace ray-system | ||||||||||
| kubectl create -k "github.com/ray-project/kuberay/ray-operator/config/default?ref=v1.6.0" -n ray-system | ||||||||||
|
Comment on lines
+30
to
+31
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Update the Kustomize ref to
Suggested change
|
||||||||||
| ``` | ||||||||||
|
|
||||||||||
| ## Step 3: Validate Installation | ||||||||||
|
|
||||||||||
| Confirm that the operator is running in the namespace `default`. | ||||||||||
| Confirm that the operator is running. If you installed into `ray-system`, pass `-n ray-system`: | ||||||||||
|
|
||||||||||
| ```sh | ||||||||||
| kubectl get pods | ||||||||||
| kubectl get pods -n ray-system | ||||||||||
| ``` | ||||||||||
|
|
||||||||||
| ```text | ||||||||||
|
|
||||||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since this PR backports KubeRay v1.7 features (such as
ingressOptions,NetworkPolicy, andSidecarSubmitterRestart), the operator installation guide should be updated to install KubeRayv1.7.0instead ofv1.6.0. Otherwise, users following this guide will not be able to use the newly documented features.