docs: remove NodePool CRD documentation (internal/BYOC only)#1799
docs: remove NodePool CRD documentation (internal/BYOC only)#1799JakeSCahill wants to merge 2 commits into
Conversation
Per engineering, the NodePool CRD is used internally for Redpanda Cloud (BYOC) deployments and should not be documented for self-managed users, even though it remains actively maintained. Removes the Node Pools page and the NodePool blue/green migration guide, their nav entries, the v26.1.x release-notes section, and all inbound cross-references. The manual node-pool migration guide (k-migrate-node-pools-manually) stays. Adds removals-without-aliases entries for the deleted URLs.
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Users who bookmarked or linked the NodePool pages land on Scale Redpanda (the closest surviving topic) rather than a 404.
Comms for any self-managed adopters of the beta NodePool CRD: the CRD keeps working and stays maintained, the docs are removed because it is internal to Redpanda Cloud (BYOC); adopters should contact their account team. Pairs with the removal in #1799.
|
On hold per the K8S-907 discussion (David/Pawel/Andrew, July 22): in 26.2 the RedpandaBrokerPool CRD is installed only in multicluster mode and its controller reconciles only StretchCluster pools, so NodePool (beta) remains the only broker-pool mechanism for standalone self-managed clusters. RedpandaBrokerPool support for standalone clusters is targeted at a patch release (for example 26.2.2), and at least one self-managed customer is actively using NodePool. Removing the self-managed NodePool docs now would leave standalone deployments with no documented pool mechanism. Revisit when RedpandaBrokerPool ships for standalone clusters; this PR then likely becomes 'replace NodePool docs with RedpandaBrokerPool docs' rather than a plain removal. Note: docs#1820 already replaces the 'NodePool CRD documentation removed' release-note section with an accurate scoping note, so this PR's release-notes change would conflict with it. |
1 participant
Per @david-yu on #1681: the NodePool CRD is used internally for Redpanda Cloud (BYOC) deployments and shouldn't be documented for self-managed users, although it remains actively maintained.
Changes
manage:kubernetes/k-node-pools.adocandupgrade:k-migrate-node-pools.adoc(the NodePool-CRD blue/green migration guide) and their nav entriesk-scale-redpanda(TIP + suggested reading),k-decommission-brokers(suggested reading), and the CRD pointer ink-migrate-node-pools-manuallyremovals-without-aliasesentries for the two deleted URLsk-migrate-node-pools-manually.adoc— that page covers manual migration between Kubernetes node pools, not the CRDNotes
beta(26.2) only. The same pages exist onmain(26.1, published) — if they should be removed there too, say the word and I'll open the counterpart PR.crds.experimental+--enable-v2-nodepools, consistent with internal-only status.🤖 Generated with Claude Code