Add a beta deployment template for the operator #1548
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 📝 WalkthroughWalkthroughA new AsciiDoc documentation partial is introduced that provides deployment templates and comprehensive instructions for the Redpanda Operator 25.2 Beta. The content covers both cluster-scoped and namespace-scoped deployment approaches, including prerequisite verification, CRD permissions validation, cert-manager installation steps, Helm and kubectl deployment commands, multi-cluster scenarios, and cleanup procedures. YAML examples, resource definitions, and operational guidance are included throughout. Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Disabled knowledge base sources:
- Jira integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
modules/deploy/partials/beta-operator-deployment-template.adoc
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: Feediver1
Repo: redpanda-data/docs PR: 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
Repo: redpanda-data/docs PR: 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/partials/beta-operator-deployment-template.adoc
📚 Learning: 2025-12-12T16:18:28.126Z
Learnt from: andrewstucki
Repo: redpanda-data/docs PR: 1514
File: modules/troubleshoot/partials/errors-and-solutions.adoc:618-632
Timestamp: 2025-12-12T16:18:28.126Z
Learning: In Redpanda ShadowLink CRD usage, do not copy CA certificates into pods via kubectl cp because they won't persist across pod restarts. Store CA certs in Kubernetes Secrets and reference them in the ShadowLink's staticConfiguration block (or inline the cert data in that block) to ensure persistence and proper secret management.
Applied to files:
modules/deploy/partials/beta-operator-deployment-template.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 (4)
modules/deploy/partials/beta-operator-deployment-template.adoc (4)
1-7: LGTM! Clear beta warning and documentation structure.The header appropriately sets the beta page attribute and provides a clear warning that this version is not for production use, with a link to the Slack community for feedback.
13-122: LGTM! Well-structured cluster-scoped deployment instructions.The section clearly distinguishes between the operator namespace and cluster namespace, includes comprehensive steps for CRD permissions, cert-manager, and the operator deployment, and provides helpful guidance on enterprise licensing.
123-166: LGTM! Good multi-cluster deployment guidance.The section appropriately warns about port conflicts and provides concrete examples of unique external ports for the second cluster. The guidance to use different namespaces is clear.
209-209: Excellent operational warning about scope conflicts.The warning about not running operators in different scopes is critical for preventing resource conflicts and is appropriately highlighted.
| . Delete all Redpanda-related custom resources: | ||
| + | ||
| [,bash,role="no-wrap"] | ||
| ---- | ||
| kubectl delete users --namespace <operator-namespace> --all | ||
| kubectl delete topics --namespace <operator-namespace> --all | ||
| kubectl delete schemas --namespace <operator-namespace> --all | ||
| kubectl delete redpanda --namespace <operator-namespace> --all | ||
| ---- | ||
|
|
||
| . Make sure requests for those resources return no results. For example, if you had a Redpanda cluster named `redpanda` in the namespace `<namespace>`, run: | ||
| + | ||
| [,bash] | ||
| ---- | ||
| kubectl get redpanda --namespace <cluster-namespace> | ||
| ---- |
There was a problem hiding this comment.
Fix namespace placeholder inconsistencies in uninstall instructions.
The uninstall section has critical namespace placeholder issues:
-
Lines 271-274: Uses
<operator-namespace>to delete custom resources (users, topics, schemas, redpanda), but these resources are deployed to:<cluster-namespace>in cluster-scoped deployments (per line 72)<namespace>in namespace-scoped deployments (per line 231)
This will fail to delete resources when the operator and cluster are in different namespaces.
-
Lines 277 vs 281: The text uses placeholder
<namespace>but the command uses<cluster-namespace>- inconsistent naming.
The uninstall section should either:
- Provide separate instructions for cluster-scoped vs namespace-scoped cleanup, OR
- Use a generic placeholder that clearly indicates "the namespace where your Redpanda cluster was deployed"
🔧 Proposed fix using a clearer, unified placeholder
. Delete all Redpanda-related custom resources:
+
[,bash,role="no-wrap"]
----
-kubectl delete users --namespace <operator-namespace> --all
-kubectl delete topics --namespace <operator-namespace> --all
-kubectl delete schemas --namespace <operator-namespace> --all
-kubectl delete redpanda --namespace <operator-namespace> --all
+kubectl delete users --namespace <redpanda-namespace> --all
+kubectl delete topics --namespace <redpanda-namespace> --all
+kubectl delete schemas --namespace <redpanda-namespace> --all
+kubectl delete redpanda --namespace <redpanda-namespace> --all
----
-. Make sure requests for those resources return no results. For example, if you had a Redpanda cluster named `redpanda` in the namespace `<namespace>`, run:
+. Make sure requests for those resources return no results. For example, if you had a Redpanda cluster named `redpanda` in the namespace `<redpanda-namespace>`, run:
+
[,bash]
----
-kubectl get redpanda --namespace <cluster-namespace>
+kubectl get redpanda --namespace <redpanda-namespace>
----Then update line 327 similarly:
-kubectl delete pvc,secret --all --namespace <cluster-namespace>
+kubectl delete pvc,secret --all --namespace <redpanda-namespace>Alternatively, add a note at the beginning of the uninstall section clarifying which namespace to use based on the deployment mode.
| @@ -0,0 +1,332 @@ | |||
| = Try the 25.2 Beta of the Redpanda Operator | |||
There was a problem hiding this comment.
should we tag this so it uses whatever version is available?
|
|
||
| == Prerequisites | ||
|
|
||
| Make sure that your Kubernetes cluster meets the xref:./k-requirements.adoc[requirements]. |
| kubectl auth can-i create CustomResourceDefinition --all-namespaces | ||
| ``` | ||
| + | ||
| You should see `yes` in the output. |
There was a problem hiding this comment.
just yes? maybe we can encompass it in a code block?
something like that
.Output
[,bash,role=no-copy]
----
yes
----
| + | ||
| <1> Add your namespace. | ||
|
|
||
| . If you want to use enterprise features in Redpanda, add the details of a Secret that stores your Enterprise Edition license key. |
There was a problem hiding this comment.
should we advise on using enterprise in beta?
|
|
||
| When you finish testing Redpanda, you can uninstall it from your Kubernetes cluster. | ||
|
|
||
| Follow the steps in **exact order** to avoid race conditions between |
There was a problem hiding this comment.
maybe make it numbered steps?
|
|
||
| . (Optional) Delete any leftover PVCs or Secrets in the namespace: | ||
| + | ||
| CAUTION: The following command deletes all PVCs and Secrets in the namespace, which may remove unrelated resources if the namespace is shared with other applications. |
There was a problem hiding this comment.
any way to prevent this issue from happening?
Description
Adds an example template for a guide on deploying a beta version of the Redpanda Operator. We can use this file to create beta docs for the operator in future releases.
Page previews
Checks