zh: Improve self-hosted k8s deployment (#804)

pingcap · Nov 11, 2020 · a169dc8 · a169dc8
1 parent 8162f28
commit a169dc8
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 18 deletions.
diff --git a/zh/configure-a-tidb-cluster.md b/zh/configure-a-tidb-cluster.md
@@ -72,7 +72,7 @@ aliases: ['/docs-cn/tidb-in-kubernetes/dev/configure-a-tidb-cluster/','/zh/tidb-
 
 > **注意：**
 >
-> 如果创建集群时设置了集群中不存在的存储类型，则会导致集群创建处于 Pending 状态，需要[将集群彻底销毁掉](destroy-a-tidb-cluster.md)。
+> 如果创建 TiDB 集群时设置了 Kubernetes 集群中不存在的存储类型，则会导致 TiDB 集群创建处于 Pending 状态，需要[将 TiDB 集群彻底销毁掉](destroy-a-tidb-cluster.md)，再进行重试。
 
 ### mountClusterClientSecret
 

diff --git a/zh/configure-storage-class.md b/zh/configure-storage-class.md
@@ -151,7 +151,7 @@ Kubernetes 当前支持静态分配的本地存储。可使用 [local-static-pro
 
 盘挂载完成后，需要根据上述磁盘挂载情况修改 [`local-volume-provisioner` yaml 文件](https://raw.githubusercontent.com/pingcap/tidb-operator/master/manifests/local-dind/local-volume-provisioner.yaml)，配置发现目录并创建必要的 `StorageClass`。以下是根据上述挂载修改的 yaml 文件示例：
 
-```
+```yaml
 apiVersion: storage.k8s.io/v1
 kind: StorageClass
 metadata:

diff --git a/zh/deploy-tidb-operator.md b/zh/deploy-tidb-operator.md
@@ -32,11 +32,9 @@ Kubernetes 集群建议启用 [RBAC](https://kubernetes.io/docs/admin/authorizat
 
 ## 配置本地持久化卷
 
-### 准备本地卷
-
 参考[本地 PV 配置](configure-storage-class.md#本地-pv-配置)在你的 Kubernetes 集群中配置本地持久化卷。
 
-## 安装 TiDB Operator
+## 部署 TiDB Operator
 
 ### 创建 CRD
 
@@ -76,13 +74,15 @@ tidbinitializers.pingcap.com         2020-06-11T07:59:42Z
 tidbmonitors.pingcap.com             2020-06-11T07:59:41Z
 ```
 
-### 安装 
+### 自定义部署 TiDB Operator
+
+若需要快速部署 TiDB Operator，可参考快速上手中[部署 TiDB Operator文档](get-started.md#部署-tidb-operator)。本节介绍自定义部署 TiDB Operator 的配置方式。
 
-创建以上各种自定义资源类型后，接下来在 Kubernetes 集群上安装 TiDB Operator，有两种安装方式：在线和离线安装 TiDB Operator。
+创建 CRDs 之后，在 Kubernetes 集群上部署 TiDB Operator有两种方式：在线和离线部署。
 
-#### 在线安装 TiDB Operator
+#### 在线部署 TiDB Operator
 
-1. 获取你要安装的 `tidb-operator` chart 中的 `values.yaml` 文件：
+1. 获取你要部署的 `tidb-operator` chart 中的 `values.yaml` 文件：
 
     {{< copyable "shell-regular" >}}
 
@@ -101,7 +101,7 @@ tidbmonitors.pingcap.com             2020-06-11T07:59:41Z
 
     其他项目例如：`limits`、`requests` 和 `replicas`，请根据需要进行修改。
 
-3. 安装 TiDB Operator
+3. 部署 TiDB Operator
 
     {{< copyable "shell-regular" >}}
 

diff --git a/zh/prerequisites.md b/zh/prerequisites.md
@@ -147,6 +147,8 @@ cpupower frequency-set --governor performance
 
 TiDB 集群默认会使用很多文件描述符，需要将工作节点上面的 `ulimit` 设置为大于等于 `1048576`：
 
+{{< copyable "shell-regular" >}}
+
 ```shell
 cat <<EOF >>  /etc/security/limits.conf
 root        soft        nofile        1048576
@@ -165,6 +167,8 @@ sysctl --system
 
 1. 将 Docker 的数据保存到一块单独的盘上，Docker 的数据主要包括镜像和容器日志数据。通过设置 [`--data-root`](https://docs.docker.com/config/daemon/systemd/#runtime-directory-and-storage-driver) 参数来实现：
 
+    {{< copyable "shell-regular" >}}
+
     ```shell
     cat > /etc/docker/daemon.json <<EOF
     {
@@ -181,23 +185,24 @@ sysctl --system
     }
     EOF
     ```
-   
+
     上面会将 Docker 的数据目录设置为 `/data1/docker`。
 
-2. 设置 Docker daemon 的 ulimit： 
+2. 设置 Docker daemon 的 ulimit。
+
+    编辑文件：
 
     {{< copyable "shell-regular" >}}
-    
+
     ```shell
     vim /etc/systemd/system/docker.service
-    LimitNOFILE=1048576
     ```
-    
-    设置 `LimitNOFILE` 大于等于 `1048576`。
-    
+
+    设置 `LimitNOFILE=1048576`，这里设置 `LimitNOFILE` 为大于等于 `1048576` 的数字即可。
+
     > **注意：**
     >
-    > `LimitNOFILE` 需要显式设置为 `1048576` 或者更大，而不是默认的 `infinity`，由于 `systemd` 的 [bug](https://github.com/systemd/systemd/commit/6385cb31ef443be3e0d6da5ea62a267a49174688#diff-108b33cf1bd0765d116dd401376ca356L1186)，`infinity` 在 `systemd` 某些版本中指的是 `65536`。
+    > `LimitNOFILE` 需要显式设置为 `1048576` 或者更大，而不是默认的 `infinity`，由于 [`systemd` 的 bug](https://github.com/systemd/systemd/commit/6385cb31ef443be3e0d6da5ea62a267a49174688#diff-108b33cf1bd0765d116dd401376ca356L1186)，`infinity` 在 `systemd` 某些版本中指的是 `65536`。
 
 ## Kubernetes 服务