Altinity Kubernetes Operator for ClickHouse® Release Notes

The latest release of the Altinity Kubernetes Operator for ClickHouse® is always available at https://github.com/Altinity/clickhouse-operator/releases/latest. Links to release notes for older releases follow the notes for the current release.

Release 0.24.4

Released 2025-02-06

Full Changelog: release-0.24.3...release-0.24.4

Fixed

Worked around a bug in docker entrypoint.sh introduced by ClickHouse change ClickHouse/ClickHouse#75259. Closes #1631.

Release 0.24.3

Released 2025-01-27

Full Changelog: release-0.24.2...release-0.24.3

Added

Ability to suspend ClickHouseInstallation and ClickHouseKeeper reconciliation by @a7i in #1580. Controlled by .spec.suspend attribute. Closes #1433.
New clickhouse_operator_chi metric in metrics-exporter
Add kafka-related alerts by @Slach in #1596

Changed

NormalizedCHI that is used to plan reconciliation was moved from CHI status to a separate configmap object. Closes #1444.
Changed a way ClickHouse is restarted in order to pickup server configuration change. Instead of pod re-creation it tries SYSTEM SHUTDOWN first. That speeds things up on nodes with big volumes, since those should not be re-attached.
Unused fields ‘HostsUnchanged’ and ‘HostsDelete’ were removed from extended status output
Upgrade prometheus-operator to 0.79.0 (alerts tested with prometheus 3.0.1) by @Slach in #1599
Interserver secret is now used for ‘all-sharded’ cluster if it is defined for the main cluster

Fixed

Custom ZK path creation is not retried anymore for stopped CHI
Fixed CVE-2024-45338 in golang.org/x/net 0.23.0

New Contributors

@a7i made their first contribution in #1580

Release 0.24.2

Released 2024-12-06

Full Changelog: https://github.com/Altinity/clickhouse-operator/compare/release-0.24.1...release-0.24.2

Changed

Inherit kubectl annotations when managing statefulsets by @ondrej-smola in #1582. That allows to avoid unexpected restarts
Remove openSSL from /etc/clickhouse-keeper/config.d/01-keeper-01-default-config.xml by @Slach in #1574
Faster startup of big clusters

Fixed

Fix helm chart release 0.24.2 - #1584, thanks @janeklb

Release 0.24.1

Released 2024-12-06

Full Changelog: release-0.24.0...release-0.24.1

Added

Option to exclude certain labels/annotations from exposed prometheus metrics. Closes #1525

Changed

Removed SYSTEM DROP DNS cache that is not needed since ClickHouse 19.11
Removed redundant synchronization between threads when multiple shards were reconciled in parallel. That speeds up reconcile of big clusters
Action log in CHI/CHK status is disabled by default
When custom (Zoo)Keeper path is used, operator will re-try path creation until (Zoo)Keeper is available
Improved Keeper scale out/in logic
Respect PVC storage value if current value is greater than value in spec by @ondrej-smola in #1573
Update zookeeper deployment examples to 3.8.4 by @Slach in #1553

Fixed

fix: fix slice init length by @cuishuang in #1523
fix: don’t b64 encode configmap data by @marvinWolff in #1540
fix helm chart release publication in #1589

Helm and docs

Doc : Add OpenEBS example by @lorellalou in #1527
Hotfix volumeClaimTemplate linking in chk-examples by @Slach in #1543
fix helm chart’s README by @janeklb in #1555
Hotfix chk crd, add {chk} and {chkID} to .spec.templates.serviceTemplates.generatedName description by @Slach in #1562
fix: add missing CRD link to helm chart readme by @janeklb in #1563
Docs: fix version to match manifests in chi-examples/08-* by @xavierleune in #1566
Add chk image pull secrets example by @Slach in #1576

New contributors

@lorellalou made their first contribution in #1527
@marvinWolff made their first contribution in #1540
@janeklb made their first contribution in #1555
@xavierleune made their first contribution in #1566
@ondrej-smola made their first contribution in #1572

Release 0.24.0

Released 2024-10-14

