clickhouse-operator

Altinity® Kubernetes Operator for ClickHouse®

The Altinity Kubernetes Operator for ClickHouse creates, configures and manages ClickHouse clusters running on Kubernetes.

Features

• Creates ClickHouse clusters defined as custom resources
• Customized storage provisioning (VolumeClaim templates)
• Customized pod templates
• Customized service templates for endpoints
• ClickHouse configuration management
• ClickHouse users management
• ClickHouse cluster scaling including automatic schema propagation
• ClickHouse version upgrades
• Exporting ClickHouse metrics to Prometheus
• FIPS 140-3 compatible operator + metrics-exporter images (GOFIPS140=v1.0.0, GODEBUG=fips140=on by default) — see Security Hardening for the FIPS scope, prerequisites, and opt-in strict mode. An optional ACVP responder (NIST cryptographic validation protocol) is available via -tags acvp_wrapper builds; see pkg/util/fips/acvp/README.md.

Community

The Altinity Kubernetes Operator for ClickHouse is a community effort sponsored by Altinity. The best way to reach us or ask questions is:

• Join the Altinity Slack - Chat with the developers and other users
• Log an issue on GitHub - Ask questions, log bugs and feature requests

Requirements

• Kubernetes 1.25+
• ClickHouse 21.11+. For older ClickHouse versions use operator 0.23.7 or earlier.

Documentation

Quick Start Guide

Advanced configuration

• Detailed Operator Installation Instructions
  • Operator Configuration
• Setup ClickHouse cluster with replication
  • Setting up Zookeeper
• Persistent Storage Configuration
• Security Hardening
• FIPS configuration
• ClickHouse Installation Custom Resource specification

Maintenance tasks

• Add replication to an existing ClickHouse cluster
• Schema maintenance
• Update ClickHouse version
• Update Operator version

Monitoring

• Setup Monitoring
• Prometheus & clickhouse-operator integration
• Grafana & Prometheus integration

How to contribute

• How to contribute/submit a patch
• How to easy development process with devspace.sh

• Documentation index

License

Copyright (c) 2019-2025, Altinity Inc and/or its affiliates. All rights reserved.

Altinity Kubernetes Operator for ClickHouse is licensed under the Apache License 2.0.

See LICENSE for more details.

Commercial Support

Altinity is the primary maintainer of the operator. It is the basis of Altinity.Cloud and is also used in self-managed installations. Altinity offers a range of services related to ClickHouse and analytic applications on Kubernetes.

• Official website - Get a high level overview of Altinity and our offerings.
• Altinity.Cloud - Run ClickHouse in our cloud or yours.
• Altinity Support - Get Enterprise-class support for ClickHouse.
• Slack - Talk directly with ClickHouse users and Altinity devs.
• Contact us - Contact Altinity with your questions or issues.
• Free consultation - Get a free consultation with a ClickHouse expert today.