-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs *: merge radondb-clickhouse-kubernetes docs
- Loading branch information
1 parent
d780677
commit bea664d
Showing
58 changed files
with
1,822 additions
and
207 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,10 @@ | ||
# Submitting your patch | ||
|
||
Thanks for taking the time to contribute to `clickhouse-operator`! | ||
Thanks for taking the time to contribute to `radondb-clickhouse-operator`! | ||
|
||
## Intro | ||
`clickhouse-operator` contribution process is built around standard git _Pull Requests_. | ||
|
||
`radondb-clickhouse-operator` contribution process is built around standard git _Pull Requests_. | ||
|
||
## How to make PR | ||
|
||
|
@@ -19,9 +19,9 @@ In case you'd like to introduce several features, make several PRs, please. | |
## Sign Your Work | ||
|
||
Every PR has to be signed. The sign-off is a text line at the end of the commit's text description. | ||
Your signature certifies that you wrote the patch or otherwise have the right to contribute it to `clickhouse-operator`. | ||
Your signature certifies that you wrote the patch or otherwise have the right to contribute it to `radondb-clickhouse-operator`. | ||
|
||
Developer Certificate of Origin is available at [developercertificate.org](https://developercertificate.org/): | ||
Developer Certificate of Origin is available at [developer certificate.org](https://developercertificate.org/): | ||
|
||
```text | ||
Version 1.1 | ||
|
@@ -72,7 +72,7 @@ If you set your `user.name` and `user.email` git configs, you can sign your comm | |
|
||
Your `git log` information for your commit should look something like this: | ||
|
||
``` | ||
```spain | ||
Author: John Doe <[email protected]> | ||
Date: Mon Jan 24 12:34:56 2020 +0200 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,87 +1,67 @@ | ||
# ClickHouse Operator | ||
# ![LOGO](docs/_images/logo_radondb.png) | ||
|
||
ClickHouse Operator creates, configures and manages ClickHouse clusters running on Kubernetes. | ||
> English | [简体中文](README_zh.md) | ||
[![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) | ||
[![CircleCI](https://circleci.com/gh/Altinity/clickhouse-operator.svg?style=svg)](https://circleci.com/gh/Altinity/clickhouse-operator) | ||
[![Docker Pulls](https://img.shields.io/docker/pulls/altinity/clickhouse-operator.svg)](https://hub.docker.com/r/altinity/clickhouse-operator) | ||
[![Go Report Card](https://goreportcard.com/badge/github.com/altinity/clickhouse-operator)](https://goreportcard.com/report/github.com/altinity/clickhouse-operator) | ||
[![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) | ||
[![issues](https://img.shields.io/github/issues/altinity/clickhouse-operator.svg)](https://github.com/altinity/clickhouse-operator/issues) | ||
[![tags](https://img.shields.io/github/tag/altinity/clickhouse-operator.svg)](https://github.com/altinity/clickhouse-operator/tags) | ||
## What is RadonDB ClickHouse | ||
|
||
## Features | ||
ClickHouse is a column-oriented database management system (DBMS) for online analytical processing of queries (OLAP). | ||
|
||
The ClickHouse Operator for Kubernetes currently provides the following: | ||
RadonDB ClickHouse is an open-source, cloud-native, highly availability cluster solutions based on [ClickHouse](https://clickhouse.tech/) and [ClickHouse Operator](https://github.com/Altinity/clickhouse-operator). | ||
|
||
[RadonDB ClickHouse Operator](https://github.com/radondb/radondb-clickhouse-operator) is committed to creating ClickHouse clusters on Kubernetes quickly and easily. RadonDB ClickHouse Operator supports [Kubernetes 1.15.11+](https://kubernetes.io), [KubeSphere 3.1.x](https://kubesphere.com.cn), [Rancher](https://rancher.com/), [OpenShift](https://www.redhat.com/en) and other container platforms to deploy, configure and manage RadonDB ClickHouse clusters. | ||
|
||
## Architecture | ||
|
||
![Architecture](docs/_images/arch.png) | ||
|
||
## Main Features | ||
|
||
The RadonDB ClickHouse Operator for Kubernetes currently provides the following: | ||
|
||
- Creates ClickHouse clusters based on Custom Resource [specification][chi_max_yaml] 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 | ||
- Multiple customization and custom configuration templates available | ||
|
||
## Requirements | ||
|
||
* Kubernetes 1.15.11+ | ||
|
||
## Documentation | ||
|
||
[Quick Start Guide][quick_start_guide] | ||
|
||
**Advanced setups** | ||
* [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] | ||
* [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] | ||
|
||
--- | ||
**All docs** | ||
* [All available docs list][all_docs_list] | ||
--- | ||
|
||
## License | ||
- Creates ClickHouse clusters based on Custom Resource [specification](docs/chi-examples/99-clickhouseinstallation-max.yaml) provided | ||
- Customized storage provisioning (VolumeClaim templates) | ||
- Customized pod templates | ||
- Customized service templates for endpoints | ||
- Flexible templating | ||
|
||
## Quick Start | ||
|
||
Copyright (c) 2019-2219, Altinity Ltd and/or its affiliates. All rights reserved. | ||
> On Kubernetes, we recommend you to install ClickHouse cluster through RadonDB ClickHouse Operator. | ||
`clickhouse-operator` is licensed under the Apache License 2.0. | ||
- [Quick Start](docs/quick_start.md) | ||
- [Installing RadonDB ClickHouse on KubeSphere](docs/en-us/deploy_radondb-clickhouse_with_operator_on_kubesphere_appstore.md) | ||
- [More Detailed Guidance](docs/README.md) | ||
|
||
## License | ||
|
||
RadonDB ClickHouse Operator is published under the Apache License 2.0. | ||
|
||
See [LICENSE](./LICENSE) for more details. | ||
|
||
[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 | ||
[all_docs_list]: ./docs/README.md | ||
[contributing_manual]: ./CONTRIBUTING.md | ||
|
||
## Discussion and Community | ||
|
||
- Contribution | ||
|
||
We welcome any kind of code contribution, some PR requirements can be found in [How to contribute/submit a patch](./CONTRIBUTING.md). | ||
|
||
- Forum | ||
|
||
The RadonDB ClickHouse topic is in [KubeSphere Community](https://kubesphere.com.cn/forum/t/radondb). | ||
|
||
- Please pay attention to our official account. | ||
|
||
![](docs/_images/vx_code_258.jpg) | ||
|
||
--- | ||
<p align="center"> | ||
<br/><br/> | ||
Please submit any RadonDB ClickHouse Operator bugs, issues, and feature requests to RadonDB MySQL GitHub Issue. | ||
<br/> | ||
</a> | ||
</p> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
# ![LOGO](docs/_images/logo_radondb.png) | ||
|
||
> [English](README.md) | 简体中文 | ||
---- | ||
|
||
## 什么是 RadonDB ClickHouse | ||
|
||
ClickHouse 是一个用于联机分析(OLAP)的列式数据库管理系统(DBMS)。 | ||
|
||
RadonDB ClickHouse 是一款基于 [ClickHouse](https://clickhouse.tech/) 和 [ClickHouse Operator](https://github.com/Altinity/clickhouse-operator) 的开源、高可用、云原生集群解决方案。[RadonDB ClickHouse Operator](https://github.com/radondb/radondb-clickhouse-operator) 致力于在 Kubernetes 上轻便快速创建 ClickHouse 集群。 | ||
|
||
RadonDB ClickHouse Operator 支持在 [Kubernetes 1.15.11+](https://kubernetes.io) 、[KubeSphere 3.1.x](https://kubesphere.com.cn) 、[Rancher](https://rancher.com/) 、[OpenShift](https://www.redhat.com/en) 等容器平台部署、配置和管理 RadonDB ClickHouse 集群。 | ||
|
||
## 架构图 | ||
|
||
![架构图](docs/_images/arch.png) | ||
|
||
## 特性功能 | ||
|
||
- 兼容 ClickHouse 配置,集成 ZooKeeper 组件 | ||
- 支持集群自动扩容 | ||
- 支持 ClickHouse 内核版本升级 | ||
- 满足 Prometheus 监控指标标准,支持第三方平台监控服务 | ||
- 提供多种定制和自定义配置模版 | ||
|
||
- 定制的资源配置模版 | ||
- 定制的存储配置(VolumeClaim)模版 | ||
- 定制的 Pod 配置模版 | ||
- 定制的终端服务配置模版 | ||
- 灵活的自定义配置模版 | ||
|
||
## 快速入门 | ||
|
||
> 当使用 Kubernetes 时,推荐您通过 RadonDB ClickHouse Operator 部署 ClickHouse 集群。 | ||
- [快速入门](docs/zh-cn/quick_start.md) | ||
- [在 KubeSphere 上部署 RadonDB ClickHouse](docs/zh-cn/deploy_radondb-clickhouse_with_operator_on_kubesphere_appstore.md) | ||
- [更多文档](docs/README.md) | ||
|
||
## 协议 | ||
|
||
RadonDB ClickHouse 基于 Apache 2.0 协议,详见 [LICENSE](./LICENSE)。 | ||
|
||
## 欢迎加入社区话题互动 | ||
|
||
- 贡献 | ||
|
||
我们欢迎任何形式代码贡献,一些提交 PR 要求请参见 [How to contribute/submit a patch](./CONTRIBUTING.md)。 | ||
|
||
- 论坛 | ||
|
||
请加入[KubeSphere 开发者社区](https://kubesphere.com.cn/forum/t/radondb) RadonDB ClickHouse 话题专区。 | ||
|
||
- 欢迎关注微信公众号 | ||
|
||
![](docs/_images/vx_code_258.jpg) | ||
|
||
|
||
<p align="center"> | ||
<br/><br/> | ||
如有任何关于 RadonDB ClickHouse Operator 的问题或建议,请在 GitHub 提交 Issue 反馈。 | ||
<br/> | ||
</a> | ||
</p> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,37 +1,44 @@ | ||
# Table of Contents | ||
|
||
## Quick Start: | ||
1. [quick_start.md](./quick_start.md) - quick start | ||
1. [introduction.md](./introduction.md) - general introduction | ||
## Introduction | ||
|
||
1. [general introduction](./introduction.md) | ||
2. [architecture overview](./architecture.md) | ||
3. [operator configuration in details](./operator_configuration.md) | ||
4. [Custom Resource Definition in details](./custom_resource_explained.md) | ||
5. [storage explained](./storage.md) | ||
|
||
## ClickHouse Operator: | ||
1. [operator_installation_details.md](./operator_installation_details.md) - how to install operator in details | ||
1. [operator_upgrade.md](./operator_upgrade.md) - how to upgrade operator to the different version | ||
1. [operator_configuration.md](./operator_configuration.md) - operator configuration in details | ||
1. [operator_build_from_sources.md](./operator_build_from_sources.md) - how to build operator from sources | ||
1. [custom_resource_explained.md](./custom_resource_explained.md) - explain Custom Resource Definition in details | ||
1. [clickhouse_config_errors_handling.md](./clickhouse_config_errors_handling.md) - how operator handles ClickHouse's config errors | ||
1. [architecture.md](./architecture.md) - architecture overview | ||
1. [schema_migration.md](./schema_migration.md) - how operator migrates schema during cluster resize | ||
## Quick Start | ||
|
||
1. [quick start](./quick_start.md) | ||
|
||
## ClickHouse Installation: | ||
1. [zookeeper_setup.md](./zookeeper_setup.md) - how to set up zookeeper | ||
1. [replication_setup.md](./replication_setup.md) - how to set up replication | ||
1. [chi_update_add_replication.md](./chi_update_add_replication.md) - how to add replication | ||
1. [chi_update_clickhouse_version.md](./chi_update_clickhouse_version.md) - how to update version | ||
1. [clickhouse_backup_and_restore.md](./clickhouse_backup_and_restore.md) - how to do backup and restore | ||
1. [storage.md](./storage.md) - storage explained | ||
## ClickHouse Operator | ||
|
||
1. [how to install operator in details](./operator_installation_details.md) | ||
2. [how to upgrade operator to the different version](./operator_upgrade.md) | ||
3. [how to build operator from sources](./operator_build_from_sources.md) | ||
4. [how operator handles ClickHouse's config errors](./clickhouse_config_errors_handling.md) | ||
5. [how operator migrates schema during cluster resize](./schema_migration.md) | ||
|
||
## ClickHouse Monitor: | ||
1. [monitoring_setup.md](./monitoring_setup.md) - how to set up monitoring | ||
1. [prometheus_setup.md](./prometheus_setup.md) - how to set up Prometheus | ||
1. [grafana_setup.md](./grafana_setup.md) - how to set up Grafana | ||
## ClickHouse Cluster | ||
|
||
## ClickHouse Backup: | ||
1. [clickhouse_backup_and_restore.md](./clickhouse_backup_and_restore.md) - how to backup / restore clickhouse cluster | ||
1. [how to set up zookeeper](./zookeeper_setup.md) | ||
2. [how to set up replication](./replication_setup.md) | ||
3. [how to add replication](./chi_update_add_replication.md) | ||
4. [how to update version](./chi_update_clickhouse_version.md) | ||
5. [how to do backup and restore](./clickhouse_backup_and_restore.md) | ||
|
||
## Others: | ||
1. [k8s_cluster_access.md](./k8s_cluster_access.md) - how to set up cluster access | ||
|
||
## ClickHouse Monitor | ||
|
||
1. [how to set up monitoring](./monitoring_setup.md) | ||
2. [how to set up Prometheus](./prometheus_setup.md) | ||
3. [how to set up Grafana](./grafana_setup.md) | ||
|
||
## ClickHouse Backup | ||
|
||
1. [how to backup / restore clickhouse cluster](./clickhouse_backup_and_restore.md) | ||
|
||
## Others | ||
|
||
1. [how to set up cluster access](./k8s_cluster_access.md) |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Oops, something went wrong.