Skip to content

[Docs][KubeRay] Use RayJob sample YAML for History Server docs - #65505

Open
win5923 wants to merge 4 commits into
ray-project:masterfrom
win5923:update-historyserver
Open

[Docs][KubeRay] Use RayJob sample YAML for History Server docs#65505
win5923 wants to merge 4 commits into
ray-project:masterfrom
win5923:update-historyserver

Conversation

@win5923

@win5923 win5923 commented Aug 16, 2026

Copy link
Copy Markdown
Member

Description

Update the Ray History Server with KubeRay doc to use RayJob example, this is related to ray-project/kuberay#5150

Related issues

Link related issues: "Fixes #1234", "Closes #1234", or "Related to #1234".

Additional information

Optional: Add implementation details, API changes, usage examples, screenshots, etc.

@win5923
win5923 requested review from a team and andrewsykim as code owners August 16, 2026 02:35

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request updates the KubeRay History Server user guide to deploy an example RayJob instead of a RayCluster with the collector sidecar, updating the manifests, environment variables, verification steps, and storage layouts accordingly. The review feedback points out an inaccuracy regarding the explanation of shutdownAfterJobFinishes and ttlSecondsAfterFinished and suggests a correction to accurately describe when the underlying RayCluster and the RayJob resource are deleted.

Comment thread doc/source/cluster/kubernetes/user-guides/kuberay-history-server.md Outdated
@win5923
win5923 force-pushed the update-historyserver branch from b1175b4 to b58bf1d Compare August 16, 2026 02:38
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Signed-off-by: Jun-Hao Wan <ken0979172817@gmail.com>
@win5923 win5923 added the go add ONLY when ready to merge, run all tests label Aug 16, 2026
Comment thread doc/source/cluster/kubernetes/user-guides/kuberay-history-server.md Outdated
@machichima

Copy link
Copy Markdown
Contributor

Please add DCO

…er.md

Co-authored-by: Nary Yeh <60069744+machichima@users.noreply.github.com>
Signed-off-by: Jun-Hao Wan <ken0979172817@gmail.com>
Comment thread doc/source/cluster/kubernetes/user-guides/kuberay-history-server.md Outdated
Check the RayJob status. The entrypoint script takes about a minute to finish:

```sh
kubectl get rayjob ${RAY_JOB}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I don't think we have this env var (RAY_JOB)?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

It's exported in line 127

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Oh sorry I missed it

@machichima machichima left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Overall LGTM, just above two comments. Thank you!

Co-authored-by: Nary Yeh <60069744+machichima@users.noreply.github.com>
Signed-off-by: Jun-Hao Wan <ken0979172817@gmail.com>
@ray-gardener ray-gardener Bot added docs An issue or change related to documentation core Issues that should be addressed in Ray Core community-contribution Contributed by the community labels Aug 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

community-contribution Contributed by the community 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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Ray fails to serialize self-reference objects

2 participants