github.com/ClickHouse/clickhouse-operator

Install using the manifest (server-side apply)

kubectl apply --server-side --force-conflicts -f https://github.com/ClickHouse/clickhouse-operator/releases/download/v0.0.7/clickhouse-operator.yaml

For clusters restricted to client-side apply, use the description-stripped CRDs:

kubectl apply -f https://github.com/ClickHouse/clickhouse-operator/releases/download/v0.0.7/clickhouse-operator-stripped-crds.yaml

CRDs only

kubectl apply --server-side --force-conflicts -f https://github.com/ClickHouse/clickhouse-operator/releases/download/v0.0.7/clickhouse-operator-crds.yaml

Client-side apply variant: clickhouse-operator-crds-stripped.yaml

Install using helmchart

helm install clickhouse-operator oci://ghcr.io/clickhouse/clickhouse-operator-helm \
   --version=0.0.7 \
   --create-namespace \
   -n clickhouse-operator-system

Changelog

🚀 Features

• feat: support encrypted storage policy generation
  • PR: #269

🐛 Fixes

• fix: don't drop a non-empty Atomic default database during Replicated conversion
  • PR: #255
• fix: reduce probe job memory footprint
  • PR: #257
• fix: compare Keeper replica versions numerically, not lexicographically
  • PR: #260
• fix: default probe ports and probe-failure rollout gating
  • PR: #262
• fix: hide secrets from preprocessed config
  • PR: #267
• fix: use resourceName helper for webhook-server-cert secret name
  • PR: #270

📚 Docs

• docs: extract storage related documentation as a dedicated guide
  • PR: #243
• docs: network policies
  • PR: #246
• docs: document Kubernetes events emitted by the operator
  • PR: #252
• docs: clarify topologyZoneKey and nodeHostnameKey semantics
  • PR: #271

🧹 Chores

• ci: fix changelog categories generation
  • PR: #242
• chores: reduce amount of reconciles, cache CH connections between reconciles
  • PR: #245
• ci: add Dependabot config for scheduled version updates
  • PR: #249
• ci: bump the github-actions group with 3 updates
  • PR: #250
• chores: bump the go-modules group with 50 updates
  • PR: #251
• chores: bump the go-modules group with 22 updates
  • PR: #253
• chores: bump the go-modules group with 5 updates
  • PR: #259
• chores: bump the go-modules group with 15 updates
  • PR: #263
• chores: bump github.com/go-openapi/jsonreference from 0.21.6 to 1.0.0
  • PR: #264
• Fix markdown parsing error
  • PR: #247

Install using the manifest (server-side apply)

kubectl apply --server-side --force-conflicts -f https://github.com/ClickHouse/clickhouse-operator/releases/download/v0.0.6/clickhouse-operator.yaml

For clusters restricted to client-side apply, use the description-stripped CRDs:

kubectl apply -f https://github.com/ClickHouse/clickhouse-operator/releases/download/v0.0.6/clickhouse-operator-stripped-crds.yaml

CRDs only

kubectl apply --server-side --force-conflicts -f https://github.com/ClickHouse/clickhouse-operator/releases/download/v0.0.6/clickhouse-operator-crds.yaml

Client-side apply variant: clickhouse-operator-crds-stripped.yaml

Install using helmchart

helm install clickhouse-operator oci://ghcr.io/clickhouse/clickhouse-operator-helm \
   --version=0.0.6 \
   --create-namespace \
   -n clickhouse-operator-system

Changelog

🚀 Features

• feat: add JBOD additional PVC support for ClickHouse replicas
  • PR: #136
• feat(release): Create PR to community-operators
  • PR: #190
• feat: allow exposing additional ports on ClickHouse service and pods
  • PR: #197
• feat: reject additionalPorts that collide with operator-managed ports
  • PR: #205
• feat: add ExternalSecret print column to ClickHouseCluster
  • PR: #207
• feat(keeper): smart-default maxUnavailable=1 for single-replica PDB
  • PR: #208
• feat: add prometheus port to the keeper headless service
  • PR: #226
• feat: warnings as a kubernetes events
  • PR: #209
• feat: add registry option to helm charts
  • PR: #227
• feat: add crds as a separate release artifact, build stripped crds to fit client-side apply
  • PR: #232
• feat: support distroless images in version probe
  • PR: #195
• feat: do not set caBundle from certificate by default, only with explicit setting
  • PR: #237
• Don't restart pods on some config changes
  • PR: #115

🐛 Fixes

• fix: strip owned resources names to fit in limits
  • PR: #204
• fix: override resources as whole, use the same req/limit for memory in default
  • PR: #206
• fix: track users reload separetely of server config
  • PR: #218
• fix: paginate all tags to build olm catalog
  • PR: #221

