Merge pull request #339 from molliezhang/main

docs/rancher *: Add docs about deploy radondb mysql on rancher #338
radondb · Dec 28, 2021 · d55025a · d55025a
2 parents e7d8f16 + 6432971
commit d55025a
Show file tree

Hide file tree

Showing 10 changed files with 252 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -34,7 +34,8 @@ RadonDB MySQL Kubernetes supports deployment and management of RaodnDB MySQL clu
 
 ### Operator
 
-- [Deploy RadonDB MySQL on Kubernetes](docs/kubernetes/deploy_radondb-mysql_operator_on_k8s.md)
+- [Deploy RadonDB MySQL on Kubernetes](/docs/kubernetes/deploy_radondb-mysql_operator_on_k8s.md)
+- [Deploy RadonDB MySQL on Rancher](/docs/rancher/deploy_radondb-mysql_operator_on_rancher.md)
 
 ## Roadmap
 

diff --git a/README_zh.md b/README_zh.md
@@ -35,6 +35,7 @@ RadonDB MySQL Kubernetes支持在[Kubernetes](https://kubernetes.io)和[KubeSphe
 ### Operator
 
 - [在 Kubernetes 上部署 RadonDB MySQL 集群](docs/kubernetes/deploy_radondb-mysql_operator_on_k8s.md)
+- [在 Rancher 上部署 RadonDB MySQL 集群](/docs/rancher/deploy_radondb-mysql_operator_on_rancher.md)
 
 ## 路线图
 

diff --git a/docs/rancher/_images/helm_options.png b/docs/rancher/_images/helm_options.png
diff --git a/docs/rancher/_images/import_yaml.png b/docs/rancher/_images/import_yaml.png
diff --git a/docs/rancher/_images/kubectl_command.png b/docs/rancher/_images/kubectl_command.png
diff --git a/docs/rancher/_images/mysql_operator_chart.png b/docs/rancher/_images/mysql_operator_chart.png
diff --git a/docs/rancher/_images/mysql_operator_metadata.png b/docs/rancher/_images/mysql_operator_metadata.png
diff --git a/docs/rancher/_images/mysql_operator_values.png b/docs/rancher/_images/mysql_operator_values.png
diff --git a/docs/rancher/_images/pod_running.png b/docs/rancher/_images/pod_running.png
diff --git a/docs/rancher/deploy_radondb-mysql_operator_on_rancher.md b/docs/rancher/deploy_radondb-mysql_operator_on_rancher.md
@@ -0,0 +1,249 @@
+Contents
+=============
+
+   * [在 Rancher 上部署 RadonDB MySQL 集群](#在-rancher-上部署-radondb-mysql-集群)
+      * [简介](#简介)
+      * [部署准备](#部署准备)
+      * [部署步骤](#部署步骤)
+         * [步骤 1：添加 Helm 仓库](#步骤-1-添加-helm-仓库)
+         * [步骤 2：部署 Operator](#步骤-2-部署-operator)
+         * [步骤 3：部署 RadonDB MySQL 集群](#步骤-3-部署-radondb-mysql-集群)
+         * [部署校验](#部署校验)
+      * [访问 RadonDB MySQL](#访问-radondb-mysql)
+      * [配置](#配置)
+         * [容器配置](#容器配置)
+         * [节点配置](#节点配置)
+         * [持久化配置](#持久化配置)
+
+# 在 Rancher 上部署 RadonDB MySQL 集群(Operator)
+
+## 简介
+
+RadonDB MySQL 是一款基于 MySQL 的开源、高可用、云原生集群解决方案。支持一主多从高可用架构，并具备安全、自动备份、监控告警、自动扩容等全套管理功能。目前已经在生产环境中大规模的使用，包含**银行、保险、传统大企业**等。
+
+RadonDB MySQL 支持在 Rancher 上安装部署和管理，自动执行与运行 RadonDB MySQL 集群有关的任务。
+
+本教程主要演示如何在 Rancher 上部署 RadonDB MySQL Operator 和 RadonDB MySQL 集群。
+
+## 部署准备
+
+- 已[部署 Rancher 集群](https://rancher.com/docs/rancher/v2.6/en/quick-start-guide/deployment/quickstart-manual-setup/)，并已获取 Rancher 管理控制台登录账号和密码。
+
+## 部署步骤
+
+### 步骤 1: 添加 Helm 仓库
+
+1. 登录 Rancher 管理控制台。
+2. 点击目标集群，进入集群管理页面。
+3. 选择 **App&Marketplace** > **Repositories**，进入应用仓库管理页面。
+4. 点击 **Create**，配置 RadonDB MySQL 仓库。
+
+   -**Name**：自定义仓库名称。
+
+   -**Target**：可选择 http(s) 方式，配置 **Index URL** 为 `https://radondb.github.io/radondb-mysql-kubernetes/`。
+
+5. 点击 **Create**，返回仓库管理页面。
+
+   当仓库 **State** 切换为 `Active`，则添加仓库正常运行。
+
+### 步骤 2: 部署 Operator
+
+一个 Rancher 集群仅需部署一次 RadonDB MySQL Operator。
+
+1. 在集群管理页面，选择 **App&Marketplace** > **Charts**，进入 Charts 列表页面。
+2. 找到 **mysql-operator**，部署 Operator 页面。
+
+   可选择 mysql-operator Charts 版本。
+
+   ![Charts](_images/mysql_operator_chart.png)
+
+3. 点击 **Install**，配置应用基本信息。
+
+   可勾选自定义 Helm 选项。
+
+   ![Metadata](_images/mysql_operator_metadata.png)
+
+4. （可选）点击 **Next**，自定义编辑应用 YAML。
+
+   ![Values](_images/mysql_operator_values.png)
+
+5. 点击 **Next**，配置部署属性。
+
+   ![Helm Options](_images/helm_options.png)
+
+6. 点击 **Install**，跳转到 **Installed App** 管理页面。
+
+   可在列表下方窗口，查看安装进度和状态。当应用部署完成后，可在列表查看到已安装的应用。
+
+### 步骤 3: 部署 RadonDB MySQL 集群
+
+#### 通过命令方式
+
+1. 在集群管理页面，点击右上角 Kubectl 命令图标。
+
+   ![Kubectl 命令窗口](_images/kubectl_command.png)
+
+2. 在命令窗口，输入创建集群命令。
+
+   如下示例为部署一个三节点的样例集群。
+
+   ```shell
+   # Run kubectl commands inside here
+   # e.g. kubectl get all
+   $ cat <<EOF | kubectl apply -f-
+   apiVersion: mysql.radondb.com/v1alpha1
+   kind: MysqlCluster
+   metadata:
+      name: sample
+   spec:
+      replicas: 3
+   EOF
+   ```
+
+3. 回车执行命令，回显提示 `created` 则部署成功。
+
+   预期回显信息示例：
+
+   ```shell
+   mysqlcluster.mysql.radondb.com/sample created
+   ```
+
+#### 通过导入 YAML 方式
+
+1. 下载 [RadonDB MySQL 集群配置样例](/config/samples/mysql_v1alpha1_mysqlcluster.yaml)，修改 YAML 文件中配置参数值。
+
+   详细配置参数说明，请参见[配置](#配置)。
+
+2. 在 Rancher 集群管理页面，点击右上角 YAML 导入图标。在弹出的窗口中，导入修改后的 YAML 文件。
+
+   ![Import YAML](_images/import_yaml.png)
+
+### 部署验证
+
+1. 在集群管理页面，选择 **Service Discovery** > **Service**，进入服务列表页面。
+2. 找到部署的集群，查看服务状态。
+   
+   状态为 `Active`，表示服务正常运行。
+
+3. 点击服务名称，进入服务详情页面，查看 Pod 状态。
+
+   状态为 `Active`，表示 Pod 正常运行。
+
+4. 在正在运行的 Pod 行，点击 Execute Shell，展开 Pod 命令窗口。
+   
+   执行如下命令并输入密码，验证数据库连接状态。
+
+   ```shell
+   $ mysql -u root -p
+   ```
+
+   正常连接数据库回显信息如下图：
+
+   ![Pod Running](_images/pod_running.png)
+
+## 访问 RadonDB MySQL
+
+> **注意**
+> 
+> 准备可用于连接 MySQL 的客户端。
+
+- 当客户端与数据库部署在不同 Rancher 集群，请[在 Rancher 中设置 Load Balancer 和 Ingress Controller](https://rancher.com/docs/rancher/v2.6/en/k8s-in-rancher/load-balancers-and-ingress/)。
+  
+  更多访问不同集群中数据库方式说明，请参见 [Kubernetes 访问集群中的应用程序](https://kubernetes.io/zh/docs/tasks/access-application-cluster/)。
+
+- 当客户端与数据库部署在同一 Rancher 集群内，可选择使用 `service_name` 或者 `clusterIP` 方式，访问 RadonDB MySQL。
+  
+   > **说明**
+   > 
+   > RadonDB MySQL 提供 leader 服务和 follower 服务用于分别访问主从节点。leader 服务始终指向主节点（读写），follower 服务始终指向从节点（只读）。
+
+以下为客户端与数据库在同一 Rancher 集群内，访问 RadonDB MySQL 的方式。
+
+### `service_name` 方式
+
+* 连接 leader 服务(RadonDB MySQL 主节点)
+
+    ```shell
+    $ mysql -h <leader_service_name>.<namespace> -u <user_name> -p
+    ```
+
+   用户名为 `radondb_usr`，release 名为 `sample`，RadonDB MySQL 命名空间为 `default` ，连接示例如下：
+
+    ```shell
+    $ mysql -h sample-leader.default -u radondb_usr -p
+    ```
+
+* 连接 follower 服务(RadonDB MySQL 从节点)
+
+    ```shell
+    $ mysql -h <follower_service_name>.<namespace> -u <user_name> -p
+    ```
+
+   用户名为 `radondb_usr`，release 名为 `sample`，RadonDB MySQL 命名空间为 `default` ，连接示例如下：
+
+    ```shell
+    $ mysql -h sample-follower.default -u radondb_usr -p  
+    ```
+
+### `clusterIP` 方式
+
+RadonDB MySQL 的高可用读写 IP 指向 leader 服务的 `clusterIP`，高可用只读 IP 指向 follower 服务的 `clusterIP`。
+
+```shell
+$ mysql -h <clusterIP> -P <mysql_Port> -u <user_name> -p
+```
+
+以下示例用户名为 `radondb_usr`， leader 服务的 clusterIP 为 `10.10.128.136` ，连接示例如下：
+
+```shell
+$ mysql -h 10.10.128.136 -P 3306 -u radondb_usr -p
+```
+
+## 配置
+
+### 容器配置
+
+| 参数                               | 描述                        | 默认值                                                      |
+| :--------------------------------- | :-------------------------- | :---------------------------------------------------------- |
+| MysqlVersion                       | MySQL 版本号                | 5.7                                                         |
+| MysqlOpts.RootPassword             | MySQL Root 用户密码         | ""                                                          |
+| MysqlOpts.User                     | 默认新建的 MySQL 用户名称   | radondb_usr                                                 |
+| MysqlOpts.Password                 | 默认新建的 MySQL 用户密码   | RadonDB@123                                                 |
+| MysqlOpts.Database                 | 默认新建的 MySQL 数据库名称 | radondb                                                     |
+| MysqlOpts.InitTokuDB               | 是否启用TokuDB              | true                                                        |
+| MysqlOpts.MysqlConf                | MySQL 配置                  | -                                                           |
+| MysqlOpts.Resources                | MySQL 容器配额              | 预留: cpu 100m, 内存 256Mi; </br> 限制: cpu 500m, 内存 1Gi  |
+| XenonOpts.Image                    | xenon(高可用组件)镜像       | radondb/xenon:1.1.5-alpha                                   |
+| XenonOpts.AdmitDefeatHearbeatCount | 允许的最大心跳检测失败次数  | 5                                                           |
+| XenonOpts.ElectionTimeout          | 选举超时时间(单位为毫秒)    | 10000ms                                                     |
+| XenonOpts.Resources                | xenon 容器配额              | 预留: cpu 50m, 内存 128Mi; </br> 限制: cpu 100m, 内存 256Mi |
+| MetricsOpts.Enabled                | 是否启用 Metrics(监控)容器  | false                                                       |
+| MetricsOpts.Image                  | Metrics 容器镜像        | prom/mysqld-exporter:v0.12.1                                |
+| MetricsOpts.Resources              | Metrics 容器配额            | 预留: cpu 10m, 内存 32Mi; </br> 限制: cpu 100m, 内存 128Mi  |
+
+### 节点配置
+
+| 参数                        | 描述                                             | 默认值                    |
+| :-------------------------- | :----------------------------------------------- | :------------------------ |
+| Replicas                    | 集群节点数，只允许为0、2、3、5                   | 3                         |
+| PodPolicy.ImagePullPolicy   | 镜像拉取策略, 只允许为 Always/IfNotPresent/Never | IfNotPresent              |
+| PodPolicy.Labels            | 节点 pod [标签](https://kubernetes.io/zh/docs/concepts/overview/working-with-objects/labels/))                         | -                         |
+| PodPolicy.Annotations       | 节点 pod [注解](https://kubernetes.io/zh/docs/concepts/overview/working-with-objects/annotations/)                         | -                         |
+| PodPolicy.Affinity          | 节点 pod [亲和性](https://kubernetes.io/zh/docs/concepts/scheduling-eviction/assign-pod-node/#%E4%BA%B2%E5%92%8C%E6%80%A7%E4%B8%8E%E5%8F%8D%E4%BA%B2%E5%92%8C%E6%80%A7)                     | -                         |
+| PodPolicy.PriorityClassName | 节点 pod [优先级](https://kubernetes.io/zh/docs/concepts/configuration/pod-priority-preemption/)对象名称             | -                         |
+| PodPolicy.Tolerations       | 节点 pod [污点容忍度](https://kubernetes.io/zh/docs/concepts/scheduling-eviction/taint-and-toleration/)列表               | -                         |
+| PodPolicy.SchedulerName     | 节点 pod [调度器](https://kubernetes.io/zh/docs/concepts/scheduling-eviction/kube-scheduler/)名称                 | -                         |
+| PodPolicy.ExtraResources    | 节点容器配额（除 MySQL 和 Xenon 之外的容器）     | 预留: cpu 10m, 内存 32Mi  |
+| PodPolicy.SidecarImage      | Sidecar 镜像                                     | radondb/mysql-sidecar:latest |
+| PodPolicy.BusyboxImage      | Busybox 镜像                                     | busybox:1.32              |
+| PodPolicy.SlowLogTail       | 是否开启慢日志跟踪                               | false                     |
+| PodPolicy.AuditLogTail      | 是否开启审计日志跟踪                             | false                     |
+
+### 持久化配置
+
+| 参数                     | 描述           | 默认值        |
+| :----------------------- | :------------- | :------------ |
+| Persistence.Enabled      | 是否启用持久化 | true          |
+| Persistence.AccessModes  | 存储卷访问模式 | ReadWriteOnce |
+| Persistence.StorageClass | 存储卷类型     | -             |
+| Persistence.Size         | 存储卷容量     | 10Gi          |