Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[Docs][KubeRay] Update doc for kubectl-plugin #49890

Merged
merged 1 commit into from
Jan 24, 2025
Merged

[Docs][KubeRay] Update doc for kubectl-plugin #49890

merged 1 commit into from
Jan 24, 2025

Conversation

chiayi
Copy link
Contributor

@chiayi chiayi commented Jan 16, 2025

Why are these changes needed?

This PR updates the documentation for the ray kubectl-plugin that is part of the KubeRay v1.3 release

Related issue number

Checks

  • I've signed off every commit(by using the -s flag, i.e., git commit -s) in this PR.
  • I've run scripts/format.sh to lint the changes in this PR.
  • I've included any doc changes needed for https://docs.ray.io/en/master/.
    • I've added any new APIs to the API Reference. For example, if I added a
      method in Tune, I've added it in doc/source/tune/api/ under the
      corresponding .rst file.
  • I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/
  • Testing Strategy
    • Unit tests
    • Release tests
    • This PR is not tested :(

@chiayi
Copy link
Contributor Author

chiayi commented Jan 16, 2025

@andrewsykim @MortalHappiness PTAL

@chiayi chiayi mentioned this pull request Jan 16, 2025
Closed
14 tasks
andrewsykim
andrewsykim reviewed Jan 16, 2025
View reviewed changes
doc/source/cluster/kubernetes/user-guides/kubectl-plugin.md Outdated

### Submit A Ray Job

This is a wrapper around the `ray job submit` command. The plugin can automatically forward the ports to the Ray cluster and submit the job.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should add more details here that running kubectl ray job submit not only runs ray job submit, but also provisions the ephemeral cluster used to execute the job

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed, PTAL!

@MortalHappiness MortalHappiness self-assigned this Jan 16, 2025
@jcotant1 jcotant1 added docs An issue or change related to documentation kuberay Issues for the Ray/Kuberay integration that are tracked on the Ray side core Issues that should be addressed in Ray Core labels Jan 17, 2025
@chiayi chiayi force-pushed the master branch 3 times, most recently from f99d500 to e9c1f74 Compare January 17, 2025 23:46
@kevin85421 kevin85421 self-assigned this Jan 18, 2025
@kevin85421
Copy link
Member

I have already pinged our doc team to review this PR.

angelinalg
angelinalg approved these changes Jan 22, 2025
View reviewed changes
Copy link
Contributor

@angelinalg angelinalg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some style nits and a sentence that seems incomplete.

doc/source/cluster/kubernetes/user-guides/kubectl-plugin.md Outdated Show resolved Hide resolved
doc/source/cluster/kubernetes/user-guides/kubectl-plugin.md Outdated Show resolved Hide resolved
doc/source/cluster/kubernetes/user-guides/kubectl-plugin.md Outdated

### Create a Ray Cluster

This allows users to creates a valid RayCluster. The default values are follows:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think there's a problem here. Is there a command missing?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I updated the wording, PTAL

doc/source/cluster/kubernetes/user-guides/kubectl-plugin.md Outdated Show resolved Hide resolved
doc/source/cluster/kubernetes/user-guides/kubectl-plugin.md Outdated
print(ray.get(futures)) # [0, 1, 4, 9]
```

#### Submit Ray Job without yaml
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#### Submit Ray Job without yaml
#### Submit a Ray job without a YAML file

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this supposed to be a Ray job or a RayJob?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think Ray job is fine

doc/source/cluster/kubernetes/user-guides/kubectl-plugin.md Outdated Show resolved Hide resolved
doc/source/cluster/kubernetes/user-guides/kubectl-plugin.md Outdated Show resolved Hide resolved
doc/source/cluster/kubernetes/user-guides/kubectl-plugin.md Outdated Show resolved Hide resolved
doc/source/cluster/kubernetes/user-guides/kubectl-plugin.md Outdated Show resolved Hide resolved
doc/source/cluster/kubernetes/user-guides/kubectl-plugin.md Outdated Show resolved Hide resolved
@kevin85421 kevin85421 added the go add ONLY when ready to merge, run all tests label Jan 23, 2025
@jjyao jjyao merged commit 1043f83 into ray-project:master Jan 24, 2025
6 checks passed
erictang000 pushed a commit to erictang000/ray that referenced this pull request Jan 27, 2025
@chiayi @erictang000
[Docs][KubeRay] Update doc for kubectl-plugin (ray-project#49890)
d1d529b 
Signed-off-by: Aaron Liang <[email protected]>
Signed-off-by: Eric Tang <[email protected]>
srinathk10 pushed a commit that referenced this pull request Feb 2, 2025
@chiayi @srinathk10
[Docs][KubeRay] Update doc for kubectl-plugin (#49890)
bd7af89 
Signed-off-by: Aaron Liang <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MortalHappiness MortalHappiness MortalHappiness left review comments

@angelinalg angelinalg angelinalg approved these changes

@andrewsykim andrewsykim andrewsykim approved these changes

@maxpumperla maxpumperla Awaiting requested review from maxpumperla maxpumperla is a code owner

@pcmoritz pcmoritz Awaiting requested review from pcmoritz pcmoritz is a code owner

@kevin85421 kevin85421 Awaiting requested review from kevin85421 kevin85421 is a code owner

Assignees

@kevin85421 kevin85421

@MortalHappiness MortalHappiness

Labels
core Issues that should be addressed in Ray Core docs An issue or change related to documentation go add ONLY when ready to merge, run all tests kuberay Issues for the Ray/Kuberay integration that are tracked on the Ray side
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@chiayi @kevin85421 @andrewsykim @MortalHappiness @angelinalg @jjyao @jcotant1