🧪 Tests

• test: automatic e2e tests split between parallel jobs
  • PR: #200
• test: fix docs linting CI jobs
  • PR: #212
• test: add openshift e2e smoke test
  • PR: #202
• test: add upgrade tests to verify operator forward compatibility
  • PR: #229
• test: fix flaky operator-upgrade keeper writes
  • PR: #233
• test: use latest supported ClickHouse versions in tests
  • PR: #234

📚 Docs

• docs: add monitoring & observability guide
  • PR: #198
• docs: prefix internal ClickHouse doc links with /core
  • PR: #201
• docs: document spec.additionalPorts and reserved-port validation
  • PR: #210
• docs: document upgradeChannel and version probe
  • PR: #216
• docs: document Pod disruption budget configuration
  • PR: #213
• docs: document spec.settings.logger server logging configuration
  • PR: #220
• docs: scaling guide
  • PR: #222
• docs: tls configuration
  • PR: #223
• docs: fix docs links and CI, fetch mintlify changes, actualize some docs and comments
  • PR: #230
• docs: update AGENTS.md, do not run tests on pure documentation changes
  • PR: #231
• docs: document spec.clusterDomain in configuration guide
  • PR: #228
• docs: expand default user password configuration
  • PR: #238
• Docs/external secret config
  • PR: #203
• Docs: add Mintlify frontmatter to docs pages
  • PR: #192

🧹 Chores

• chore: bump dependencies, enable clickhouse client linter, fix new linters issues
  • PR: #194
• build: publish per-commit bundle + catalog on 'fast' channel
  • PR: #211
• ci: fix paths-filter so docs-only changes actually skip CI
  • PR: #239
• chores: update dependencies, actions, linter config, generate helm chart with latest kubebuilder
  • PR: #240
• ci: bypass v1 registries.conf in opm catalog render
  • PR: #241

Install using the manifest

kubectl apply -f https://github.com/ClickHouse/clickhouse-operator/releases/download/v0.0.5/clickhouse-operator.yaml

Install using helmchart

helm install clickhouse-operator oci://ghcr.io/clickhouse/clickhouse-operator-helm \
   --version=0.0.5 \
   --create-namespace \
   -n clickhouse-operator-system

Changelog

🚀 Features

• Added metrics logs so the built-in dashboard displays proper values. Otherwise, it feels broken at cluster installation.
  • PR: #167
• feat: support keeper on a different namespace
  • PR: #173
• feat: add clickhouse-cluster helm chart
  • PR: #183
• feat: correctly handle IPv4-only envs
  • PR: #185
• feat(helm): Regenerate helm chart with latest kubebuilder
  • PR: #159
• feat: drop all capabilities by default, remove restricted security settings in OpenShift installations
  • PR: #184

🐛 Fixes

• fix: cache version probe result to prevent reconciliation deadlock
  • PR: #175
• fix: respect user-provided container capabilities under PodSecurity restricted
  • PR: #176
• fix: set Healthy/Ready to Unknown if pods are running, but the operator can't connect to the server
  • PR: #186
• fix: requeue reconciliation after replica update
  • PR: #189

📦 Uncategorized

• test: support suppressing crd-comptat-check
  • PR: #177
• Docs: restructure for Mintlify sync workflow
  • PR: #187

Install using the manifest

kubectl apply -f https://github.com/ClickHouse/clickhouse-operator/releases/download/v0.0.4/clickhouse-operator.yaml

Install using helmchart

helm install clickhouse-operator oci://ghcr.io/clickhouse/clickhouse-operator-helm \
   --version=0.0.4 \
   --create-namespace \
   -n clickhouse-operator-system

Changelog

🚀 Features

• feat: allow to disable PDB management
  • PR: #164
• feat(helm): allow specifying operator image digest
  • PR: #146
• feat: apply pod/container overrides via strategic merge patch
  • PR: #150
• feat: support more container/pod fields overrides, enchance default security context and probes
  • PR: #151
• feat: add default resource for version probe job, recreate it only on significant changes
  • PR: #152
• feat: add version probe job overrides
  • PR: #153
• feat: named collections in keeper with key encryption
  • PR: #111
• feat: support externally managed secret
  • PR: #168

📦 Uncategorized

• test: added functional tests for ClickHouse commander
  • PR: #123
• fix: image tag in installer, changelog categories, main build images versions
  • PR: #124
• fix(docs): .containerTemplate.resources docstring
  • PR: #135
• fix(helm): support not secure metrics in helmchart servicemonitor, fix serverName
  • PR: #137
• Bump google.golang.org/grpc from 1.79.1 to 1.79.3
  • PR: #138
• fix(reconcile): refactor pvc reconcillation, add conflict retries
  • PR: #139
