apecloud · michelle-0808 · Mar 5, 2024 · Mar 4, 2024 · Mar 5, 2024 · Mar 5, 2024
@@ -121,6 +121,7 @@ spec:
     datafile:                         # 数据文件备份，依赖备份工具
       backupToolName: oracle-mysql-xtrabackup
 ```
+
 如果启用了定时任务，KubeBlocks 会在后台创建一个 CronJob。
 
 在一个新的集群创建后，KubeBlocks 会通过 `clusterdefinition.kubeblocks.io/name` 标签来查找对应的 template 名，并创建相应的 BackupPolicy。
@@ -151,7 +152,7 @@ spec:
 
 `BackTool.yml` 用来描述备份工具的具体执行逻辑，主要服务于文件备份（datafile）。它包括：
 
-1. 备份工具 image；
+1. 备份工具镜像；
 2. backup 的脚本；
 3. restore 的脚本。
 

@@ -112,19 +112,21 @@ sidebar_label: 添加数据库引擎
   - `name` [必填]
 
     即组件名称。这个名称没有特定标准，选择一个易区分有表达力的名字就可以。
-    
+
     如果我们将拓扑、版本和资源解耦（就像数据库中的 table normalize 一样），我们不仅可以让每一个对象描述的信息都更清晰和聚焦, 而且还可以通过这些对象的组合来生成更丰富的集群。因此，我们可以将 Cluster 表示为
 
-    $$Cluster = ClusterDefinition.yaml \Join ClusterVersion.yaml \Join ...$$
+    $$
+    Cluster = ClusterDefinition.yaml \Join ClusterVersion.yaml \Join ...
+    $$
 
     这个 `name` 就是那个join key。
-    
+
     记住这个 `name`，后面要考的。
 
   - `characterType` [选填]
 
     `characterType` 是一个字符串类型，用来识别这是一个什么引擎，例如 `mysql`、`postgresql`、`redis` 等。它主要用于数据库连接，在操作数据库时，它能快速识别引擎类型，找到匹配的操作命令。
-    
+
     它可以是一个任意的字符串，或者你也可以给你的引擎起一个独特的名称。前期我们没有数据库引擎相关的操作，因此也可以空缺。
 
   - `workloadType` [必填]
@@ -135,7 +137,7 @@ sidebar_label: 添加数据库引擎
     - Consensus，有状态服务，且有自选举能力，有角色。
 
     之后我们会更深入地介绍 Workload（包括设计、实现、如何使用等）。
-    
+
     因为这里使用的是 MySQL 单机版，因此使用 `Stateful` 就足够了。
 
   - `service` [选填]
@@ -149,9 +151,9 @@ sidebar_label: 添加数据库引擎
     ```
 
     它定义如何为该组件创建一个 Service，暴露哪些端口。
-    
+
     还记得 `connectionCredential` 中介绍的，集群对外暴露的 port 和 endpoint 吗？ 
-    
+
     通过 `$(SVC_PORT_mysql)$` 来选择端口，`mysql` 就是这里的 `service.ports[0].name` mysql。
 
     :::note
@@ -191,15 +193,15 @@ sidebar_label: 添加数据库引擎
     ```
 
     这里定义了只包含一个 container 的 Pod，即 `mysql-container`，以及所需的环境变量、端口等常规信息。
-    
+
     我们从名为 `$(CONN_CREDENTIAL_SECRET_NAME)` 的 secret 中获取用户名和密码作为 pod environment variable。
 
     这是一个 placeholder, 用来指代前文中提到的 Connection credential Secret。
 
 - `clusterVersion.yaml`
 
    所有版本相关的信息都配置在 `clusterVersion.yaml` 中。
-   
+
    现在可以为每一个 Component 需要的每一个 container 补充 image 信息。
 
    ```yaml
@@ -333,7 +335,7 @@ spec:
 
 然后通过 `chartsImage` 来配置你的 Helm chart 远端仓库地址。
 
