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.

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

[Docs][KubeRay] Add doc for kubectl plugin #47851

Merged

Conversation

MortalHappiness
Copy link
Member

Why are these changes needed?

See the description in the corresponding issue for details.

Related issue number

Closes: #47849

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 :(

@MortalHappiness MortalHappiness force-pushed the docs/#47849-kubectl-plugin branch from c87ec4a to e802c4b Compare October 19, 2024 11:24
@MortalHappiness MortalHappiness force-pushed the docs/#47849-kubectl-plugin branch from e802c4b to 91a1ee2 Compare October 25, 2024 01:41
@andrewsykim
Copy link
Contributor

@angelinalg @kevin85421 can you help review please?

### Get all Ray clusters

```shell
$ kubectl ray cluster get
Copy link
Member

Choose a reason for hiding this comment

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

Maybe remove this section for now. If I remember correctly, we decided to change to kubectl ray get [cluster | job | service] to make the syntax closer to kubectl get [pods, service, ...]. We can add it back after we change the syntax.

Copy link
Member

Choose a reason for hiding this comment

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

@kevin85421
Copy link
Member

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

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.

Just some style nits. Thanks!

@MortalHappiness MortalHappiness force-pushed the docs/#47849-kubectl-plugin branch from 44e3293 to 9215864 Compare November 1, 2024 15:22
Closes: ray-project#47849
Signed-off-by: Chi-Sheng Liu <[email protected]>
@MortalHappiness MortalHappiness force-pushed the docs/#47849-kubectl-plugin branch from fe87f39 to e0da7ce Compare November 1, 2024 16:40
@kevin85421 kevin85421 added the go add ONLY when ready to merge, run all tests label Nov 1, 2024
@jjyao jjyao merged commit 3df5c1b into ray-project:master Nov 6, 2024
6 checks passed
JP-sDEV pushed a commit to JP-sDEV/ray that referenced this pull request Nov 14, 2024
mohitjain2504 pushed a commit to mohitjain2504/ray that referenced this pull request Nov 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
go add ONLY when ready to merge, run all tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[KubeRay] Add doc for kubectl plugin
6 participants