{"id":13436213,"url":"https://github.com/Altinity/clickhouse-operator","last_synced_at":"2025-03-18T20:31:03.272Z","repository":{"id":37276480,"uuid":"165021340","full_name":"Altinity/clickhouse-operator","owner":"Altinity","description":"Altinity Kubernetes Operator for ClickHouse creates, configures and manages ClickHouse® clusters running on Kubernetes","archived":false,"fork":false,"pushed_at":"2025-03-14T10:22:26.000Z","size":50928,"stargazers_count":2038,"open_issues_count":138,"forks_count":469,"subscribers_count":25,"default_branch":"master","last_synced_at":"2025-03-14T11:27:24.394Z","etag":null,"topics":["clickhouse","clickhouse-operator","kubernetes","kubernetes-operator"],"latest_commit_sha":null,"homepage":"https://altinity.com","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Altinity.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"docs/security_hardening.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-01-10T08:30:43.000Z","updated_at":"2025-03-14T00:15:20.000Z","dependencies_parsed_at":"2023-11-06T10:25:33.536Z","dependency_job_id":"fb850cf5-dbf5-4548-b468-27f313184384","html_url":"https://github.com/Altinity/clickhouse-operator","commit_stats":{"total_commits":4893,"total_committers":80,"mean_commits":61.1625,"dds":"0.26936439811976287","last_synced_commit":"bbbf66a8e0fbbcf36b787a63eceeaca37e0ec272"},"previous_names":[],"tags_count":78,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Altinity%2Fclickhouse-operator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Altinity%2Fclickhouse-operator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Altinity%2Fclickhouse-operator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Altinity%2Fclickhouse-operator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Altinity","download_url":"https://codeload.github.com/Altinity/clickhouse-operator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244301347,"owners_count":20430925,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["clickhouse","clickhouse-operator","kubernetes","kubernetes-operator"],"created_at":"2024-07-31T03:00:45.558Z","updated_at":"2025-03-18T20:31:03.265Z","avatar_url":"https://github.com/Altinity.png","language":"Go","funding_links":[],"categories":["HarmonyOS","Go","Repository is obsolete","Databases","Integrations"],"sub_categories":["Windows Manager","Awesome Operators in the Wild","Other","Deployment and Management Tools"],"readme":"# Altinity Kubernetes Operator for ClickHouse®\n\nAltinity Kubernetes Operator for ClickHouse creates, configures and manages ClickHouse clusters running on Kubernetes.\n\n[![Build Master](https://github.com/Altinity/clickhouse-operator/actions/workflows/build_master.yaml/badge.svg)](https://github.com/Altinity/clickhouse-operator/actions/workflows/build_master.yaml)\n[![GitHub release](https://img.shields.io/github/v/release/altinity/clickhouse-operator?include_prereleases)](https://img.shields.io/github/v/release/altinity/clickhouse-operator?include_prereleases)\n[![tags](https://img.shields.io/github/tag/altinity/clickhouse-operator.svg)](https://github.com/altinity/clickhouse-operator/tags)\n[![Docker Pulls](https://img.shields.io/docker/pulls/altinity/clickhouse-operator.svg)](https://hub.docker.com/r/altinity/clickhouse-operator)\n[![Go version](https://img.shields.io/github/go-mod/go-version/altinity/clickhouse-operator)](https://img.shields.io/github/go-mod/go-version/altinity/clickhouse-operator)\n[![Go Report Card](https://goreportcard.com/badge/github.com/altinity/clickhouse-operator)](https://goreportcard.com/report/github.com/altinity/clickhouse-operator)\n[![issues](https://img.shields.io/github/issues/altinity/clickhouse-operator.svg)](https://github.com/altinity/clickhouse-operator/issues)\n\u003ca href=\"https://altinity.com/slack\"\u003e\n  \u003cimg src=\"https://img.shields.io/static/v1?logo=slack\u0026logoColor=959DA5\u0026label=Slack\u0026labelColor=333a41\u0026message=join%20conversation\u0026color=3AC358\" alt=\"AltinityDB Slack\" /\u003e\n\u003c/a\u003e\n\n## Features\n\n- Creates ClickHouse clusters defined as custom resources\n- Customized storage provisioning (VolumeClaim templates)\n- Customized pod templates\n- Customized service templates for endpoints\n- ClickHouse configuration management\n- ClickHouse users management\n- ClickHouse cluster scaling including automatic schema propagation\n- ClickHouse version upgrades\n- Exporting ClickHouse metrics to Prometheus\n\n## Community\n\nThe Altinity Kubernetes Operator for ClickHouse is a community effort sponsored by Altinity. The best way to reach us or ask questions is:\n\n* Join the [Altinity Slack](https://altinity.com/slack) - Chat with the developers and other users\n* Log an [issue on GitHub](https://github.com/Altinity/clickhouse-operator/issues) - Ask questions, log bugs and feature requests\n\n## Requirements\n\n * Kubernetes 1.19+\n * ClickHouse 21.11+. For older ClickHouse versions use operator 0.23.7 or earlier.\n \n## Documentation\n\n[Quick Start Guide][quick_start_guide]\n\n**Advanced configuration**\n * [Detailed Operator Installation Instructions][detailed_installation_instructions]\n   * [Operator Configuration][operator_configuration]\n * [Setup ClickHouse cluster with replication][replication_setup]\n   * [Setting up Zookeeper][zookeeper_setup]\n * [Persistent Storage Configuration][storage_configuration]\n * [Security Hardening][security_hardening]\n * [ClickHouse Installation Custom Resource specification][crd_explained]\n \n**Maintenance tasks**\n * [Add replication to an existing ClickHouse cluster][update_cluster_add_replication]\n * [Schema maintenance][schema_migration]\n * [Update ClickHouse version][update_clickhouse_version]\n * [Update Operator version][update_operator]\n\n**Monitoring**\n * [Setup Monitoring][monitoring_setup]\n * [Prometheus \u0026 clickhouse-operator integration][prometheus_setup]\n * [Grafana \u0026 Prometheus integration][grafana_setup]\n\n**How to contribute**\n * [How to contribute/submit a patch][contributing_manual]\n * [How to easy development process with devspace.sh][devspace_manual]\n \n---\n * [Documentation index][all_docs_list]\n---\n \n## License\n\nCopyright (c) 2019-2023, Altinity Inc and/or its affiliates. All rights reserved.\n\nAltinity Kubernetes Operator for ClickHouse is licensed under the Apache License 2.0.\n\nSee [LICENSE](./LICENSE) for more details.\n\n## Commercial Support\n\nAltinity is the primary maintainer of the operator. It is the basis of Altinity.Cloud and\nis also used in self-managed installations. Altinity offers a range of \nservices related to ClickHouse and analytic applications on Kubernetes. \n\n- [Official website](https://altinity.com/) - Get a high level overview of Altinity and our offerings.\n- [Altinity.Cloud](https://altinity.com/cloud-database/) - Run ClickHouse in our cloud or yours.\n- [Altinity Support](https://altinity.com/support/) - Get Enterprise-class support for ClickHouse.\n- [Slack](https://altinity.com/slack) - Talk directly with ClickHouse users and Altinity devs.\n- [Contact us](https://hubs.la/Q020sH3Z0) - Contact Altinity with your questions or issues.\n- [Free consultation](https://hubs.la/Q020sHkv0) - Get a free consultation with a ClickHouse expert today.\n \n[chi_max_yaml]: ./docs/chi-examples/99-clickhouseinstallation-max.yaml\n[intro]: ./docs/introduction.md\n[quick_start_guide]: ./docs/quick_start.md\n[detailed_installation_instructions]: ./docs/operator_installation_details.md\n[replication_setup]: ./docs/replication_setup.md\n[crd_explained]: ./docs/custom_resource_explained.md\n[zookeeper_setup]: ./docs/zookeeper_setup.md\n[monitoring_setup]: ./docs/monitoring_setup.md\n[prometheus_setup]: ./docs/prometheus_setup.md\n[grafana_setup]: ./docs/grafana_setup.md\n[storage_configuration]: ./docs/storage.md\n[update_cluster_add_replication]: ./docs/chi_update_add_replication.md\n[update_clickhouse_version]: ./docs/chi_update_clickhouse_version.md\n[update_operator]: ./docs/operator_upgrade.md\n[schema_migration]: ./docs/schema_migration.md\n[operator_configuration]: ./docs/operator_configuration.md\n[contributing_manual]: ./CONTRIBUTING.md\n[devspace_manual]: ./docs/devspace.md\n[all_docs_list]: ./docs/README.md\n[security_hardening]: ./docs/security_hardening.md\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAltinity%2Fclickhouse-operator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FAltinity%2Fclickhouse-operator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAltinity%2Fclickhouse-operator/lists"}