diff --git a/README_zh.md b/README_zh.md index 7033b84b..cd290909 100644 --- a/README_zh.md +++ b/README_zh.md @@ -1,73 +1,122 @@ -![](docs/images/logo_radondb-mysql.png)
-[English](README.md) | 简体中文 +

+banner +

+

+面向云原生、容器化的数据库开源社区 +

-# 什么是RadonDB MySQL +

+A+ + + + + + +

-[RadonDB MySQL](https://github.com/radondb/radondb-mysql-kubernetes) 是基于 MySQL 的开源、高可用、云原生集群解决方案。支持一主多从高可用架构,并具备安全、自动备份、监控告警、自动扩容等全套管理功能。 +---- -## RadonDB MySQL Kubernetes +# 什么是 RadonDB MySQL -RadonDB MySQL Kubernetes支持在[Kubernetes](https://kubernetes.io)和[KubeSphere](https://kubesphere.com.cn)上安装部署和管理,自动执行与运行RadonDB MySQL集群有关的任务。 +**RadonDB MySQL** 是基于 MySQL 的开源、高可用、云原生集群解决方案。支持一主多从高可用架构,并具备安全、自动备份、监控告警、自动扩容等全套管理功能。 -## 架构图 +**RadonDB MySQL Kubernetes**支持在 [Kubernetes](https://kubernetes.io/) 、[KubeSphere](https://kubesphere.com.cn/) 和 [Rancher](https://rancher.com) 上安装部署和管理,自动执行与运行 RadonDB MySQL 集群有关的任务。 -- 通过 Raft 协议实现无中心化领导者自动选举 -- 通过 Semi-Sync基于GTID 模式同步数据 -- 通过 [Xenon](https://github.com/radondb/xenon.git) 提供高可用能力 +## 核心功能 +🧠 **MySQL 高可用**:无中心化自动选主、主从秒级切换、集群切换的数据强一致性 + -![](docs/images/radondb-mysql_Architecture.png) +✏️ **集群管理** -## 核心功能 +💻 [**监控告警**](docs/zh-cn/deploy_monitoring.md) -- MySQL 高可用 - - 无中心化自动选主 - - 主从秒级切换 - - 集群切换的数据强一致性 -- 集群管理 -- [监控告警](docs/zh-cn/deploy_monitoring.md) -- [备份](docs/zh-cn/deploy_backup_restore_s3.md) -- 集群日志管理 -- [账户管理](docs/zh-cn/mgt_mysqluser.md) +✍️ [**备份**](docs/zh-cn/deploy_backup_restore_s3.md) -## 快速开始 +🎈 **集群日志管理** -### Operator +👨 [**账户管理**](docs/zh-cn/mgt_mysqluser.md) -- [在 Kubernetes 上部署 RadonDB MySQL 集群](docs/zh-cn/deploy_radondb-mysql_operator_on_k8s.md) -- [在 KubeSphere 上部署 RadonDB MySQL 集群](docs/zh-cn/deploy_radondb-mysql_operator_on_kubesphere.md) -- [在 Rancher 上部署 RadonDB MySQL 集群](/docs/zh-cn/deploy_radondb-mysql_operator_on_rancher.md) -## 路线图 +## 架构图 + +1、 通过 Raft 协议实现无中心化领导者自动选举 + +2、 通过 Semi-Sync基于GTID 模式同步数据 + +3、 通过 [Xenon](https://github.com/radondb/xenon.git) 提供高可用能力 + +

+banner +

+ +## 功能规划 | 版本 | 功能 | 实现方式 | |------|--------|------| | 3.0 | 自动化运维
多节点角色
灾备集群
SSL 传输加密 | Operator | -| 2.0 | 增删节点
自动扩缩容
升级集群
备份与恢复
故障自动转移
自动重建节点
自动重启服务
账户管理(提供 API 接口)
在线迁移 | Operator | +| 2.0 | 增删节点
升级集群
备份与恢复
故障自动转移
重建节点
账户管理 | Operator | | 1.0 | 集群管理
监控告警
集群日志管理
账户管理 | Helm | -## 用户案例 +# 快速开始 + +👀 本教程主要演示如何在 Kubernetes 上部署 RadonDB MySQL 集群(Operator)。 -![](docs/images/users.png) +## 部署准备 + +📦 已准备可用 Kubernetes 集群。 +## 部署步骤 + +### 步骤 1: 添加 Helm 仓库 + +```plain +helm repo add radondb https://radondb.github.io/radondb-mysql-kubernetes/ +``` +### 步骤 2: 部署 Operator + +以下指定 release 名为 `demo` , 创建一个名为 `demo-mysql-operator` 的 [Deployment](https://kubernetes.io/zh/docs/concepts/workloads/controllers/deployment/)。 + +```plain +helm install demo radondb/mysql-operator +``` +>**说明** +>在这一步骤中默认将同时创建集群所需的 [CRD](https://kubernetes.io/zh/docs/concepts/extend-kubernetes/api-extension/custom-resources/)。 + +### 步骤 3: 部署 RadonDB MySQL 集群 + +执行以下指令,以默认参数为 CRD `mysqlclusters.mysql.radondb.com` 创建一个实例,即创建 RadonDB MySQL 集群。您可参见[配置参数](https://./config_para.md)说明,自定义集群部署参数。 + +```plain +kubectl apply -f https://github.com/radondb/radondb-mysql-kubernetes/releases/latest/download/mysql_v1alpha1_mysqlcluster.yaml +``` + +## 操作视频 + +在 Kubernetes 上部署 RadonDB MySQL Operator 和 MySQL 集群,快速查看 👉 [Demo 视频](https://radondb.com/docs/mysql/v2.1.3/vadio/install/#content) + +📖 了解更多,请查看文档: + +* [在 Kubernetes 上部署 RadonDB MySQL 集群](https://github.com/radondb/radondb-mysql-kubernetes/blob/main/docs/zh-cn/deploy_radondb-mysql_operator_on_k8s.md) +* [在 KubeSphere 上部署 RadonDB MySQL 集群](https://github.com/radondb/radondb-mysql-kubernetes/blob/main/docs/zh-cn/deploy_radondb-mysql_operator_on_kubesphere.md) +* [在 Rancher 上部署 RadonDB MySQL 集群](https://github.com/radondb/radondb-mysql-kubernetes/blob/main/docs/zh-cn/deploy_radondb-mysql_operator_on_rancher.md) + +# 用户案例 + +![](docs/images/%E5%AE%A2%E6%88%B7%E6%A1%88%E4%BE%8B.png) ## 协议 -RadonDB MySQL 基于 Apache 2.0 协议,详见 [License](./LICENSE)。 +RadonDB MySQL 基于 Apache 2.0 协议,详见 [License](https://github.com/radondb/radondb-mysql-kubernetes/blob/main/LICENSE)。 -## 欢迎加入社区话题互动 +## 欢迎加入社区话题互动 ❤️ -- 论坛 +😊 社区官网:[https://radondb.com](https://radondb.com) - 请加入[KubeSphere 开发者社区](https://kubesphere.com.cn/forum/t/radondb) RadonDB MySQL 话题专区。 +😁 社区论坛:请加入 KubeSphere 开发者论坛 [RadonDB](https://kubesphere.com.cn/forum/t/RadonDB) 板块。 -- 欢迎关注微信公众号 +😆 社区公众号:RadonDB 开源社区 - ![](docs/images/vx_code_258.jpg) +🦉 社区微信群:请添加群助手 radondb 邀请进群 + +如有任何关于 RadonDB MySQL 的 Bug、问题或建议,请在 GitHub 提交 [issue](https://github.com/radondb/radondb-mysql-kubernetes/issues) 或[论坛](https://kubesphere.com.cn/forum/t/RadonDB)反馈。 ---- -

-

-如有任何关于 RadonDB MySQL 的问题或建议,请在 GitHub 或论坛提交 Issue 反馈。 -
- -

diff --git "a/docs/images/\345\256\242\346\210\267\346\241\210\344\276\213.png" "b/docs/images/\345\256\242\346\210\267\346\241\210\344\276\213.png" new file mode 100644 index 00000000..2929f162 Binary files /dev/null and "b/docs/images/\345\256\242\346\210\267\346\241\210\344\276\213.png" differ