Full Changelog: https://github.com/Altinity/clickhouse-operator/compare/release-0.23.7...release-0.24.0

Backward Incompatible Changes

ClickHouseKeeper support has been fully re-written. It is now fully compatible with CHI in syntax and supported functionality that closes multiple issues discovered by early adopters. The downside is that CHK resources created by operator 0.23.x will loose the storage and change service name due to different naming conventions. See CHK upgrade instructions from 0.23 to 0.24 for the details. This closes #1504, #1497, #1469, #1465, #1459, #1408, #1362, #1296

Added

Added ‘pdbMaxUnavailable’ attribute to the cluster to manage PDB behavior. See 01-simple-layout-03-multiple-clusters-pdb-spec.yaml
Added ‘all-clusters’ cluster into auto-generated remote_servers.xml that references multiple clusters in CHI with respect to shards and replicas. by @tanner-bruce in https://github.com/Altinity/clickhouse-operator/pull/1409

Changed

Operator will now create zookeeper root path if specified in CHI configuration. Previously it assumed root path already exists.
Operator now waits for the last host to be included in the cluster before marking CHI as completed
Update helm chart to allow add pod labels by @bruno-s-coelho in https://github.com/Altinity/clickhouse-operator/pull/1359. Closes #1356
Support install operator from local template by @orloffv in https://github.com/Altinity/clickhouse-operator/pull/1401
Added prometheus zeros init for reconciliation metrics by @nmiculinic in https://github.com/Altinity/clickhouse-operator/pull/1398
Update helm chart to allow adding topologySpreadConstraints by @naturalett in https://github.com/Altinity/clickhouse-operator/pull/1462
Use ConfigMap instead of Secret for grafana dashboards by @cwrau in https://github.com/Altinity/clickhouse-operator/pull/1457
Altinity_ClickHouse_Operator_dashboard.json: dashboard has been updated by @nmiakushina in https://github.com/Altinity/clickhouse-operator/pull/1512 and https://github.com/Altinity/clickhouse-operator/pull/1515

Fixed

Fixed hostAliases in podTemplate by @chengjoey in https://github.com/Altinity/clickhouse-operator/pull/1453. Closes #1445
Fix install zookeeper operator by @realyota in https://github.com/Altinity/clickhouse-operator/pull/1437
Fix custom hostAliases do not take effect in sts by @chengjoey in https://github.com/Altinity/clickhouse-operator/pull/1453
Fixed ClickHouseKeeper dashboard templates/queries by @ja14000 in https://github.com/Altinity/clickhouse-operator/pull/1481

New Contributors

@vitaliyf made their first contribution in https://github.com/Altinity/clickhouse-operator/pull/1365
@kam1kaze made their first contribution in https://github.com/Altinity/clickhouse-operator/pull/1366
@orloffv made their first contribution in https://github.com/Altinity/clickhouse-operator/pull/1401
@nmiculinic made their first contribution in https://github.com/Altinity/clickhouse-operator/pull/1398
@tanner-bruce made their first contribution in https://github.com/Altinity/clickhouse-operator/pull/1409
@holycheater made their first contribution in https://github.com/Altinity/clickhouse-operator/pull/1430
@chengjoey made their first contribution in https://github.com/Altinity/clickhouse-operator/pull/1453
@cwrau made their first contribution in https://github.com/Altinity/clickhouse-operator/pull/1457
@AlexandrKhabarov made their first contribution in https://github.com/Altinity/clickhouse-operator/pull/1460
@naturalett made their first contribution in https://github.com/Altinity/clickhouse-operator/pull/1462
@ja14000 made their first contribution in https://github.com/Altinity/clickhouse-operator/pull/1481
@jirislav made their first contribution in https://github.com/Altinity/clickhouse-operator/pull/1470
@p-wall made their first contribution in https://github.com/Altinity/clickhouse-operator/pull/1511
@nmiakushina made their first contribution in https://github.com/Altinity/clickhouse-operator/pull/1512

Older releases

Details of all releases, including older releases, are available through the project’s Releases page.