Skip to content

docs (k8s): Add config-watcher sidecar resource configuration#1626

Open
david-yu wants to merge 1 commit intoredpanda-data:mainfrom
david-yu:doc/config-watcher-sidecar-resources
Open

docs (k8s): Add config-watcher sidecar resource configuration#1626
david-yu wants to merge 1 commit intoredpanda-data:mainfrom
david-yu:doc/config-watcher-sidecar-resources

Conversation

@david-yu
Copy link
Contributor

Summary

  • Adds a new "Configure config-watcher sidecar resources" section to the Manage Pod Resources page
  • Explains what the config-watcher sidecar does (monitors SASL user changes and configuration updates)
  • Documents that resources are unset by default and why that is acceptable for most clusters
  • Lists scenarios where explicit resources are needed (LimitRange, ResourceQuota, Guaranteed QoS)
  • Provides Operator and Helm examples with recommended values (10m/64Mi requests, 100m/128Mi limits)
  • Includes a verification command to confirm the sidecar resources after deployment

Context

The config-watcher sidecar container does not set resource requests or limits by default, and the existing documentation does not describe how to configure them. Customers running in namespaces with LimitRange or ResourceQuota policies, or targeting Guaranteed QoS, need guidance on setting these values. The QoS section already references sideCars.configWatcher.resources but does not explain the sidecar or provide standalone configuration guidance.

Test plan

  • Verify AsciiDoc renders correctly in the docs site preview
  • Confirm the statefulset.sideCars.configWatcher.resources path is valid in both Operator CRD and Helm values
  • Verify the kubectl jsonpath verification command returns expected output

🤖 Generated with Claude Code

Add a new section to the Manage Pod Resources page that describes how
to configure CPU and memory resources for the config-watcher sidecar
container. Includes examples for both Operator and Helm deployments,
explains when explicit resources are needed (LimitRange, ResourceQuota,
Guaranteed QoS), and provides recommended values.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@david-yu david-yu requested a review from a team as a code owner March 20, 2026 16:31
@netlify
Copy link

netlify bot commented Mar 20, 2026

Deploy Preview for redpanda-docs-preview ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 7aefe0f
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/69bd7666c9ed250008e04128
😎 Deploy Preview https://deploy-preview-1626--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.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 20, 2026

📝 Walkthrough

Walkthrough

A new documentation section has been added to the Kubernetes resource management page, covering CPU and memory resource configuration for the config-watcher sidecar container in Redpanda Pods. The addition includes practical examples for both Operator and Helm configuration methods, kubectl commands for verification, and guidance on when explicit resource limits and requests are necessary (specifically in scenarios involving LimitRange constraints, ResourceQuota policies, and QoS class requirements).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~15 minutes

Suggested reviewers

  • JakeSCahill
🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive The description covers the main content added, context, and test plan, but is missing required template sections: the Jira ticket reference, review deadline, and page preview link. Add the JIRA ticket identifier, review deadline, and the Netlify page preview URL to match the repository's description template.
✅ Passed checks (2 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check ✅ Passed The title accurately and specifically describes the main change: adding documentation about config-watcher sidecar resource configuration to the Kubernetes management page.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with 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.

❤️ Share

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

@david-yu david-yu changed the title docs: Add config-watcher sidecar resource configuration docs (k8s): Add config-watcher sidecar resource configuration Mar 20, 2026
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.

1 participant