Skip to content

docs: add production guidance for ClickHouse resources and PVC sizing - #813

Open
adionit7 wants to merge 1 commit into
SigNoz:mainfrom
adionit7:docs/clickhouse-production-guidance
Open

docs: add production guidance for ClickHouse resources and PVC sizing#813
adionit7 wants to merge 1 commit into
SigNoz:mainfrom
adionit7:docs/clickhouse-production-guidance

Conversation

@adionit7

@adionit7 adionit7 commented Jan 18, 2026

Copy link
Copy Markdown

What

Adds production guidance for ClickHouse resource requirements and persistent volume sizing to help users avoid common deployment issues.

Why

The default Helm values (200Mi memory, 20Gi disk) are fine for development but cause problems in production:

  • OOM kills due to insufficient memory
  • Disk space exhaustion leading to data loss
  • Poor performance from undersized resources

This adds clear warnings and sizing guidelines directly in the values.yaml comments and README so users see them during configuration.

Changes

  • Added production warnings and sizing guidelines in values.yaml for:
    • ClickHouse resource requests/limits (memory and CPU)
    • Persistent volume sizing with calculation examples
    • Storage class selection recommendations
    • PVC expansion guidance
  • Added "Production Considerations" section to README with practical examples

Impact

Reduces support load by helping users size correctly from the start, preventing production incidents and data loss.

Testing

  • Reviewed values.yaml syntax
  • Verified README formatting
  • Checked calculation examples for accuracy

Summary by CodeRabbit

  • Documentation
    • Added production considerations guidance for ClickHouse deployments.
    • Includes CPU and memory resource requirements, disk sizing guidelines and capacity planning, storage expansion recommendations, and SSD best practices.

✏️ Tip: You can customize this high-level summary in your review settings.

@adionit7
adionit7 requested a review from a team as a code owner January 18, 2026 21:38
@coderabbitai

coderabbitai Bot commented Jan 18, 2026

Copy link
Copy Markdown
📝 Walkthrough

Walkthrough

Documentation-only changes to the SigNoz Helm chart: added a Production Considerations section to README.md detailing resource sizing and disk planning for ClickHouse, and introduced extensive resource and persistence sizing guidance as inline comments to values.yaml. No functional code or behavioral changes.

Changes

Cohort / File(s) Summary
Documentation & Resource Guidance
charts/signoz/README.md, charts/signoz/values.yaml
Added Production Considerations section covering ClickHouse memory/CPU recommendations, disk sizing guidelines, storage expansion notes, and SSD guidance (+59 lines to README); augmented values.yaml with inline comments providing development-to-production resource and persistence sizing advice (+48 lines to values.yaml)

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

Suggested labels

safe-to-test

Suggested reviewers

  • grandwizard28
  • prashant-shahi

Poem

🐰 Hop, hop, through production land so vast,
Resource guides now holding fast—
ClickHouse sized for every need,
Documentation's planted seed,
SSD speeds and memory too,
Built for scale—production-true! 💾✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and specifically summarizes the main change: adding production guidance documentation for ClickHouse resources and PVC sizing.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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


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.

@Nageshbansal Nageshbansal added chart:clickhouse Issue related to clickhouse helm chart chart:signoz Issue related to signoz helm chart and removed chart:clickhouse Issue related to clickhouse helm chart labels May 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

chart:signoz Issue related to signoz helm chart

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants