[Docs][History Server] Update docs - #65580
Conversation
Signed-off-by: machichima <nary12321@gmail.com>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request adds comprehensive documentation for the KubeRay History Server configuration, detailing its environment variables and CLI flags, and updates the event exporter documentation to clarify that setting the exposable event types to ALL requires Ray 2.54.0 or later. The review feedback suggests minor improvements to the newly added documentation, such as removing an unnecessary comma, clarifying the memory eviction trigger, and rephrasing a description to maintain grammatical consistency.
machichima
changed the title
Signed-off-by: machichima <nary12321@gmail.com>
| - | ||
| - Yes (all nodes) | ||
| - Object storage bucket or account name. For other cloud providers, use `S3_BUCKET` or `AZURE_STORAGE_ACCOUNT`. | ||
| - Object storage bucket or container name. For other cloud providers, use `S3_BUCKET` or `AZURE_STORAGE_CONTAINER`. |
There was a problem hiding this comment.
Updated as there's no AZURE_STORAGE_ACCOUNT env var
|
|
||
| - **RAY_DASHBOARD_AGGREGATOR_AGENT_EVENTS_EXPORT_ADDR**: HTTP endpoint URL (e.g., `http://localhost:8080/events`) | ||
| - **RAY_DASHBOARD_AGGREGATOR_AGENT_EXPOSABLE_EVENT_TYPES**: Comma-separated list of event types to expose | ||
| - **RAY_DASHBOARD_AGGREGATOR_AGENT_EXPOSABLE_EVENT_TYPES**: Comma-separated list of event types to expose. Set it to ``ALL`` to expose every event type, supported in Ray 2.54.0 and later. |
There was a problem hiding this comment.
Also update here as we are updating RAY_DASHBOARD_AGGREGATOR_AGENT_EXPOSABLE_EVENT_TYPES content in doc/source/cluster/kubernetes/user-guides/kuberay-history-server.md to make it consistent
ray-gardener
Bot
added
docs
Co-authored-by: Jun-Hao Wan <ken0979172817@gmail.com> Signed-off-by: Nary Yeh <60069744+machichima@users.noreply.github.com> Signed-off-by: machichima <nary12321@gmail.com>
cd758c0 to
72ff9c8
Compare
chiayi
left a comment
chiayi
left a comment
There was a problem hiding this comment.
Just one small thing from me. Else LGTM!
| - `--runtime-class-name` | ||
| - `--storage-backend` | ||
| - Yes (all nodes) | ||
| - Storage backend type (`gcs`, `s3`, `azureblob`, `aliyunoss`). The `--runtime-class-name` flag is specific to the collector storage backend. |
There was a problem hiding this comment.
--runtime-class-name is still in the description here.
There was a problem hiding this comment.
updated! Thank you!
Signed-off-by: machichima <nary12321@gmail.com>
dstrodtman
left a comment
dstrodtman
left a comment
There was a problem hiding this comment.
Docs review (style, grammar, conventions) — Anyscale docs team
Reviewed by Douglas Strodtman (Anyscale docs team) with Claude Code assisting; I've read and stand behind everything here. Scope is prose and docs conventions only — technical accuracy stays with the KubeRay and Ray Core maintainers, who've already approved.
The new History Server configuration section is clean and well-structured. The variable table is consistent, it follows the Kubernetes object-name conventions (UpperCamelCase, no backticks in prose), and the sizing note lands the soft-cap-versus-Pod-limit distinction well. The earlier review threads all look applied at HEAD, so nothing here reopens them.
Two optional grammar nits on changed lines, both click-to-apply. Neither is blocking.
Otherwise this reads well from the docs side.
| * - | ||
| - `--use-auth-token-mode` | ||
| - `false` | ||
| - Enable Ray dashboard token authentication mode for proxying to live RayClusters that have auth enabled. When enabled, the History Server reads each cluster's auth token from its Kubernetes Secret and injects it as an `x-ray-authorization` header on proxied requests, stripping any client-supplied value. This requires extra RBAC to read those Secrets, see [`service_account_auth_token_mode.yaml`](https://github.com/ray-project/kuberay/blob/master/historyserver/config/service_account_auth_token_mode.yaml). Kubernetes-delegated token auth (`enableK8sTokenAuth`) isn't supported. |
There was a problem hiding this comment.
Small nit: ..., see [...] joins two independent clauses. Ray's style guide favors splitting over a comma join and capitalizes See at the start of a reference.
| - Enable Ray dashboard token authentication mode for proxying to live RayClusters that have auth enabled. When enabled, the History Server reads each cluster's auth token from its Kubernetes Secret and injects it as an `x-ray-authorization` header on proxied requests, stripping any client-supplied value. This requires extra RBAC to read those Secrets, see [`service_account_auth_token_mode.yaml`](https://github.com/ray-project/kuberay/blob/master/historyserver/config/service_account_auth_token_mode.yaml). Kubernetes-delegated token auth (`enableK8sTokenAuth`) isn't supported. | |
| - Enable Ray dashboard token authentication mode for proxying to live RayClusters that have auth enabled. When enabled, the History Server reads each cluster's auth token from its Kubernetes Secret and injects it as an `x-ray-authorization` header on proxied requests, stripping any client-supplied value. This requires extra RBAC to read those Secrets. See [`service_account_auth_token_mode.yaml`](https://github.com/ray-project/kuberay/blob/master/historyserver/config/service_account_auth_token_mode.yaml). Kubernetes-delegated token auth (`enableK8sTokenAuth`) isn't supported. |
|
|
||
| - **RAY_DASHBOARD_AGGREGATOR_AGENT_EVENTS_EXPORT_ADDR**: HTTP endpoint URL (e.g., `http://localhost:8080/events`) | ||
| - **RAY_DASHBOARD_AGGREGATOR_AGENT_EXPOSABLE_EVENT_TYPES**: Comma-separated list of event types to expose | ||
| - **RAY_DASHBOARD_AGGREGATOR_AGENT_EXPOSABLE_EVENT_TYPES**: Comma-separated list of event types to expose. Set it to ``ALL`` to expose every event type, supported in Ray 2.54.0 and later. |
There was a problem hiding this comment.
Small nit: the trailing supported in Ray 2.54.0 and later reads as modifying "event type" rather than the ALL value. Splitting it into its own sentence keeps the version note attached to ALL.
| - **RAY_DASHBOARD_AGGREGATOR_AGENT_EXPOSABLE_EVENT_TYPES**: Comma-separated list of event types to expose. Set it to ``ALL`` to expose every event type, supported in Ray 2.54.0 and later. | |
| - **RAY_DASHBOARD_AGGREGATOR_AGENT_EXPOSABLE_EVENT_TYPES**: Comma-separated list of event types to expose. Set it to ``ALL`` to expose every event type. ``ALL`` is supported in Ray 2.54.0 and later. |
5 participants
Description
Follow up on:
Made following changes:
Related issues
Additional information
docs: https://anyscale-ray--65580.com.readthedocs.build/en/65580/cluster/kubernetes/user-guides/kuberay-history-server.html