README.md

Altinity Operator for ClickHouse

Operator 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

Requirements

• Kubernetes 1.15.11+

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
• 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-2023, Altinity Inc and/or its affiliates. All rights reserved.

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

See LICENSE for more details.