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

[Doc][KubeRay] Improve KubeRay docs based on CUJ (part 2) #45304

Merged
merged 5 commits into from
May 14, 2024

Conversation

kevin85421
Copy link
Member

@kevin85421 kevin85421 commented May 13, 2024

Why are these changes needed?

  • I changed the KubeRay docs from v1.1.0 to v1.1.1 in [Doc][KubeRay v1.1.1] Use KubeRay v1.1.1 in KubeRay-related docs #45185. However, I didn't create a new branch for v1.1.1; instead, I used the existing release-1.1.0 branch and added a new tag for v1.1.1. The following command will report 404 when we download a YAML because release-1.1.1 branch doesn't exist.

    curl -LO https://raw.githubusercontent.com/ray-project/kuberay/release-1.1.1/ray-operator/config/samples/ray-cluster.autoscaler.yaml

    This PR updates release-1.1.1 to the tag v1.1.1.

    kubectl apply -f https://raw.githubusercontent.com/ray-project/kuberay/v1.1.1/ray-operator/config/samples/ray-cluster.autoscaler.yaml
  • Use the same K8s version for all kind create commands.

  • Remove "on any node of" from "Run the driver script directly on any node of the Ray cluster, for interactive development.". In most cases, users don't need to understand where to run the driver processes. In addition, the description may make users confusion with the above descriptions for Ray head node.

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

Signed-off-by: Kai-Hsun Chen <[email protected]>
@kevin85421 kevin85421 marked this pull request as draft May 13, 2024 21:54
@aslonnie
Copy link
Collaborator

(not sure why this is draft?)

@kevin85421
Copy link
Member Author

(not sure why this is draft?)

There is multiple feedback from CUJ. This is just part of the feedback.

Signed-off-by: Kai-Hsun Chen <[email protected]>
Signed-off-by: Kai-Hsun Chen <[email protected]>
Signed-off-by: Kai-Hsun Chen <[email protected]>
Signed-off-by: Kai-Hsun Chen <[email protected]>
@kevin85421 kevin85421 marked this pull request as ready for review May 13, 2024 23:42
@angelinalg angelinalg merged commit 2fa6663 into ray-project:master May 14, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants