xjzrc/clickhouse-operator

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

ClickHouse Operator

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

Features

The ClickHouse Operator for Kubernetes currently provides the following:

• Creates ClickHouse clusters based on Custom Resource specification provided
• Customized storage provisioning (VolumeClaim templates)
• Customized pod templates
• Customized service templates for endpoints
• ClickHouse configuration and settings (including Zookeeper integration)
• Flexible templating
• ClickHouse cluster scaling including automatic schema propagation
• ClickHouse version upgrades
• Exporting ClickHouse metrics to Prometheus

Requirements

• Kubernetes 1.15.11+

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
• 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

---

All docs

• All available docs list

---

License

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

clickhouse-operator is licensed under the Apache License 2.0.

See LICENSE for more details.