Skip to content

Improve rack-awareness documentation for Kubernetes #1753

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Improve rack-awareness documentation for Kubernetes #1753

wants to merge 6 commits into from

Conversation

mich-elle-luna
Copy link
Collaborator

  • Add clear explanation of node labeling requirements for rack-awareness
  • Emphasize that ALL eligible nodes must be labeled with chosen label
  • Explain what eligible nodes are (nodes where RS pods can be scheduled)
  • Suggest topology.kubernetes.io/zone as commonly available label
  • Clarify that not all platforms have this label by default
  • Update example to use current topology.kubernetes.io/zone instead of deprecated failure-domain.beta.kubernetes.io/zone
  • Fix kubectl command formatting (add space after $)
  • Add warning about operator failing if nodes are missing labels

Addresses DOC-1815

@mich-elle-luna
Improve rack-awareness documentation for Kubernetes
212c490 
- Add clear explanation of node labeling requirements for rack-awareness
- Emphasize that ALL eligible nodes must be labeled with chosen label
- Explain what eligible nodes are (nodes where RS pods can be scheduled)
- Suggest topology.kubernetes.io/zone as commonly available label
- Clarify that not all platforms have this label by default
- Update example to use current topology.kubernetes.io/zone instead of deprecated failure-domain.beta.kubernetes.io/zone
- Fix kubectl command formatting (add space after $)
- Add warning about operator failing if nodes are missing labels

Addresses DOC-1815
@github-actions GitHub Actions
Copy link
Contributor

Staging links:
https://redis.io/docs/staging/DOC-1815/operate/kubernetes/recommendations/node-selection

kaitlynmichael
kaitlynmichael requested changes Jun 25, 2025
View reviewed changes
Copy link
Contributor

@kaitlynmichael kaitlynmichael left a comment

Choose a reason for hiding this comment

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

I suggested some wording changes to simplify and make sure it's in active voice. Thanks for tackling this!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kaitlynmichael kaitlynmichael Awaiting requested review from kaitlynmichael

Requested changes must be addressed to merge this pull request.

Assignees

@mich-elle-luna mich-elle-luna

Labels
k8s
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@mich-elle-luna @kaitlynmichael