Skip to content

docs: document autoscaler RBAC requirements - #5223

Open
cananoo wants to merge 1 commit into
ray-project:masterfrom
cananoo:docs/autoscaler-rbac-failure-mode
Open

docs: document autoscaler RBAC requirements#5223
cananoo wants to merge 1 commit into
ray-project:masterfrom
cananoo:docs/autoscaler-rbac-failure-mode

Conversation

@cananoo

@cananoo cananoo commented Sep 1, 2026

Copy link
Copy Markdown

Why are these changes needed?

Custom RBAC configurations can remove the list or watch permissions that the KubeRay operator needs when reconciling in-tree autoscaler resources. The resulting failure mode is difficult to diagnose because controller-runtime may wait for an informer instead of surfacing the authorization error.

This adds an autoscaler-specific RBAC section to the operator chart documentation. It documents the required resources and verbs, explains why list/watch must be retained, and provides a kubectl auth can-i check for restricted installations.

Related issue number

Related to #5186

Checks

  • I've made sure the documentation is consistent with the generated operator Role.
  • Testing Strategy
    • Manual tests
    • Unit tests
    • This PR is not tested :(

Manual test instructions

  • Compared the documented permissions with ray-operator/config/rbac/role.yaml and the Helm RBAC template.
  • Updated both README.md.gotmpl and the generated README.md.
  • git diff --check passes.

@win5923 win5923 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@cananoo

cananoo commented Sep 2, 2026

Copy link
Copy Markdown
Author

Thanks for pointing this out. I agree this guidance belongs in Ray's Kubernetes autoscaling guide rather than the KubeRay chart README. I'll prepare the documentation change against ray-project/ray and leave this KubeRay PR open until the replacement is ready, then close it to avoid duplicating the guidance.

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.

2 participants