zh: add enterprise usage (#529)

* add enterprise usage * address comments * address comments * address comments * add tidb-binlog enterprise image
pingcap · Jul 7, 2020 · b431c13 · b431c13
1 parent dd8ecf4
commit b431c13
Show file tree

Hide file tree

Showing 8 changed files with 111 additions and 1 deletion.
diff --git a/zh/deploy-on-alibaba-cloud.md b/zh/deploy-on-alibaba-cloud.md
@@ -214,6 +214,20 @@ category: how-to
 
     根据实际情况修改 `replicas`。
 
+    值得注意的是，如果需要部署企业版的 TiDB/PD/TiKV/TiFlash/TiCDC，需要将 db.yaml 中 `spec.<tidb/pd/tikv/tiflash/ticdc>.baseImage` 配置为企业版镜像，格式为 `pingcap/<tidb/pd/tikv/tiflash/ticdc>-enterprise`。
+
+    例如:
+
+    ```yaml
+    spec:
+      ...
+      pd:
+        baseImage: pingcap/pd-enterprise
+      ...
+      tikv:
+        baseImage: pingcap/tikv-enterprise
+    ```
+
     > **注意：**
     >
     > * 请使用 ACK 部署过程中配置的 `tidb_cluster_name` 替换 `db.yaml` 和 `db-monitor.yaml` 文件中所有的 `TIDB_CLUSTER_NAME`。

diff --git a/zh/deploy-on-aws-eks.md b/zh/deploy-on-aws-eks.md
@@ -228,7 +228,7 @@ region = us-west-21
     ```yaml
     spec:
       ...
-      tiflash:
+      ticdc:
         baseImage: pingcap/ticdc
         nodeSelector:
           dedicated: CLUSTER_NAME-cdc
@@ -242,6 +242,20 @@ region = us-west-21
 
     根据实际情况修改 `replicas`。
 
+    值得注意的是，如果需要部署企业版的 TiDB/PD/TiKV/TiFlash/TiCDC，需要将 db.yaml 中 `spec.<tidb/pd/tikv/tiflash/ticdc>.baseImage` 配置为企业版镜像，格式为 `pingcap/<tidb/pd/tikv/tiflash/ticdc>-enterprise`。
+
+    例如:
+
+    ```yaml
+    spec:
+      ...
+      pd:
+        baseImage: pingcap/pd-enterprise
+      ...
+      tikv:
+        baseImage: pingcap/tikv-enterprise
+    ```
+
     > **注意：**
     >
     > * 请使用 EKS 部署过程中配置的 `default_cluster_name` 替换 `db.yaml` 和 `db-monitor.yaml` 文件中所有的 `CLUSTER_NAME`。

diff --git a/zh/deploy-on-gcp-gke.md b/zh/deploy-on-gcp-gke.md
@@ -180,6 +180,20 @@ Terraform 自动加载和填充匹配 `terraform.tfvars` 或 `*.auto.tfvars` 文
 
     参考 [API 文档](https://github.com/pingcap/tidb-operator/blob/master/docs/api-references/docs.md)和[集群配置文档](configure-cluster-using-tidbcluster.md)完成 CR 文件配置。
 
+    值得注意的是，如果需要部署企业版的 TiDB/PD/TiKV，需要将 db.yaml 中 `spec.<tidb/pd/tikv>.baseImage` 配置为企业版镜像，格式为 `pingcap/<tidb/pd/tikv>-enterprise`。
+
+    例如:
+
+    ```yaml
+    spec:
+      ...
+      pd:
+        baseImage: pingcap/pd-enterprise
+      ...
+      tikv:
+        baseImage: pingcap/tikv-enterprise
+    ```
+
     > **注意：**
     >
     > * 请确保 GKE 部署过程中 PD、TiKV 或者 TiDB 节点的数量的值，与 `db.yaml` 中对应组件的 `replicas` 字段值一致。注意 Regional 集群下，实际创建的节点数为 pd_count/tikv_count/tidb_count 的 3 倍。

diff --git a/zh/deploy-on-general-kubernetes.md b/zh/deploy-on-general-kubernetes.md
@@ -83,6 +83,20 @@ TiFlash 支持挂载多个 PV，如果要为 TiFlash 配置多个 PV，可以在
       logLevel: info
 ```
 
+值得注意的是，如果需要部署企业版的 TiDB/PD/TiKV/TiFlash/TiCDC，需要将 db.yaml 中 `spec.<tidb/pd/tikv/tiflash/ticdc>.baseImage` 配置为企业版镜像，格式为 `pingcap/<tidb/pd/tikv/tiflash/ticdc>-enterprise`。
+
+例如:
+
+```yaml
+spec:
+  ...
+  pd:
+    baseImage: pingcap/pd-enterprise
+  ...
+  tikv:
+    baseImage: pingcap/tikv-enterprise
+```
+
 如果要部署 TiDB 集群监控，请参考 TidbMonitor [示例](https://github.com/pingcap/tidb-operator/blob/master/manifests/monitor/tidb-monitor.yaml)和 [API 文档](https://github.com/pingcap/tidb-operator/blob/master/docs/api-references/docs.md)（示例和 API 文档请切换到当前使用的 TiDB Operator 版本）完成 TidbMonitor CR，并保存到文件 `${cluster_name}/tidb-monitor.yaml`。
 
 ### 存储类型

diff --git a/zh/deploy-ticdc.md b/zh/deploy-ticdc.md
@@ -35,6 +35,16 @@ category: how-to
         replicas: 3
     ```
 
+   值得注意的是，如果需要部署企业版的 TiCDC，需要将 db.yaml 中 `spec.ticdc.baseImage` 配置为企业版镜像，格式为 `pingcap/ticdc-enterprise`。
+
+   例如:
+
+   ```yaml
+   spec:
+     ticdc:
+       baseImage: pingcap/ticdc-enterprise
+   ```
+
 3. 部署完成后，通过 `kubectl exec` 进入任意一个 TiCDC Pod 进行操作。
 
     {{< copyable "shell-regular" >}}

diff --git a/zh/deploy-tidb-binlog.md b/zh/deploy-tidb-binlog.md
@@ -40,6 +40,16 @@ spec
 
 按照集群实际情况修改 `version`、`replicas`、`storageClassName`、`requests.storage` 等配置。
 
+值得注意的是，如果需要部署企业版的 Pump，需要将 上述 yaml 中 `spec.pump.baseImage` 配置为企业版镜像，格式为 `pingcap/tidb-binlog-enterprise`。
+
+例如:
+
+```yaml
+spec:
+ pump:
+   baseImage: pingcap/tidb-binlog-enterprise
+```
+
 如果在生产环境中开启 TiDB Binlog，建议为 TiDB 与 Pump 组件设置亲和性和反亲和性。如果在内网测试环境中尝试使用开启 TiDB Binlog，可以跳过此步。
 
 默认情况下，TiDB 和 Pump 的 affinity 亲和性设置为 `{}`。由于目前 Pump 组件与 TiDB 组件默认并非一一对应，当启用 TiDB Binlog 时，如果 Pump 与 TiDB 组件分开部署并出现网络隔离，而且 TiDB 组件还开启了 `ignore-error`，则会导致 TiDB 丢失 Binlog。推荐通过亲和性特性将 TiDB 组件与 Pump 部署在同一台 Node 上，同时通过反亲和性特性将 Pump 分散在不同的 Node 上，每台 Node 上至多仅需一个 Pump 实例。
@@ -164,6 +174,7 @@ spec
     ```yaml
     clusterName: example-tidb
     clusterVersion: v3.0.0
+    baseImage: pingcap/tidb-binlog
     storageClassName: local-storage
     storage: 10Gi
     config: |
@@ -186,6 +197,17 @@ spec
 
     有关完整的配置详细信息，请参阅 [Kubernetes 上的 TiDB Binlog Drainer 配置](configure-tidb-binlog-drainer.md)。
 
+    值得注意的是，如果需要部署企业版的 Drainer，需要将 上述 yaml 中 `baseImage` 配置为企业版镜像，格式为 `pingcap/tidb-binlog-enterprise`。
+
+    例如:
+
+    ```yaml
+    ...
+    clusterVersion: v4.0.2
+    baseImage: pingcap/tidb-binlog-enterprise
+    ...
+    ```
+
 4. 部署 drainer：
 
     {{< copyable "shell-regular" >}}

diff --git a/zh/deploy-tiflash.md b/zh/deploy-tiflash.md
@@ -41,6 +41,16 @@ spec:
       storageClassName: local-storage
 ```
 
+值得注意的是，如果需要部署企业版的 TiFlash，需要将 db.yaml 中 `spec.tiflash.baseImage` 配置为企业版镜像，格式为 `pingcap/tiflash-enterprise`。
+
+例如:
+
+```yaml
+spec:
+  tiflash:
+    baseImage: pingcap/tiflash-enterprise
+```
+
 TiFlash 支持挂载多个 PV，如果要为 TiFlash 配置多个 PV，可以在 `tiflash.storageClaims` 下面配置多项，每一项可以分别配置 `storage reqeust` 和 `storageClassName`，例如：
 
 ```yaml

diff --git a/zh/upgrade-a-tidb-cluster.md b/zh/upgrade-a-tidb-cluster.md
@@ -45,6 +45,12 @@ category: how-to
 
     当所有 Pod 都重建完毕进入 `Running` 状态后，升级完成。
 
+> **注意：**
+>
+> 如果需要升级到企业版，需要将 db.yaml 中 `spec.<tidb/pd/tikv/tiflash/ticdc/pump>.baseImage` 配置为企业版镜像，格式为 `pingcap/<tidb/pd/tikv/tiflash/ticdc/tidb-binlog>-enterprise`。
+>
+> 例如将 `spec.pd.baseImage` 从 `pingcap/pd` 修改为 `pingcap/pd-enterprise`。
+
 ### 强制升级 TiDB 集群
 
 如果 PD 集群因为 PD 配置错误、PD 镜像 tag 错误、NodeAffinity 等原因不可用，[TiDB 集群扩缩容](scale-a-tidb-cluster.md)、[升级 TiDB 版本](#升级-tidb-版本)和更新 TiDB 集群配置这三种操作都无法成功执行。
@@ -95,6 +101,12 @@ kubectl annotate --overwrite tc ${cluster_name} -n ${namespace} tidb.pingcap.com
 
     当所有 Pod 都重建完毕进入 `Running` 状态后，升级完成。
 
+> **注意：**
+>
+> 如果需要升级到企业版，需要把 `<tidb/tikv/pd>.image` 的值改为企业版镜像。
+>
+> 例如将 `pd.image` 从 `pingcap/pd:v4.0.0` 修改为 `pingcap/pd-enterprise:v4.0.0`。
+
 ### 强制升级 TiDB 集群
 
 如果 PD 集群因为 PD 配置错误、PD 镜像 tag 错误、NodeAffinity 等原因不可用，[TiDB 集群扩缩容](scale-a-tidb-cluster.md)、[升级 TiDB 版本](#升级-tidb-版本)和更新 TiDB 集群配置这三种操作都无法成功执行。