Skip to content

Conversation

JakeSCahill
Copy link
Contributor

@JakeSCahill JakeSCahill commented Aug 1, 2025

Description

Previously approved in #1230 and reopened because the base branch was deleted

Resolves https://redpandadata.atlassian.net/browse/DOC-1459
Resolves https://redpandadata.atlassian.net/browse/DOC-1499
Review deadline: July 28

This pull request updates the documentation for deploying and managing Redpanda in Kubernetes, focusing on changes introduced in Redpanda Operator v25.2. Key updates include the transition to cluster-scoped deployments by default, improved multi-tenancy management, and adjustments to RBAC requirements.

Updates to Redpanda Operator Deployment and Management:

  • Cluster Scope as Default:

    • Updated documentation to reflect that Redpanda Operator v25.2 defaults to cluster scope, enabling management of multiple clusters across namespaces from a single operator instance. [1] [2]
    • Added guidance for deploying the operator in namespace scope, including specific Helm chart flags to restrict scope. [1] [2]
  • Multi-Tenancy Enhancements:

    • Clarified that the Redpanda Operator simplifies multi-tenancy by managing clusters across namespaces from a single instance.
    • Updated instructions for deploying additional clusters in different namespaces without requiring multiple operator instances. [1] [2] [3]
  • RBAC and Compatibility Adjustments:

    • Noted that ClusterRole permissions are required for both cluster and namespace scopes, and these are automatically configured with the Helm chart. [1] [2]
    • Updated Kubernetes compatibility matrix and versioning details to align with Redpanda Operator v25.2. [1] [2]

Migration and Upgrade Considerations:

  • Migration from Namespace Scope:

    • Added instructions for upgrading from namespace-scoped operators, emphasizing that no manual steps are required for existing deployments.
    • Warned against running operators in both cluster and namespace scopes within the same cluster to avoid resource conflicts. [1] [2]
  • Versioning and Compatibility:

    • Updated versioning scheme explanation and compatibility matrix to reflect changes in Redpanda Operator and Helm chart versions. [1] [2] [3]

These updates provide a more streamlined and scalable approach to managing Redpanda in Kubernetes, particularly for environments with multiple clusters.

Page previews

Checks

  • New feature
  • Content gap
  • Support Follow-up
  • Small fix (typos, links, copyedits, etc)

JakeSCahill and others added 25 commits July 15, 2025 12:22
Co-authored-by: Chris Seto <chriskseto@gmail.com>
Co-authored-by: Michele Cyran <michele@redpanda.com>
Co-authored-by: Michele Cyran <michele@redpanda.com>
Co-authored-by: Paulo Borges <paulohtb@hotmail.com>
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
Co-authored-by: Paulo Borges <paulohtb@Paulos-MacBook-Pro.local>
Co-authored-by: Michele Cyran <michele@redpanda.com>
…t-kafka-javascript (#1205)

Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
Co-authored-by: Jake Cahill <45230295+JakeSCahill@users.noreply.github.com>
Co-authored-by: Michele Cyran <michele@redpanda.com>
Co-authored-by: Jake Cahill <45230295+JakeSCahill@users.noreply.github.com>
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
@JakeSCahill JakeSCahill requested a review from a team as a code owner August 1, 2025 13:00
Copy link

netlify bot commented Aug 1, 2025

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit 8a84690
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/688cbb71fb347600085db9ab
😎 Deploy Preview https://deploy-preview-1271--redpanda-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Contributor

coderabbitai bot commented Aug 1, 2025

Warning

Rate limit exceeded

@JakeSCahill has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 3 minutes and 12 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between ae30164 and 8a84690.

📒 Files selected for processing (10)
  • modules/deploy/pages/deployment-option/self-hosted/kubernetes/k-deployment-overview.adoc (2 hunks)
  • modules/deploy/pages/deployment-option/self-hosted/kubernetes/k-production-deployment.adoc (3 hunks)
  • modules/deploy/partials/kubernetes/deploy-operator.adoc (1 hunks)
  • modules/get-started/pages/release-notes/operator.adoc (1 hunks)
  • modules/manage/pages/kubernetes/k-rack-awareness.adoc (0 hunks)
  • modules/migrate/pages/kubernetes/helm-to-operator.adoc (2 hunks)
  • modules/troubleshoot/partials/debug-bundle/generate-rpk.adoc (1 hunks)
  • modules/troubleshoot/partials/errors-and-solutions.adoc (0 hunks)
  • modules/upgrade/pages/k-compatibility.adoc (3 hunks)
  • modules/upgrade/pages/k-upgrade-operator.adoc (1 hunks)
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch DOC-1459

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.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants