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
Merged
merged 7 commits into from
Jul 1, 2025
Merged

Improve rack-awareness documentation for Kubernetes #1753

merged 7 commits into from
Jul 1, 2025
+6 −5

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!
mich-elle-luna and others added 5 commits June 25, 2025 16:34
@mich-elle-luna @kaitlynmichael
Update content/operate/kubernetes/recommendations/node-selection.md
5f32e7a 
Co-authored-by: Kaitlyn Michael <76962844+kaitlynmichael@users.noreply.github.com>
@mich-elle-luna @kaitlynmichael
Update content/operate/kubernetes/recommendations/node-selection.md
078f889 
Co-authored-by: Kaitlyn Michael <76962844+kaitlynmichael@users.noreply.github.com>
@mich-elle-luna @kaitlynmichael
Update content/operate/kubernetes/recommendations/node-selection.md
4c60c23 
Co-authored-by: Kaitlyn Michael <76962844+kaitlynmichael@users.noreply.github.com>
@mich-elle-luna @kaitlynmichael
Update content/operate/kubernetes/recommendations/node-selection.md
a2852d0 
Co-authored-by: Kaitlyn Michael <76962844+kaitlynmichael@users.noreply.github.com>
@mich-elle-luna @kaitlynmichael
Update content/operate/kubernetes/recommendations/node-selection.md
d8f5200 
Co-authored-by: Kaitlyn Michael <76962844+kaitlynmichael@users.noreply.github.com>
@mich-elle-luna mich-elle-luna merged commit d16adb1 into main Jul 1, 2025
5 checks passed
@mich-elle-luna mich-elle-luna deleted the DOC-1815 branch July 1, 2025 20:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
k8s
2 participants
@mich-elle-luna @kaitlynmichael