Skip to content

Conversation

@JakeSCahill
Copy link
Contributor

Description

Resolves https://redpandadata.atlassian.net/browse/DOC-1530

This pull request updates Redpanda Console documentation to reflect changes in how Console is deployed and configured using the Redpanda Operator and Helm chart. The main focus is on switching the recommended deployment method from embedding Console in the Redpanda cluster resource to using a dedicated Console custom resource, and clarifying configuration examples and instructions accordingly. It also removes outdated notes about Operator versions and improves clarity in several configuration sections.

Deployment and Configuration Model Changes

  • All Operator-based configuration examples now use the dedicated Console custom resource (kind: Console, redpanda-console.yaml) instead of embedding Console configuration in the Redpanda cluster resource (kind: Redpanda, redpanda-cluster.yaml). This affects configuration for analytics, deserialization, Kafka Connect, topic documentation, HTTP path rewrites, and more. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13]

Documentation Cleanup and Clarity

  • Removed the operator-console-version-note partial from all Console configuration pages, as version-specific Operator notes are no longer needed. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11]

Operator and Helm Chart Usage Clarification

  • Updated instructions and examples to clarify the difference between Operator and Helm chart deployments, including how Console connects to Redpanda clusters using clusterRef or manual configuration (staticConfiguration).

Configuration Example Improvements

  • YAML examples now consistently use kind: Console and reference the Redpanda cluster via clusterRef, improving accuracy and reducing confusion. Extraneous or deprecated fields have been removed from examples. [1] [2] [3] [4] [5]

Minor Clarifications

  • Updated comments in configuration blocks to clarify auto-configuration behavior and usage of fields like brokers and authentication parameters. [1] [2]

Let me know if you want to discuss the new deployment model or need help updating existing resources to use the dedicated Console custom resource!

Page previews

Checks

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

Console v3 docs for Redpanda Operator v25.2
@JakeSCahill JakeSCahill requested a review from a team as a code owner October 28, 2025 07:51
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 28, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch consolev3-operator

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@JakeSCahill
Copy link
Contributor Author

@chrisseto I will clarify in the release notes how users will know whether to migrate configs. Please let me know whether you add the unmigratedConfig field and how to use it.

Also, will the CRD still come with the redpanda-console Service by default? Some of our guides reference:

kubectl --namespace <namespace> port-forward svc/redpanda-console 8080:8080

@JakeSCahill JakeSCahill requested review from chrisseto and removed request for a team October 28, 2025 07:52
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.

2 participants