k8s: Add 25.2 beta docs for the Redpanda Operator #1307
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 📝 WalkthroughWalkthroughAdds a new Kubernetes deployment guide for Redpanda Operator v25.2.1-beta1 and updates Operator release notes. The deployment doc covers prerequisites (cert-manager with CRDs), Helm-based installation with placeholders for namespace and operator beta tag, verification steps, applying a Redpanda CR (including enterprise license secret variant), readiness checks, monitoring, troubleshooting link, uninstall command, and next steps. The release notes add a v25.2.x (beta) section with a changelog link and document the Operator’s default scope change to cluster scope, including implications for RBAC and cross-namespace management. Sequence Diagram(s)sequenceDiagram
participant User
participant Helm
participant Kubernetes
participant Operator
participant CRDs
participant RedpandaCluster
User->>Kubernetes: Install cert-manager (CRDs enabled)
User->>Helm: Install Redpanda Operator (v25.2.x beta)
Helm->>Kubernetes: Create operator resources (cluster-scoped)
Kubernetes-->>User: Rollout status
User->>Kubernetes: Apply Redpanda CR (redpanda-cluster.yaml)
Kubernetes->>Operator: Reconcile CR
Operator->>CRDs: Manage Redpanda resources
Operator->>RedpandaCluster: Create/Update StatefulSet, Services, etc.
RedpandaCluster-->>User: Pods ready
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Assessment against linked issues
Possibly related PRs
Suggested reviewers
✨ Finishing Touches🧪 Generate unit tests
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. CodeRabbit Commands (Invoked using PR/Issue comments)Type 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 (4)
modules/get-started/pages/release-notes/operator.adoc (1)
12-25: Beta section content is clear and consistent; consider adding a call-to-action link to the beta guideThe description of the new cluster-scoped default and RBAC simplification for rpk bundle collection looks correct. Per team learnings, temporary attribute/version inconsistencies during beta are expected, so no issue there. To help readers discover how to try the beta, add a link to the deployment guide.
Apply this diff to add a CTA link after the bullet list:
* **Simplified RBAC for debug bundles**: The Redpanda Operator now provides all required permissions for `rpk` debug bundle collection by default. The `rbac.createRPKBundleCRs` flag is no longer needed. +For instructions to try the Redpanda Operator 25.2 beta, see xref:deploy:deployment-option/self-hosted/kubernetes/k-25.2-beta.adoc[Try the 25.2 Beta of the Redpanda Operator].modules/deploy/pages/deployment-option/self-hosted/kubernetes/k-25.2-beta.adoc (3)
3-3: Tighten the page description to focus on the Operator (remove Helm chart mention)This page only documents the Operator path. Mentioning the Redpanda Helm chart here is confusing.
Apply this diff:
-:description: Deploy the 25.2 beta release of the Redpanda Operator or Redpanda Helm chart. This version of the Redpanda Operator defaults to cluster scope so a single instance of the Operator can manage multiple Redpanda resources in different namespaces. +:description: Deploy the 25.2 beta release of the Redpanda Operator. This version defaults to cluster scope so a single Operator instance can manage Redpanda resources across multiple namespaces.
42-48: Optional: runhelm repo updateafter adding the Redpanda repoNot strictly necessary after
helm repo add, but it avoids stale indexes in some environments.Apply this diff:
helm repo add redpanda https://charts.redpanda.com +helm repo update helm upgrade --install redpanda-controller redpanda/operator \ --namespace <namespace> \ --create-namespace \ --version {operator-beta-tag} \ --set crds.enabled=true
72-88: Avoid duplicating full manifests; show just the Enterprise section or clearly label this as a variantUsing the same filename and repeating the full document can confuse readers about which manifest to apply. Better: show only the Enterprise spec section to add, or label it as an alternate file.
Apply this diff to present only the Enterprise spec fragment:
-.`redpanda-cluster.yaml` -[,yaml,subs="attributes+"] ----- -apiVersion: cluster.redpanda.com/v1alpha2 -kind: Redpanda -metadata: - name: redpanda -spec: - clusterSpec: - enterprise: - licenseSecretRef: - name: <secret-name> - key: <secret-key> ----- +.Add the following to your `redpanda-cluster.yaml` manifest to enable Enterprise features: +[,yaml,subs="attributes+"] +---- +spec: + clusterSpec: + enterprise: + licenseSecretRef: + name: <secret-name> + key: <secret-key> +----If you prefer to keep a complete alternate manifest, rename the caption to something like
.redpanda-cluster-enterprise.yamland adjust subsequent commands accordingly.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these settings in your CodeRabbit configuration.
📒 Files selected for processing (2)
modules/deploy/pages/deployment-option/self-hosted/kubernetes/k-25.2-beta.adoc(1 hunks)modules/get-started/pages/release-notes/operator.adoc(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: Feediver1
PR: redpanda-data/docs#1153
File: antora.yml:3-5
Timestamp: 2025-07-14T19:28:43.296Z
Learning: In Redpanda docs, during beta releases, the version metadata may intentionally show inconsistencies where the header displays the beta version (e.g., 25.2 Beta) while internal attributes like full-version, latest-redpanda-tag, operator-beta-tag still reference the stable version (e.g., 25.1). This is resolved during the GA merge process when all version references are synchronized.
📚 Learning: 2025-07-14T19:28:43.296Z
Learnt from: Feediver1
PR: redpanda-data/docs#1153
File: antora.yml:3-5
Timestamp: 2025-07-14T19:28:43.296Z
Learning: In Redpanda docs, during beta releases, the version metadata may intentionally show inconsistencies where the header displays the beta version (e.g., 25.2 Beta) while internal attributes like full-version, latest-redpanda-tag, operator-beta-tag still reference the stable version (e.g., 25.1). This is resolved during the GA merge process when all version references are synchronized.
Applied to files:
modules/deploy/pages/deployment-option/self-hosted/kubernetes/k-25.2-beta.adocmodules/get-started/pages/release-notes/operator.adoc
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - redpanda-docs-preview
- GitHub Check: Header rules - redpanda-docs-preview
- GitHub Check: Pages changed - redpanda-docs-preview
🔇 Additional comments (3)
modules/get-started/pages/release-notes/operator.adoc (1)
12-25: LGTM on the 25.2.x (beta) release notes
- Accurate summary of the cluster-scope default and its benefits.
- RBAC note about rpk debug bundles is succinct and actionable.
modules/deploy/pages/deployment-option/self-hosted/kubernetes/k-25.2-beta.adoc (2)
61-71: Minimal CR example: confirm that an empty spec is valid in v1alpha2The example shows only apiVersion/kind/metadata. If v1alpha2 requires any mandatory fields in spec, this will fail reconciliation.
Would you confirm against the v25.2.x CRD whether a bare Redpanda resource without
specis valid? If not, we should include the smallest valid spec (for example,spec.clusterSpec.statefulset.replicasand essential storage settings). I can propose an updated minimal manifest once confirmed.
72-88: Verify license field pathspec.clusterSpec.enterprise.licenseSecretRefagainst the v25.2.x CRDField paths for licensing have changed across versions in the past. Let's ensure this is correct for v25.2.x before publishing.
If confirmed, consider adding a short note about expected Secret type/format (key containing the license string) to reduce support questions. I can add that snippet once you confirm the path.
modules/deploy/pages/deployment-option/self-hosted/kubernetes/k-25.2-beta.adoc
Show resolved
Hide resolved
modules/deploy/pages/deployment-option/self-hosted/kubernetes/k-25.2-beta.adoc
Show resolved
Hide resolved
There was a problem hiding this comment.
LGTM but we've not yet cut the beta. We're waiting on one last PR: redpanda-data/redpanda-operator#974
modules/deploy/pages/deployment-option/self-hosted/kubernetes/k-25.2-beta.adoc
Outdated
Show resolved
Hide resolved
| redpanda True Redpanda reconciliation succeeded | ||
| ---- | ||
| + | ||
| This step may take a few minutes. You can watch for new Pods to make sure that the deployment is progressing: |
There was a problem hiding this comment.
It should be pretty snappy. Is that not what you've experienced?
There was a problem hiding this comment.
It sometimes takes a while for the cluster to be ready. I've waited multiple minutes before.
There was a problem hiding this comment.
Ah, for the cluster to be ready. Do you often see the redpanda Pods handing around in a Scheduled but not yet Running state?
I've seen two primary sources of latency:
- cert-manager can be a bit sluggish which causes Kubelet's backoff loops to lengthen because it's waiting for the certs to be minted
- kubelet sometimes takes >1m to actually start running Pods :/ I haven't been able to figure out why but it's quite frustrating. There's even a dedicated PodStartLatency SLO metric that kubelet emits where it more or less "tells on itself".
JakeSCahill
changed the title
Co-authored-by: Chris Seto <[email protected]>
Description
Resolves https://redpandadata.atlassian.net/browse/DOC-1611
Note: The GA docs have already been written, submitted, and approved here: #1271
This pull request introduces documentation for the 25.2 beta release of the Redpanda Operator, highlighting its new default cluster-scoped deployment and providing instructions for testing the beta version. The changes include a new deployment guide and updated release notes to reflect the operator's new behavior and benefits.
Beta deployment documentation:
k-25.2-beta.adoc, detailing how to install and test the Redpanda Operator v25.2.1-beta1 on Kubernetes, including prerequisites, installation steps, and notes on feedback and support.Release notes update:
Page previews
Checks