base on Altinity Kubernetes Operator for ClickHouse creates, configures and manages ClickHouse® clusters running on Kubernetes # Altinity Kubernetes Operator for ClickHouse® Altinity Kubernetes Operator for ClickHouse creates, configures and manages ClickHouse clusters running on Kubernetes. [](https://github.com/Altinity/clickhouse-operator/actions/workflows/build_master.yaml) [](https://img.shields.io/github/v/release/altinity/clickhouse-operator?include_prereleases) [](https://github.com/altinity/clickhouse-operator/tags) [](https://hub.docker.com/r/altinity/clickhouse-operator) [](https://img.shields.io/github/go-mod/go-version/altinity/clickhouse-operator) [](https://goreportcard.com/report/github.com/altinity/clickhouse-operator) [](https://github.com/altinity/clickhouse-operator/issues) <a href="https://altinity.com/slack"> <img src="https://img.shields.io/static/v1?logo=slack&logoColor=959DA5&label=Slack&labelColor=333a41&message=join%20conversation&color=3AC358" alt="AltinityDB Slack" /> </a> ## 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.19+ * ClickHouse 21.11+. For older ClickHouse versions use operator 0.23.7 or earlier. ## Documentation [Quick Start Guide][quick_start_guide] **Advanced configuration** * [Detailed Operator Installation Instructions][detailed_installation_instructions] * [Operator Configuration][operator_configuration] * [Setup ClickHouse cluster with replication][replication_setup] * [Setting up Zookeeper][zookeeper_setup] * [Persistent Storage Configuration][storage_configuration] * [Security Hardening][security_hardening] * [ClickHouse Installation Custom Resource specification][crd_explained] **Maintenance tasks** * [Add replication to an existing ClickHouse cluster][update_cluster_add_replication] * [Schema maintenance][schema_migration] * [Update ClickHouse version][update_clickhouse_version] * [Update Operator version][update_operator] **Monitoring** * [Setup Monitoring][monitoring_setup] * [Prometheus & clickhouse-operator integration][prometheus_setup] * [Grafana & Prometheus integration][grafana_setup] **How to contribute** * [How to contribute/submit a patch][contributing_manual] * [How to easy development process with devspace.sh][devspace_manual] --- * [Documentation index][all_docs_list] --- ## License Copyright (c) 2019-2023, Altinity Inc and/or its affiliates. All rights reserved. Altinity Kubernetes Operator for ClickHouse is licensed under the Apache License 2.0. See [LICENSE](./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](https://altinity.com/) - Get a high level overview of Altinity and our offerings. - [Altinity.Cloud](https://altinity.com/cloud-database/) - Run ClickHouse in our cloud or yours. - [Altinity Support](https://altinity.com/support/) - Get Enterprise-class support for ClickHouse. - [Slack](https://altinity.com/slack) - Talk directly with ClickHouse users and Altinity devs. - [Contact us](https://hubs.la/Q020sH3Z0) - Contact Altinity with your questions or issues. - [Free consultation](https://hubs.la/Q020sHkv0) - Get a free consultation with a ClickHouse expert today. [chi_max_yaml]: ./docs/chi-examples/99-clickhouseinstallation-max.yaml [intro]: ./docs/introduction.md [quick_start_guide]: ./docs/quick_start.md [detailed_installation_instructions]: ./docs/operator_installation_details.md [replication_setup]: ./docs/replication_setup.md [crd_explained]: ./docs/custom_resource_explained.md [zookeeper_setup]: ./docs/zookeeper_setup.md [monitoring_setup]: ./docs/monitoring_setup.md [prometheus_setup]: ./docs/prometheus_setup.md [grafana_setup]: ./docs/grafana_setup.md [storage_configuration]: ./docs/storage.md [update_cluster_add_replication]: ./docs/chi_update_add_replication.md [update_clickhouse_version]: ./docs/chi_update_clickhouse_version.md [update_operator]: ./docs/operator_upgrade.md [schema_migration]: ./docs/schema_migration.md [operator_configuration]: ./docs/operator_configuration.md [contributing_manual]: ./CONTRIBUTING.md [devspace_manual]: ./docs/devspace.md [all_docs_list]: ./docs/README.md [security_hardening]: ./docs/security_hardening.md ", Assign "at most 3 tags" to the expected json: {"id":"8557","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"