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][kubernetes] Update the document for metadata.name and metadata.generateName for Pods #28744

Merged

Conversation

kevin85421
Copy link
Member

@kevin85421 kevin85421 commented Sep 23, 2022

Why are these changes needed?

This ray-project/kuberay#587 sets ObjectMeta.Name to an empty string, and use GenerateName to prevent name conflicts. Hence, this document needs to be updated.

Related issue number

Closes #28723

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 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 force-pushed the update-k8s-pod-template-doc branch from dee26f4 to d9e03c5 Compare September 23, 2022 20:18
@kevin85421 kevin85421 marked this pull request as ready for review September 23, 2022 20:20
@kevin85421
Copy link
Member Author

cc @DmitriGekhtman

Copy link
Contributor

@DmitriGekhtman DmitriGekhtman left a comment

Choose a reason for hiding this comment

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

Thanks for the update!

@DmitriGekhtman DmitriGekhtman merged commit 4027a02 into ray-project:master Sep 27, 2022
WeichenXu123 pushed a commit to WeichenXu123/ray that referenced this pull request Dec 19, 2022
…ods (ray-project#28744)

Update RayCluster config docs to mention that metadata.name and metadata.generateName should not be used.

Signed-off-by: Kai-Hsun Chen <[email protected]>
Signed-off-by: Weichen Xu <[email protected]>
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.

[docs][kubernetes] Update the document for metadata.name and metadata.generateName for Pods
2 participants