Skip to content

Commit

Permalink
v3.0, dev/how-to/maintain: fix wording in kubernetes doc (#1607)
Browse files Browse the repository at this point in the history
* v3.0, dev/how-to/maintain: fix wording in kubernetes doc

* improved language

* update Daemonset description
  • Loading branch information
TomShawn authored and lilin90 committed Jul 12, 2019
1 parent 028a751 commit b758194
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 20 deletions.
26 changes: 16 additions & 10 deletions dev/how-to/maintain/tidb-in-kubernetes/tidb-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,21 +19,27 @@ chartVersion="v1.0.0-beta.3"

在 GKE 上,本地 SSD 卷默认大小限制为 375 GB,性能比永久性磁盘要差。

为提高性能,你必须保证以下两点
为提高性能,必须保证以下两点

* 安装 Linux Guest Environment,只能用于 Ubuntu 系统,不能用于 COS
* 安装 Linux Guest Environment,只能用于 Ubuntu 系统,不能用于 Container-Optimized OS
* 确保 SSD 挂载选项中包含 `nobarrier`

我们提供一个解决上述问题的 [Daemonset](https://raw.githubusercontent.com/pingcap/tidb-operator/master/manifests/gke/local-ssd-optimize.yaml)。还提供一个解决上述性能问题并且将多块 SSD 盘配置成一个 LVM 的
[Daemonset](https://raw.githubusercontent.com/pingcap/tidb-operator/master/manifests/gke/local-ssd-provision/local-ssd-provision.yaml)。通过 Terraform 部署的时候会自动安装。
TiDB 提供的 [Daemonset](https://raw.githubusercontent.com/pingcap/tidb-operator/master/manifests/gke/local-ssd-provision/local-ssd-provision.yaml) 能够:

+ 解决性能问题
+ 使用 UUID 重新安装本地 SSD 磁盘,以提高安全性
+ 在 Ubuntu 上使用 LVM 工具将所有本地 SSD 磁盘组合成一个大磁盘
+ 运行 local-volume-provisioner

terraform 部署将自动安装该 Daemonset。

> **注意:**
>
> 整合多块本地 SSD 盘的部署方式假设一个虚拟机上只有一个进程需要使用本地 SSD。
> 整合多块本地 SSD 盘的部署方式。假设一个虚拟机上只有一个进程,则需要使用本地 SSD。
## 配置

Helm 安装完成后,通过下面命令获取要安装的 tidb-cluster chart 的 `values.yaml` 配置文件:
Helm 安装完成后,通过下面命令获取待安装的 tidb-cluster chart 的 `values.yaml` 配置文件:

{{< copyable "shell-regular" >}}

Expand All @@ -44,7 +50,7 @@ helm inspect values pingcap/tidb-cluster --version=${chartVersion} > /home/tidb/

> **注意:**
>
> `/home/tidb` 可以替换为你想用的目录下文会用 `values.yaml` 指代 `/home/tidb/${releaseName}/values-${releaseName}.yaml`
> `/home/tidb` 可以替换为你想用的目录下文会用 `values.yaml` 指代 `/home/tidb/${releaseName}/values-${releaseName}.yaml`
有关配置信息请参考 [TiDB 集群部署配置文档](/reference/configuration/tidb-in-kubernetes/cluster-configuration.md)

Expand All @@ -68,15 +74,15 @@ kubectl get po -n ${namespace} -l app.kubernetes.io/instance=${releaseName}

## 访问 TiDB 集群

默认情况下,TiDB 服务通过 [`NodePort`](https://kubernetes.io/docs/concepts/services-networking/service/#nodeport) 暴露。可以通过修改为 `ClusterIP` 禁止集群外访问或者如果 Kubernetes 集群支持,可以修改为 [`LoadBalancer`](https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer) 对外暴露服务。
默认情况下,TiDB 服务通过 [`NodePort`](https://kubernetes.io/docs/concepts/services-networking/service/#nodeport) 暴露。可以通过修改为 `ClusterIP` 禁止集群外访问。如果 Kubernetes 集群支持,可以修改为 [`LoadBalancer`](https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer) 对外暴露服务。

{{< copyable "shell-regular" >}}

``` shell
kubectl get svc -n ${namespace}
```

TiDB 集群默认没有设置 root 密码。在 Helm 中设置密码不安全,你可以在 `values.yaml` 中给 `tidb.passwordSecretName` 设置一个 K8s secret。注意,这仅用于初始化用户:一旦 TiDB 集群初始化完成,你可以删除这个 secret。secret 的格式为 `user=password`你可以通过下面命令设置 root 用户密码:
TiDB 集群默认没有设置 root 密码。在 Helm 中设置密码不安全,因此可以在 `values.yaml` 中给 `tidb.passwordSecretName` 设置一个 K8s secret。注意,这仅用于初始化用户:一旦 TiDB 集群初始化完成,你可以删除这个 secret。secret 的格式为 `user=password`你可以通过下面命令设置 root 用户密码:

{{< copyable "shell-regular" >}}

Expand Down Expand Up @@ -124,7 +130,7 @@ echo ${PASSWORD}

## TiDB 集群伸缩

TiDB Operator 支持垂直和水平伸缩。存储的垂直伸缩需要注意以下各项
TiDB Operator 支持垂直和水平伸缩。存储的垂直伸缩需要注意以下事项

* 使用 Kubernetes v1.11 或者更高版本,请参考[官方博客](https://kubernetes.io/blog/2018/07/12/resizing-persistent-volumes-using-kubernetes/)
* 后端 StorageClass 支持调整大小(目前只有少数几个网络 StorageClass 支持调整大小)。
Expand Down
26 changes: 16 additions & 10 deletions v3.0/how-to/maintain/tidb-in-kubernetes/tidb-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,21 +19,27 @@ chartVersion="v1.0.0-beta.3"

在 GKE 上,本地 SSD 卷默认大小限制为 375 GB,性能比永久性磁盘要差。

为提高性能,你必须保证以下两点
为提高性能,必须保证以下两点

* 安装 Linux Guest Environment,只能用于 Ubuntu 系统,不能用于 COS
* 安装 Linux Guest Environment,只能用于 Ubuntu 系统,不能用于 Container-Optimized OS
* 确保 SSD 挂载选项中包含 `nobarrier`

我们提供一个解决上述问题的 [Daemonset](https://raw.githubusercontent.com/pingcap/tidb-operator/master/manifests/gke/local-ssd-optimize.yaml)。还提供一个解决上述性能问题并且将多块 SSD 盘配置成一个 LVM 的
[Daemonset](https://raw.githubusercontent.com/pingcap/tidb-operator/master/manifests/gke/local-ssd-provision/local-ssd-provision.yaml)。通过 Terraform 部署的时候会自动安装。
TiDB 提供的 [Daemonset](https://raw.githubusercontent.com/pingcap/tidb-operator/master/manifests/gke/local-ssd-provision/local-ssd-provision.yaml) 能够:

+ 解决性能问题
+ 使用 UUID 重新安装本地 SSD 磁盘,以提高安全性
+ 在 Ubuntu 上使用 LVM 工具将所有本地 SSD 磁盘组合成一个大磁盘
+ 运行 local-volume-provisioner

terraform 部署将自动安装该 Daemonset。

> **注意:**
>
> 整合多块本地 SSD 盘的部署方式假设一个虚拟机上只有一个进程需要使用本地 SSD。
> 整合多块本地 SSD 盘的部署方式。假设一个虚拟机上只有一个进程,则需要使用本地 SSD。
## 配置

Helm 安装完成后,通过下面命令获取要安装的 tidb-cluster chart 的 `values.yaml` 配置文件:
Helm 安装完成后,通过下面命令获取待安装的 tidb-cluster chart 的 `values.yaml` 配置文件:

{{< copyable "shell-regular" >}}

Expand All @@ -44,7 +50,7 @@ helm inspect values pingcap/tidb-cluster --version=${chartVersion} > /home/tidb/

> **注意:**
>
> `/home/tidb` 可以替换为你想用的目录下文会用 `values.yaml` 指代 `/home/tidb/${releaseName}/values-${releaseName}.yaml`
> `/home/tidb` 可以替换为你想用的目录下文会用 `values.yaml` 指代 `/home/tidb/${releaseName}/values-${releaseName}.yaml`
有关配置信息请参考 [TiDB 集群部署配置文档](/reference/configuration/tidb-in-kubernetes/cluster-configuration.md)

Expand All @@ -68,15 +74,15 @@ kubectl get po -n ${namespace} -l app.kubernetes.io/instance=${releaseName}

## 访问 TiDB 集群

默认情况下,TiDB 服务通过 [`NodePort`](https://kubernetes.io/docs/concepts/services-networking/service/#nodeport) 暴露。可以通过修改为 `ClusterIP` 禁止集群外访问或者如果 Kubernetes 集群支持,可以修改为 [`LoadBalancer`](https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer) 对外暴露服务。
默认情况下,TiDB 服务通过 [`NodePort`](https://kubernetes.io/docs/concepts/services-networking/service/#nodeport) 暴露。可以通过修改为 `ClusterIP` 禁止集群外访问。如果 Kubernetes 集群支持,可以修改为 [`LoadBalancer`](https://kubernetes.io/docs/concepts/services-networking/service/#loadbalancer) 对外暴露服务。

{{< copyable "shell-regular" >}}

``` shell
kubectl get svc -n ${namespace}
```

TiDB 集群默认没有设置 root 密码。在 Helm 中设置密码不安全,你可以在 `values.yaml` 中给 `tidb.passwordSecretName` 设置一个 K8s secret。注意,这仅用于初始化用户:一旦 TiDB 集群初始化完成,你可以删除这个 secret。secret 的格式为 `user=password`你可以通过下面命令设置 root 用户密码:
TiDB 集群默认没有设置 root 密码。在 Helm 中设置密码不安全,因此可以在 `values.yaml` 中给 `tidb.passwordSecretName` 设置一个 K8s secret。注意,这仅用于初始化用户:一旦 TiDB 集群初始化完成,你可以删除这个 secret。secret 的格式为 `user=password`你可以通过下面命令设置 root 用户密码:

{{< copyable "shell-regular" >}}

Expand Down Expand Up @@ -124,7 +130,7 @@ echo ${PASSWORD}

## TiDB 集群伸缩

TiDB Operator 支持垂直和水平伸缩。存储的垂直伸缩需要注意以下各项
TiDB Operator 支持垂直和水平伸缩。存储的垂直伸缩需要注意以下事项

* 使用 Kubernetes v1.11 或者更高版本,请参考[官方博客](https://kubernetes.io/blog/2018/07/12/resizing-persistent-volumes-using-kubernetes/)
* 后端 StorageClass 支持调整大小(目前只有少数几个网络 StorageClass 支持调整大小)。
Expand Down

0 comments on commit b758194

Please sign in to comment.