-## 步骤 4. 发布到 Kubeblocks 社区（可选）
+## 步骤 4. （可选）发布到 Kubeblocks 社区
 
 你可以将 Helm chart 贡献给 [KubeBlocks add-ons](https://github.com/apecloud/kubeblocks-addons)，将 `addon.yaml` 贡献给 [KubeBlocks](https://github.com/apecloud/kubeblocks)。
 

@@ -35,7 +35,6 @@ KubeBlocks 通过 ***Go Template*** 来渲染参数模版，除了常见函数
 
 KubeBlocks 具有强大的渲染能力，能让你快速定制一个 ***自适应参数模板***（Adaptive ConfigTemplate），根据上下文（例如内存、CPU 大小）来渲染合适的配置文件。
 
-
 ### 添加参数模板
 
 ```yaml
@@ -70,12 +69,14 @@ KubeBlocks 具有强大的渲染能力，能让你快速定制一个 ***自适
 
 上面展示了一个通过 ConfigMap 定义的 MySQL 自适应参数模板。模板中配置了几个常见的 MySQL 参数，包括 `port`，`innodb_buffer_pool_size` 等。
 它根据容器启动时配置的 memory，
+
 - 计算得到 `innodb_buffer_size` 大小（Line 11 ~ Line 15）。
 - 在 memory 小于 8Gi 时，禁用 `performance_schema` 来减少对性能的影响（Line 19 ~ Line 21）。
 
 `callBufferSizeByResource` 是 KubeBlocks 预定义的一个 bufferPool 计算规则，主要为 MySQL 服务。
 
 此外，你也可以通过查询 memory 和 cpu 来定制你的计算公式：
+
 - `getContainerMemory` 获取 Pod 上某个 container 的 memory 大小。
 - `getContainerCPU` 获取 Pod 中某个 container 的 CPU 大小。
 
@@ -93,6 +94,7 @@ KubeBlocks 具有强大的渲染能力，能让你快速定制一个 ***自适
 #### 修改 ClusterDefinition
 
 可以通过 `ClusterDefinition` 中的 `configSpecs` 来指定参数模板，引用在[添加参数模板](#添加参数模板)中定义的 ConfigMap。
+
 ```yaml
   componentDefs:
     - name: mysql-compdef
@@ -113,7 +115,7 @@ KubeBlocks 具有强大的渲染能力，能让你快速定制一个 ***自适
             ...
 ```
 
-如上所示，需要通过添加 `configSpecs` 字段（Line 3 ~ 7）修改 `ClusterDefinition.yaml` 文件，分别指定：
+如上所示，需要通过添加 `configSpecs` 字段修改 `ClusterDefinition.yaml` 文件，分别指定：
 
 - templateRef: 模板所在的 ConfigMap 对象名称。
 - volumeName: 挂载到 Pod 的卷名。
@@ -172,7 +174,8 @@ K8s 会将 ConfigMap 的变更定时同步到 Pod 上，但是大部分引擎并
 
 还记得我们对 cluster 的定义吗，它可以表示为：
 
-$$Cluster = ClusterDefinition.yaml \Join ClusterVersion.yaml \Join Cluster.yaml
+$$
+Cluster = ClusterDefinition.yaml \Join ClusterVersion.yaml \Join Cluster.yaml
 $$
 
 其中 JoinKey 就是 Component Name。

@@ -13,7 +13,9 @@ import TabItem from '@theme/TabItem';
 
 本文档展示如何创建并连接到一个 Redis 集群。
 
-KubeBlocks 支持 Redis 单机版和 Redis 主备版集群。为了提供更好的高可用性体验，KubeBlocks 默认创建的是 Redis 主备版集群。
+KubeBlocks 支持 Redis 单机版和 Redis 主备版集群。
+
+为了提供更好的高可用性体验，KubeBlocks 默认创建的是 Redis 主备版集群。
 
 ## 创建 Redis 集群
 

@@ -62,11 +62,13 @@ AlertManager 集成了一组通知渠道，例如电子邮件和 Slack。KubeBlo
 **步骤**
 
 1. 配置告警渠道。
-请参考以下指南配置告警渠道。
-     - [飞书自定义机器人](https://open.feishu.cn/document/ukTMukTMukTM/ucTM5YjL3ETO24yNxkjN)
-     - [钉钉自定义机器人](https://open.dingtalk.com/document/orgapp/custom-robot-access)
-     - [企业微信自定义机器人](https://developer.work.weixin.qq.com/document/path/91770)
-     - [Slack](https://api.slack.com/messaging/webhooks)
+
+   请参考以下指南配置告警渠道。
+
+   - [飞书自定义机器人](https://open.feishu.cn/document/ukTMukTMukTM/ucTM5YjL3ETO24yNxkjN)
+   - [钉钉自定义机器人](https://open.dingtalk.com/document/orgapp/custom-robot-access)
+   - [企业微信自定义机器人](https://developer.work.weixin.qq.com/document/path/91770)
+   - [Slack](https://api.slack.com/messaging/webhooks)
 
 :::note
 
@@ -76,7 +78,7 @@ AlertManager 集成了一组通知渠道，例如电子邮件和 Slack。KubeBlo
 :::
 
 2. 配置接收者。
-   
+
    为了提高易用性，`kbcli` 开发了 `alert` 子命令来简化接收者的配置。你可以通过 `alert` 子命令设置通知渠道和接收者。该命令还支持过滤集群名称和严重程度级别。配置成功后即会动态生效，无需重启服务。
 
    1. 添加告警接收者。
@@ -86,7 +88,7 @@ AlertManager 集成了一组通知渠道，例如电子邮件和 Slack。KubeBlo
       ```
 
       ***示例***
-      
+
       下面以飞书为例，展示如何添加接收者。请注意，下述命令中的 webhook 地址仅为示例，请使用真实的 webhook 地址替换。
 
       ```bash

@@ -118,15 +118,15 @@ Kubeblocks 提供了主流引擎的 Grafana 仪表盘和 Prometheus 告警规则
     kbcli cluster create mysql <clustername> 
     ```
 
-    :::note
+:::note
 
-    你可以将 `--monitoring-interval` 设置为 `0` 以关闭监控功能（不建议关闭）。
+你可以将 `--monitoring-interval` 设置为 `0` 以关闭监控功能（不建议关闭）。
 
-    ```bash
-    kbcli cluster create mysql mycluster --monitoring-interval=0
-    ```
+```bash
+kbcli cluster create mysql mycluster --monitoring-interval=0
+```
 
-    :::
+:::
 
 - 对于已禁用监控功能的集群，可以使用 `update` 子命令启用监控功能。