• test: update CH test versions to the latest supported releases
  • PR: #147
• fix: calcucation of the supported versions
  • PR: #148
• test(e2e):Run controller in e2e tests process, dump namespace obejcts and pod logs on failure.
  • PR: #140
• chores: update dependecies, fix new linting issues, apply new golang syntax everywhere, regenerate helmchart with new generator
  • PR: #149
• Bump go.opentelemetry.io/otel/sdk from 1.42.0 to 1.43.0
  • PR: #155
• chores: unify extra config behaviour, mount keeper extra config as separate cofile
  • PR: #156
• chore: add CI runner disk space cleanup, fix flaky tests
  • PR: #157
• ci: package and push helm chart in release-main workflow
  • PR: #154
• chores: add AGENTS.md
  • PR: #158
• build: version local dependencies in Makefile
  • PR: #160
• chores: split reconcilerBase on more specialized helpers
  • PR: #162
• chores: refactor reconcillation pipeline supporting blocking without error
  • PR: #163
• test: pre pull clickhouse images in e2e test, test campatible versions only with manifests installation
  • PR: #165
• chores: update dependencies
  • PR: #166

Install using the manifest

kubectl apply -f https://github.com/ClickHouse/clickhouse-operator/releases/download/v0.0.3/clickhouse-operator.yaml

Install using helmchart

helm install clickhouse-operator oci://ghcr.io/clickhouse/clickhouse-operator-helm \
   --version=0.0.3 \
   --create-namespace \
   -n clickhouse-operator-system

Changelog

📦 Uncategorized

• Fix WATCH_NAMESPACE typo in helm chart
  • PR: #86
• Set default bundle channel to stable. Set correct image annotation in bundle.
  • PR: #87
• Add explicit default cluster defenition with internal_replication=1 and generated cluster secret
  • PR: #89
• fix wrong value key and bad spacing
  • PR: #96
• Helmchart enhancements
  • PR: #97
• Collect all e2e test runs in single report
  • PR: #100
• Fix bool defaulting logic, make logToFile pointer to distinguish false and not set
  • PR: #101
• Add crd-schema-checker to prevent backward incompatible changes
  • PR: #102
• Generate api reference
  • PR: #105
• fix rows.Err handling in commands
  • PR: #107
• chore add rows.Err check in tests
  • PR: #108
• Bump go.opentelemetry.io/otel/sdk from 1.39.0 to 1.40.0
  • PR: #109
• Add grant option to default user
  • PR: #110
• feat: Add configurable PodDisruptionBudget to ClickHouseCluster CRD
  • PR: #104
• Fix spec modification issue, add spec fuzzing tests. Relax default anti-affinity rules.
  • PR: #113
• support pre-release kubeversion
  • PR: #114
• Add server version in the Status. Add warnings on replica version divergence.
  • PR: #116
• Unify replica resources logic. Delete Pod in error state if STS stuck
  • PR: #117
• chore: make error and log messages more consistent, use query parameters, bump ch version for tests, pin e2e k8s version, add action linter
  • PR: #121
• feat: Add version upgrade availability checks
  • PR: #120

Install using the manifest

kubectl apply -f https://github.com/ClickHouse/clickhouse-operator/releases/download/v0.0.2/clickhouse-operator.yaml

Install using helmchart

helm install clickhouse-operator oci://ghcr.io/clickhouse/clickhouse-operator-helm \
   --version=0.0.2 \
   --create-namespace \
   -n clickhouse-operator-system

Changelog

📦 Uncategorized

• Lower kubernetes version to v1.30+
  • PR: #64
• chore: Fix Go mod to be correct
  • PR: #67
• Remove commit status checks and minor README changes
  • PR: #72
• fix: correct array index in logger toFields to prevent panic
  • PR: #69
• fix: use correct separator for container image digest references
  • PR: #70
• fix: add nil checks before dereferencing Shards pointers in webhook
  • PR: #71
• Bump github.com/cert-manager/cert-manager from 1.19.2 to 1.19.3
  • PR: #73
• Add Pod and Container security context overrides
  • PR: #74
• feat: add clusterDomain field to support custom Kubernetes DNS domains
  • PR: #77
• Adjust default health probes paramenters. Fix clickhouse liveness probe
  • PR: #78
• Add default AccessModes to data disk. Allow custom data disk mounts.
  • PR: #79
• fix: helm chart use wrong values field for manager container security…
  • PR: #80
• Add build information to manger
  • PR: #81
• Support all installModes, selection of watched namespaces
  • PR: #83
• Upgrade go version to 1.26, upgrade dependecies and fix usage of recently deprecated APIs
  • PR: #84
• Minimal k8s version
  • PR: #85