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] Doc for Helm chart RBAC #40360

Merged
merged 10 commits into from
Oct 31, 2023

Conversation

evalaiyc98
Copy link
Contributor

@evalaiyc98 evalaiyc98 commented Oct 16, 2023

Why are these changes needed?

I would like to enhance the user experience for installing Helm chart RBAC in KubeRay. Since there is'n an existing document for this, I integrate these PRs including KubeRay #1190, #1162, #1106, and create a comprehensive document to assist users in quickly and easily setting up RBAC resource.

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
    I have checked the output and made sure the document is working as expected.
    Note that, due to doc dependency conflict as this issue [doc][docs infra] update instructions for installing lint dependencies #39962 stated , I will check to ensure the changes align with Ray's style guide.

    • Unit tests
    • Release tests
    • This PR is not tested :(

Signed-off-by: evalaiyc98 <[email protected]>
@evalaiyc98
Copy link
Contributor Author

cc @kevin85421 Please take a look.
Thanks.

@kevin85421 kevin85421 self-assigned this Oct 20, 2023
evalaiyc98 and others added 7 commits October 23, 2023 11:13
Signed-off-by: evalaiyc98 <[email protected]>
Signed-off-by: Kai-Hsun Chen <[email protected]>
Signed-off-by: evalaiyc98 <[email protected]>
Signed-off-by: evalaiyc98 <[email protected]>
change ClusterRoleBinding/ RoleBinding to ClusterRole/ Role

Signed-off-by: evalaiyc98 <[email protected]>
@kevin85421 kevin85421 marked this pull request as ready for review October 26, 2023 20:10
Copy link
Member

@kevin85421 kevin85421 left a comment

Choose a reason for hiding this comment

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

LGTM. I have already discussed this document offline with @evalaiyc98 several times.

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 nits. Hope it helps. Let me know if you have any questions or if the suggestions don't make sense. Great job with the docs and the diagrams!

Co-authored-by: angelinalg <[email protected]>
Signed-off-by: Yu-Chen Lai <[email protected]>
@evalaiyc98
Copy link
Contributor Author

Thanks for @angelinalg. I have updated the file.

@architkulkarni
Copy link
Contributor

Windows Serve tests unrelated

@architkulkarni architkulkarni added the tests-ok The tagger certifies test failures are unrelated and assumes personal liability. label Oct 31, 2023
@architkulkarni architkulkarni merged commit 6b5e8bd into ray-project:master Oct 31, 2023
@evalaiyc98 evalaiyc98 deleted the doc-rbac branch October 31, 2023 15:17
kevin85421 added a commit to kevin85421/ray that referenced this pull request Nov 1, 2023
I would like to enhance the user experience for installing Helm chart RBAC in KubeRay. Since there is'n an existing document for this, I integrate these PRs including KubeRay ray-project#1190, ray-project#1162, ray-project#1106, and create a comprehensive document to assist users in quickly and easily setting up RBAC resource.

---------

Signed-off-by: evalaiyc98 <[email protected]>
Signed-off-by: Kai-Hsun Chen <[email protected]>
Signed-off-by: Kai-Hsun Chen <[email protected]>
Signed-off-by: Yu-Chen Lai <[email protected]>
Co-authored-by: Kai-Hsun Chen <[email protected]>
Co-authored-by: Kai-Hsun Chen <[email protected]>
Co-authored-by: Archit Kulkarni <[email protected]>
Co-authored-by: angelinalg <[email protected]>
vitsai pushed a commit that referenced this pull request Nov 2, 2023
I would like to enhance the user experience for installing Helm chart RBAC in KubeRay. Since there is'n an existing document for this, I integrate these PRs including KubeRay #1190, #1162, #1106, and create a comprehensive document to assist users in quickly and easily setting up RBAC resource.

---------

Signed-off-by: evalaiyc98 <[email protected]>
Signed-off-by: Kai-Hsun Chen <[email protected]>
Signed-off-by: Kai-Hsun Chen <[email protected]>
Signed-off-by: Yu-Chen Lai <[email protected]>
Co-authored-by: Yu-Chen Lai <[email protected]>
Co-authored-by: Archit Kulkarni <[email protected]>
Co-authored-by: angelinalg <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tests-ok The tagger certifies test failures are unrelated and assumes personal liability.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants