docs (k8s): Add config-watcher sidecar resource configuration#1626
docs (k8s): Add config-watcher sidecar resource configuration#1626david-yu wants to merge 1 commit intoredpanda-data:mainfrom
Conversation
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>
✅ Deploy Preview for redpanda-docs-preview ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughA 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
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
Summary
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.resourcesbut does not explain the sidecar or provide standalone configuration guidance.Test plan
statefulset.sideCars.configWatcher.resourcespath is valid in both Operator CRD and Helm valueskubectl jsonpathverification command returns expected output🤖 Generated with Claude Code