feat(clickouse-instance): allow Clickhouse instance to be disable #740

nlamirault · 2025-09-01T11:08:27Z

Summary by CodeRabbit

New Features
- Added per-instance configuration (clickhouseInstance) with expanded options: probes, resources, security, scheduling, persistence, extra volumes/containers, custom files, logs/metrics, and cold storage.
- Introduced an enable flag to control rendering of ClickHouse instance resources.
- Scoped optional custom StorageClass creation to the instance.
Refactor
- Migrated previous top-level ClickHouse settings into clickhouseInstance (images, service, accounts, networking, profiles/settings, layout).
- Consolidated logs exporter and related config under the instance scope.
- Standardized namespace resolution via a chart helper.

Signed-off-by: Nicolas Lamirault <[email protected]>

coderabbitai · 2025-09-01T11:08:35Z

Walkthrough

Migrates ClickHouse Helm chart values to a per-instance namespace under .Values.clickhouseInstance. Adds a top-level enable gate for rendering instance resources. Updates helpers and templates to reference the new paths, adjusts namespace resolution via helper, and introduces nested gating for logs and storage-class rendering.

Changes

Cohort / File(s)	Summary
Values restructuring `charts/clickhouse/values.yaml`	Introduces clickhouseInstance root with migrated per-instance fields (image, serviceAccount, service, persistence, scheduling, probes, resources, securityContext, settings/profiles, logs, coldStorage, initContainers, files, templates, extraContainers). Adds installCustomStorageClass at root.
Helper templates `charts/clickhouse/templates/_helper.tpl`	Redirects lookups to .Values.clickhouseInstance.* for serviceAccountName, images (init, udf, main, logs), imagePullSecrets, service account annotations, files. Logic stays the same; only value paths change.
Instance resource gating and path migration `charts/clickhouse/templates/clickhouse-instance/clickhouse-instance.yaml`, `charts/clickhouse/templates/clickhouse-instance/configmap.yaml`, `charts/clickhouse/templates/clickhouse-instance/scripts-configmap.yaml`	Wraps resources with {{ if .Values.clickhouseInstance.enabled }}. Migrates numerous fields from top-level to .Values.clickhouseInstance.*. ConfigMaps now use {{ include "clickhouse.namespace" . }} for namespace.
Logs exporter configmap gating `charts/clickhouse/templates/clickhouse-instance/exporter-configmap.yaml`	Adds nested gating: require clickhouseInstance.enabled and clickhouseInstance.logs.system.enabled. Moves config source to clickhouseInstance.logs.system.config. Uses namespace helper.
ServiceAccount gating `charts/clickhouse/templates/clickhouse-instance/serviceaccount.yaml`	Adds outer gate on clickhouseInstance.enabled; inner gate on clickhouseInstance.coldStorage.role.enabled or clickhouseInstance.serviceAccount.create. Value paths updated to per-instance.
StorageClass gating and cloud path `charts/clickhouse/templates/clickhouse-instance/storage-class.yaml`	Adds outer gate on clickhouseInstance.enabled and inner gate on clickhouseInstance.installCustomStorageClass. Cloud checks read from clickhouseInstance.global.cloud. StorageClass specs unchanged.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant U as Helm User
  participant H as Helm Engine
  participant V as Values
  participant T as Templates

  U->>H: helm install/upgrade
  H->>V: Read .Values
  H->>T: Render templates

  alt clickhouseInstance.enabled == true
    note over T: Instance resources render
    alt logs.system.enabled == true
      note over T: Render exporter-configmap
    else logs.system.enabled == false
      note over T: Skip exporter-configmap
    end

    alt installCustomStorageClass == true
      note over T: Render StorageClass
    else
      note over T: Skip StorageClass
    end
  else clickhouseInstance.enabled == false
    note over T: Skip all clickhouse-instance resources
  end

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~60 minutes

Suggested reviewers

grandwizard28
prashant-shahi

Poem

I thump my paws on templated ground,
New burrows mapped, where values abound.
Gates now guard our carrot stash,
Only when “enabled” we dash.
Logs hop neatly through their hedge,
Storage sprouts at a toggled edge.
Ship it quick—let clusters crunch and munch! 🥕

✨ Finishing Touches

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment

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.
- 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.
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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

Add @coderabbitai ignore or @coderabbit 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

Status, Documentation and Community

