keevol/clickhouse-operator

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

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.

Features

The ClickHouse Operator for Kubernetes currently provides the following:

• Creates cluster of the ClickHouse database based on Custom Resource specification provided
• Supports Storage customization (VolumeClaim templates)
• Supports Pod template customization (Volume and Container templates)
• Supports ClickHouse configuration customization (including Zookeeper integration)
• Supports ClickHouse metrics export to Prometheus

Requirements

• Kubernetes 1.11.9+

Documentation

Quick Start Guide

Advanced setups

• Detailed Operator Installation Instructions
• ClickHouse Installation Custom Resource specification
• How to setup ClickHouse cluster with replication
• Zookeeper Setup
• Persistent Storage Configuration
• Update ClickHouseInstallation with Rolling Update - add replication to existing cluster
• Update ClickHouseInstallation with Rolling Update - update ClickHouse version

Monitoring

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

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.