Use the support-bundle Helm chart to collect diagnostic data from a ClickHouse Private cluster. The resulting archive can be shared with ClickHouse support to speed up incident resolution.
Prerequisites
The chart relies on Troubleshoot, a kubectl plugin for cluster diagnostics. Install it via Krew:
Or refer to the Troubleshoot documentation for other installation methods.
Generating and Running the Bundle
The chart does not install any resources into the cluster. Instead, it renders a SupportBundle manifest that is consumed by the kubectl support-bundle plugin.
Given a ClickHouse cluster named default-xx-01, render the chart locally and run the bundle:
The plugin collects the data and writes a tar.gz archive to the current directory.
What is Collected
The bundle collects data from two sources: the ClickHouse Operator namespace and the cluster namespace. By default the cluster namespace is derived as ns-<cluster-name>. If your cluster lives in a namespace that does not follow this convention, set supportBundle.namespace explicitly (see Custom Namespaces below).
ClickHouse Operator (toggle with supportBundle.collectors.operator.enabled):
- Container logs from the operator deployment
- Kubernetes resources in the operator namespace (Pods, Services, ConfigMaps, Events, etc.)
- Helm release values for charts installed in the operator namespace
ClickHouse Cluster (toggle with supportBundle.collectors.clickhouseCluster.enabled):
- ClickHouse Server container logs
- ClickHouse Keeper container logs
- Kubernetes resources in the cluster namespace
- Helm release values for charts installed in the cluster namespace
- Output of
SELECT version() from the first ClickHouse Server pod
- Output of the Keeper
mntr command from the first Keeper pod
Sensitive data — passwords, S3 credentials, cluster secrets, and password hashes — is automatically redacted.
Customizing Collection
The defaults are tuned for most scenarios but can be adjusted. For example, to collect only the last 24 hours of logs and skip operator data:
Render with the custom values file:
If the ClickHouse Operator was installed in a non-default namespace, set supportBundle.collectors.operator.namespace accordingly.
Custom Namespaces
The default cluster namespace is derived as ns-<clickhouseClusterName>. Clusters that live in a namespace that does not follow this convention must set supportBundle.namespace to their actual namespace. Otherwise the bundle will target the wrong namespace and silently omit the ClickHouse Server, Keeper, PVCs, and configmaps.
For example, for a ClickHouse cluster named clickhouse-cluster-01 that runs in the namespace clickhouse-cluster-01 (no ns- prefix):
Last modified on August 28, 2026
