ClickHouse Operator

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

Warning! ClickHouse Operator is in beta. You can use it at your own risk. There may be backwards incompatible API changes up until the first major release.

Release 0.3.0 is backward incompatible with 0.2.3 and earlier:

• Pod and volume templates are spec'ed slightly differently (now they correspond to Kubernetes API) -- check corresponding examples, those were updated to reflect the change.
• All managed objects have got the different naming approach, that includes installation and primary instances names.

Features

The ClickHouse Operator for Kubernetes currently provides the following:

• Creates ClickHouse cluster based on Custom Resource specification provided
• Storage customization (VolumeClaim templates)
• Pod template customization (Volume and Container templates)
• ClickHouse configuration customization (including Zookeeper integration)
• ClickHouse cluster scaling including automatic schema propagation
• ClickHouse cluster version upgrades
• Exporting ClickHouse metrics to Prometheus

Requirements

• Kubernetes 1.11.9+

Documentation

Quick Start Guide

Advanced setups

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

Maintenance tasks

• Add replication to an existing ClickHouse cluster
• Add shards and replicas
  • Automatic schema creation
• Update ClickHouse version
• Update Operator version

Monitoring

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

All docs

• All available docs list

License

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

clickhouse-operator is licensed under the Apache License 2.0.

See LICENSE for more details.