Ensure that users do not enable auto-upgrades in K8s guides #1185
Conversation
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the 📝 WalkthroughWalkthroughThe documentation for deploying Redpanda on self-hosted Kubernetes clusters in AKS, EKS, and GKE was updated to provide clearer guidance on disabling automatic node upgrades. The prerequisites and cluster creation instructions were revised for clarity and directness. Explicit warnings were added against enabling auto-upgrade features in managed Kubernetes services, with references to Redpanda requirements documentation. The requirements section was restructured and reworded to emphasize the need to prevent automatic node upgrades, listing common issues and providing clear requirements and instructions for disabling such features. Sequence Diagram(s)sequenceDiagram
participant User
participant Documentation
participant CloudProvider
User->>Documentation: Reads Kubernetes deployment guide
Documentation->>User: Presents prerequisites and cluster creation steps
Documentation->>User: Warns against enabling auto node upgrades
User->>CloudProvider: Creates K8s cluster (auto-upgrade disabled)
CloudProvider-->>User: Provides unmanaged K8s nodes
User->>Documentation: References requirements for node maintenance
Assessment against linked issues
Suggested reviewers
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
modules/deploy/partials/requirements.adoc (1)
69-74: Minor formatting nit – nested bullets look mis-alignedIndent the nested provider bullets one level deeper to render them as sub-bullets:
-To prevent managed Kubernetes services from automatically rebooting or upgrading nodes: -** **Azure AKS**: Set the OS upgrade channel to `None`. ... -** **Google GKE**: Disable GKE auto-upgrades for node pools. ... -** **Amazon EKS**: Avoid enabling EKS node auto-upgrades. ... +To prevent managed Kubernetes services from automatically rebooting or upgrading nodes: +** Azure AKS**: Set the OS upgrade channel to `None`. ... +** Google GKE**: Disable GKE auto-upgrades for node pools. ... +** Amazon EKS**: Avoid enabling EKS node auto-upgrades. ...
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
modules/deploy/pages/deployment-option/self-hosted/kubernetes/aks-guide.adoc(2 hunks)modules/deploy/pages/deployment-option/self-hosted/kubernetes/eks-guide.adoc(2 hunks)modules/deploy/pages/deployment-option/self-hosted/kubernetes/gke-guide.adoc(2 hunks)modules/deploy/partials/requirements.adoc(1 hunks)
🔇 Additional comments (1)
modules/deploy/pages/deployment-option/self-hosted/kubernetes/eks-guide.adoc (1)
267-274: Auto-Mode Flag and Documentation Link Are CorrectWe’ve verified that:
- The
--enable-auto-modeflag is supported in recenteksctl create clusterreleases.- The AWS doc URL (
https://docs.aws.amazon.com/eks/latest/userguide/automode.html) returns HTTP 200.No changes are needed for this section.
modules/deploy/pages/deployment-option/self-hosted/kubernetes/gke-guide.adoc
Show resolved
Hide resolved
modules/deploy/pages/deployment-option/self-hosted/kubernetes/aks-guide.adoc
Show resolved
Hide resolved
…gke-guide.adoc Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
…aks-guide.adoc Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
|
Thank you! |
| - Parallel upgrades across multiple nodes, which can disrupt quorum or reduce cluster availability. | ||
|
|
||
| *Recommendations*: | ||
| *Requirements*: |
There was a problem hiding this comment.
Not important, but I think the 3 links below look a little odd with just "Azure documentation." Suggest: "See the Azure documentation." for each link
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Description
Resolves https://redpandadata.atlassian.net/browse/DOC-1474
Review deadline: July 1
This pull request updates the deployment guides for Redpanda on AKS, EKS, and GKE to emphasize the importance of manual control over node lifecycle events and improve clarity in prerequisites. It also revises the general documentation on node maintenance to align with these updates.
Deployment Guide Updates
AKS Deployment Guide (
aks-guide.adoc):kubectland Helm.Noneto prevent automatic node reboots or upgrades.EKS Deployment Guide (
eks-guide.adoc):GKE Deployment Guide (
gke-guide.adoc):kubectland Helm are installed.Node Maintenance Documentation
requirements.adoc):Page previews
Checks