Add docs for extraClusterConfig #1187

JakeSCahill · 2025-06-30T12:41:04Z

Description

Resolves https://redpandadata.atlassian.net/browse/DOC-1460
Review deadline: July 3

Page previews

Checks

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

netlify · 2025-06-30T12:41:10Z

✅ Deploy Preview for redpanda-docs-preview ready!

Name	Link
🔨 Latest commit	`dc290c8`
🔍 Latest deploy log	https://app.netlify.com/projects/redpanda-docs-preview/deploys/68654ea9dc46730008711392
😎 Deploy Preview	https://deploy-preview-1187--redpanda-docs-preview.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

coderabbitai · 2025-06-30T12:41:12Z

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.

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 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.

chrisseto

LGTM sans the comment on reset-object-storage.

chrisseto · 2025-06-30T14:15:02Z

modules/manage/partials/kubernetes/reset-object-storage-properties.adoc

@@ -0,0 +1,2 @@
+CAUTION: Do not set an object storage property to an empty string (`""`) or `null` to reset it. This may result in invalid or incomplete configuration.


oooooo, so this is tricky. By default unsetting a key will NOT unset the cluster config value as that's been the historical behavior for quite a while now. We recently added an annotation that will opt you into being fully declarative.

I think we should update this to point users at rpk cluster config set (though I'm not sure if that can actually unset a value 🤔 ) or denote the annotation.

Thanks, Chris. Does this change cover it? 89b36a1

modules/manage/pages/kubernetes/k-configure-helm-chart.adoc

Co-authored-by: Chris Seto <[email protected]>

micheleRP · 2025-07-02T15:00:29Z

modules/get-started/pages/release-notes/operator.adoc

+
+- Reusability: Centralize common values used by multiple features.
+
+- Maintainability: Integrate more cleanly with GitOps workflows and Kubernetes-native resource management.


To my ear, "Integrate more cleanly" feels a little awkward. Can you use "Integrate more seamlessly" or "Better integrate"?

micheleRP · 2025-07-02T15:00:46Z

modules/get-started/pages/release-notes/helm-charts.adoc

+
+- Reusability: Centralize common values used by multiple features.
+
+- Maintainability: Integrate more cleanly with GitOps workflows and Kubernetes-native resource management.


To my ear, "Integrate more cleanly" feels a little awkward. Can you use "Integrate more seamlessly" or "Better integrate"?

modules/manage/pages/kubernetes/k-configure-helm-chart.adoc

modules/manage/partials/kubernetes/extraclusterconfig.adoc

micheleRP

left a couple little suggestions

modules/get-started/pages/release-notes/helm-charts.adoc

Co-authored-by: Michele Cyran <[email protected]>

modules/get-started/pages/release-notes/operator.adoc

Co-authored-by: Chris Seto <[email protected]> Co-authored-by: Michele Cyran <[email protected]>

Add docs for extraClusterConfig

2db68a5

JakeSCahill requested a review from a team as a code owner June 30, 2025 12:41

Add release note

51aebb1

JakeSCahill requested a review from chrisseto June 30, 2025 12:45

chrisseto approved these changes Jun 30, 2025

View reviewed changes

JakeSCahill and others added 2 commits July 1, 2025 10:12

Apply suggestions from code review

6e34675

Co-authored-by: Chris Seto <[email protected]>

Add a section on resetting values

89b36a1

micheleRP reviewed Jul 2, 2025

View reviewed changes

modules/manage/pages/kubernetes/k-configure-helm-chart.adoc Outdated Show resolved Hide resolved

micheleRP reviewed Jul 2, 2025

View reviewed changes

modules/manage/pages/kubernetes/k-configure-helm-chart.adoc Outdated Show resolved Hide resolved

micheleRP reviewed Jul 2, 2025

View reviewed changes

modules/manage/partials/kubernetes/extraclusterconfig.adoc Outdated Show resolved Hide resolved

micheleRP approved these changes Jul 2, 2025

View reviewed changes

JakeSCahill commented Jul 2, 2025

View reviewed changes

modules/get-started/pages/release-notes/helm-charts.adoc Outdated Show resolved Hide resolved

Apply suggestions from code review

6513c44

Co-authored-by: Michele Cyran <[email protected]>

JakeSCahill commented Jul 2, 2025

View reviewed changes

modules/get-started/pages/release-notes/operator.adoc Outdated Show resolved Hide resolved

Apply suggestions from code review

dc290c8

JakeSCahill merged commit eae37a2 into beta Jul 2, 2025
7 checks passed

JakeSCahill deleted the DOC-1460 branch July 2, 2025 16:11

JakeSCahill added a commit that referenced this pull request Jul 15, 2025

Add docs for extraClusterConfig (#1187)

7397df2

Co-authored-by: Chris Seto <[email protected]> Co-authored-by: Michele Cyran <[email protected]>

paulohtb6 pushed a commit that referenced this pull request Jul 15, 2025

Add docs for extraClusterConfig (#1187)

30c90dc

Co-authored-by: Chris Seto <[email protected]> Co-authored-by: Michele Cyran <[email protected]>

paulohtb6 pushed a commit that referenced this pull request Jul 30, 2025

Add docs for extraClusterConfig (#1187)

8d07bb6

Co-authored-by: Chris Seto <[email protected]> Co-authored-by: Michele Cyran <[email protected]>

		@@ -0,0 +1,2 @@
		CAUTION: Do not set an object storage property to an empty string (`""`) or `null` to reset it. This may result in invalid or incomplete configuration.


		- Reusability: Centralize common values used by multiple features.

		- Maintainability: Integrate more cleanly with GitOps workflows and Kubernetes-native resource management.

Uh oh!

Add docs for extraClusterConfig #1187

Add docs for extraClusterConfig #1187

Uh oh!

Conversation

JakeSCahill commented Jun 30, 2025

Description

Page previews

Checks

Uh oh!

netlify bot commented Jun 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for redpanda-docs-preview ready!

Uh oh!

coderabbitai bot commented Jun 30, 2025

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

chrisseto left a comment

Choose a reason for hiding this comment

Uh oh!

chrisseto Jun 30, 2025

Choose a reason for hiding this comment

Uh oh!

JakeSCahill Jul 1, 2025

Choose a reason for hiding this comment

Uh oh!

chrisseto Jul 2, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

micheleRP Jul 2, 2025

Choose a reason for hiding this comment

Uh oh!

micheleRP Jul 2, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

micheleRP left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

netlify bot commented Jun 30, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)