Visit our Status Page to check the current availability of CodeRabbit.
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.

coderabbitai

Actionable comments posted: 7

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

charts/clickhouse/values.yaml (1)

568-571: Move installCustomStorageClass under clickhouseInstance in values.yaml. Ensure the installCustomStorageClass key is defined as clickhouseInstance.installCustomStorageClass so it meshes with the gating in charts/clickhouse/templates/clickhouse-instance/storage-class.yaml (which checks .Values.clickhouseInstance.installCustomStorageClass).

🧹 Nitpick comments (3)

charts/clickhouse/templates/clickhouse-instance/scripts-configmap.yaml (1)
21-33: Avoid infinite wait and wget dependency in postStart script.
If wget is missing in the image, postStart will fail; also the loop is unbounded. Add a max attempts and prefer curl (more commonly present) with a short timeout.

Apply this diff within the script body:
-    while true; do
-        response=$(wget --spider -S "http://${HOST}:${PORT}/ping" 2>&1)
-        exit_code=$?
+    MAX_ATTEMPTS=${MAX_ATTEMPTS:-60}
+    attempt=0
+    while [ "$attempt" -lt "$MAX_ATTEMPTS" ]; do
+        if command -v curl >/dev/null 2>&1; then
+          curl -fsS --max-time 2 "http://${HOST}:${PORT}/ping" >/dev/null
+          exit_code=$?
+        else
+          wget -q --spider "http://${HOST}:${PORT}/ping"
+          exit_code=$?
+        fi
         if [ $exit_code -eq 0 ]; then
             echo "Clickhouse is ready!"
             exit 0
         else
             echo "Clickhouse is not ready yet. Retrying in ${DELAY} seconds..."
             sleep $DELAY
+            attempt=$((attempt+1))
         fi
     done
+    echo "Clickhouse did not become ready after ${MAX_ATTEMPTS} attempts."
+    exit 1
charts/clickhouse/templates/clickhouse-instance/exporter-configmap.yaml (1)
11-14: Defensive default for config to avoid “null”.
If users leave logs.system.config unset, toYaml on a nil value can yield undesirable output.

Apply:
-    {{- toYaml .Values.clickhouseInstance.logs.system.config | nindent 4 }}
+    {{- toYaml (default (dict) .Values.clickhouseInstance.logs.system.config) | nindent 4 }}
charts/clickhouse/templates/clickhouse-instance/clickhouse-instance.yaml (1)

61-116: Consider using Secrets or env-based credentials for cold storage.
Avoid embedding static access keys directly in the CR. You already support role-based creds; as a fallback, reference K8s Secrets or env vars.

I can propose a variant using from_env and mounting a Secret if desired.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

MCP integration is disabled by default for public repositories
Jira integration is disabled by default for public repositories
Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 73830e8 and 9c1292f.

📒 Files selected for processing (8)

charts/clickhouse/templates/_helper.tpl (8 hunks)
charts/clickhouse/templates/clickhouse-instance/clickhouse-instance.yaml (11 hunks)
charts/clickhouse/templates/clickhouse-instance/configmap.yaml (2 hunks)
charts/clickhouse/templates/clickhouse-instance/exporter-configmap.yaml (1 hunks)
charts/clickhouse/templates/clickhouse-instance/scripts-configmap.yaml (2 hunks)
charts/clickhouse/templates/clickhouse-instance/serviceaccount.yaml (2 hunks)
charts/clickhouse/templates/clickhouse-instance/storage-class.yaml (3 hunks)
charts/clickhouse/values.yaml (1 hunks)

🧰 Additional context used

🧠 Learnings (1)

📚 Learning: 2024-12-16T16:15:01.460Z

Learnt from: prashant-shahi
PR: SigNoz/charts#565
File: charts/clickhouse/values.yaml:261-264
Timestamp: 2024-12-16T16:15:01.460Z
Learning: In `charts/clickhouse/values.yaml`, the `customStartupProbe`, `customLivenessProbe`, and `customReadinessProbe` configurations are provided for advanced users to specify custom probe types such as HTTP, Exec, TCP, and gRPC.

Applied to files:

charts/clickhouse/templates/clickhouse-instance/clickhouse-instance.yaml

🪛 YAMLlint (1.37.1)

charts/clickhouse/templates/clickhouse-instance/scripts-configmap.yaml