Skip to content

Commit

Permalink
*: update recommended deployment method in multiple docs to TiUP meth…
Browse files Browse the repository at this point in the history
…od (pingcap#2768)

* how-to/deploy:fix-deploy-link

* Modify other docs

* fix format in tiup deploy doc

Co-authored-by: yikeke <yikeke@pingcap.com>
Co-authored-by: Keke Yi <40977455+yikeke@users.noreply.github.com>
  • Loading branch information
3 people authored Apr 15, 2020
1 parent 67a2e07 commit a5a8899
Show file tree
Hide file tree
Showing 7 changed files with 34 additions and 26 deletions.
8 changes: 6 additions & 2 deletions _index.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,14 @@ TiDB 对业务没有任何侵入性,能优雅的替换传统的数据库中间

TiDB 可以部署在本地和云平台上,支持公有云、私有云和混合云。你可以根据实际场景或需求,选择相应的方式来部署 TiDB 集群:

- [使用 Ansible 部署](/how-to/deploy/orchestrated/ansible.md):如果用于生产环境,须使用 TiDB Ansible 部署 TiDB 集群。
- [使用 Ansible 离线部署](/how-to/deploy/orchestrated/offline-ansible.md):如果部署环境无法访问网络,可使用 Ansible 进行离线部署。
- [使用 TiUP 部署](/how-to/deploy/orchestrated/tiup.md):如果用于生产环境,推荐使用 TiUP 部署 TiDB 集群。
- [使用 TiDB Ansible 部署](/how-to/deploy/orchestrated/ansible.md):如果用于生产环境,也可以使用 TiDB Ansible 部署 TiDB 集群。
- [使用 TiDB Ansible 离线部署](/how-to/deploy/orchestrated/offline-ansible.md):如果部署环境无法访问网络,可使用 Ansible 进行离线部署。
- [使用 Docker Compose 部署](/how-to/get-started/deploy-tidb-from-docker-compose.md):如果你只是想测试 TiDB、体验 TiDB 的特性,或者用于开发环境,可以使用 Docker Compose 在本地快速部署 TiDB 集群。该部署方式不适用于生产环境。
- [使用 Docker 部署](/how-to/deploy/orchestrated/docker.md):你可以使用 Docker 部署 TiDB 集群,但该部署方式不适用于生产环境。
- [使用 TiDB Operator 部署](https://pingcap.com/docs-cn/tidb-in-kubernetes/stable/deploy-tidb-operator/):使用 TiDB Operator 在 Kubernetes 集群上部署生产就绪的 TiDB 集群,支持[部署到 AWS EKS](https://pingcap.com/docs-cn/tidb-in-kubernetes/stable/deploy-on-aws-eks/)[部署到谷歌云 GKE (beta)](https://pingcap.com/docs-cn/tidb-in-kubernetes/stable/deploy-on-gcp-gke/)[部署到阿里云 ACK](https://pingcap.com/docs-cn/tidb-in-kubernetes/stable/deploy-on-alibaba-cloud/) 等。
- [使用 TiDB Operator 部署到 Minikube](https://pingcap.com/docs-cn/tidb-in-kubernetes/stable/deploy-tidb-from-kubernetes-minikube/):你可以使用 TiDB Operator 将 TiDB 集群部署到本地 Minikube 启动的 Kubernetes 集群中。该部署方式不适用于生产环境。
- [使用 TiDB Operator 部署到 kind](https://pingcap.com/docs-cn/tidb-in-kubernetes/stable/deploy-tidb-from-kubernetes-kind/):你可以使用 TiDB Operator 将 TiDB 集群部署到以 kind 方式启动的 Kubernetes 本地集群中。该部署方式不适用于生产环境。

## 项目源码

Expand Down
5 changes: 3 additions & 2 deletions faq/tidb.md
Original file line number Diff line number Diff line change
Expand Up @@ -208,9 +208,10 @@ TiDB 支持部署和运行在 Intel x86-64 架构的 64 位通用硬件服务器

### 2.2 安装部署

#### 2.2.1 TiDB Ansible 部署方式(强烈推荐)
#### 2.2.1 推荐部署方式

详细可参考[使用 TiDB Ansible 部署 TiDB 集群](/how-to/deploy/orchestrated/ansible.md)
- [使用 TiUP 部署](/how-to/deploy/orchestrated/tiup.md):如果用于生产环境,推荐使用 TiUP 部署 TiDB 集群。
- [使用 TiDB Ansible 部署](/how-to/deploy/orchestrated/ansible.md):如果用于生产环境,也可以使用 TiDB Ansible 部署 TiDB 集群。

##### 2.2.1.1 为什么修改了 TiKV/PD 的 toml 配置文件,却没有生效?

Expand Down
2 changes: 1 addition & 1 deletion how-to/deploy/orchestrated/ansible.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Ansible 是一款自动化运维工具,[TiDB Ansible](https://github.com/pingc

> **注意:**
>
> 对于生产环境,须使用 TiDB Ansible 部署 TiDB 集群。如果只是用于测试 TiDB 或体验 TiDB 的特性,建议[使用 Docker Compose 在单机上快速部署 TiDB 集群](/how-to/get-started/deploy-tidb-from-docker-compose.md)
> 对于生产环境,推荐使用 [使用 TiUP 部署](/how-to/deploy/orchestrated/tiup.md) 部署 TiDB 集群。也可以使用 TiDB Ansible 部署 TiDB 集群。如果只是用于测试 TiDB 或体验 TiDB 的特性,建议[使用 Docker Compose 在单机上快速部署 TiDB 集群](/how-to/get-started/deploy-tidb-from-docker-compose.md)
## 准备机器

Expand Down
2 changes: 1 addition & 1 deletion how-to/deploy/orchestrated/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ category: how-to

> **警告:**
>
> 对于生产环境,不要使用 Docker 进行部署,而应[使用 TiDB Ansible 部署 TiDB 集群](/how-to/deploy/orchestrated/ansible.md)
> 对于生产环境,不要使用 Docker 进行部署,而应[使用 TiUP 部署 TiDB 集群](/how-to/deploy/orchestrated/tiup.md)
## 环境准备

Expand Down
34 changes: 18 additions & 16 deletions how-to/deploy/orchestrated/tiup.md
Original file line number Diff line number Diff line change
Expand Up @@ -524,33 +524,33 @@ alertmanager_servers:
- TiKV 进行配置优化

- readpool 线程池自适应,配置 `readpool.unified.max-thread-count` 参数可以使 `readpool.storage``readpool.coprocessor` 共用统一线程池,同时要分别开启自适应开关。

- 开启 `readpool.storage``readpool.coprocessor`

```yaml
readpool.storage.use-unified-pool: true
readpool.coprocessor.use-unified-pool: true
```
```yaml
readpool.storage.use-unified-pool: true
readpool.coprocessor.use-unified-pool: true
```

- 计算公式如下:

```
readpool.unified.max-thread-count = cores * 0.8 / TiKV 数量
```
```
readpool.unified.max-thread-count = cores * 0.8 / TiKV 数量
```

- storage CF (all RocksDB column families) 内存自适应,配置 `storage.block-cache.capacity` 参数即可实现 CF 之间自动平衡内存使用。

- `storage.block-cache` 默认开启 CF 自适应,无需修改。

```yaml
storage.block-cache.shared: true
```
```yaml
storage.block-cache.shared: true
```

- 计算公式如下:

```
storage.block-cache.capacity = (MEM_TOTAL * 0.5 / TiKV 实例数量)
```
```
storage.block-cache.capacity = (MEM_TOTAL * 0.5 / TiKV 实例数量)
```

- 如果多个 TiKV 实例部署在同一块物理磁盘上,需要在 tikv 配置中添加 capacity 参数:

Expand Down Expand Up @@ -605,6 +605,8 @@ alertmanager_servers:
> - 配置文件模版时,注意修改必要参数、IP、端口及目录。
>
> - 各个组件的 deploy_dir,默认会使用 global 中的 <deploy_dir>/<components_name>-<port>。例如 tidb 端口指定 4001,则 deploy_dir 默认为 /tidb-deploy/tidb-4001。因此,在多实例场景下指定非默认端口时,无需再次指定目录。

> **注意:**
>
> - [部署 TiFlash](/reference/tiflash/deploy.md) 需要在 topology.yaml 配置文件中将 `replication.enable-placement-rules` 设置为 `true`,以开启 PD 的 [Placement Rules](/how-to/configure/placement-rules.md) 功能。
>
Expand Down
2 changes: 1 addition & 1 deletion how-to/get-started/deploy-tidb-from-docker-compose.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ category: how-to

> **警告:**
>
> 对于生产环境,不要使用 Docker Compose 进行部署,而应[使用 TiDB Ansible 部署 TiDB 集群](/how-to/deploy/orchestrated/ansible.md)
> 对于生产环境,不要使用 Docker Compose 进行部署,而应[使用 TiUP 部署 TiDB 集群](/how-to/deploy/orchestrated/tiup.md)
## 准备环境

Expand Down
7 changes: 4 additions & 3 deletions overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,12 @@ TiDB 对业务没有任何侵入性,能优雅地替换传统的数据库中间

TiDB 可以部署在本地和云平台上,支持公有云、私有云和混合云。你可以根据实际场景或需求,选择相应的方式来部署 TiDB 集群:

- [使用 Ansible 部署](/how-to/deploy/orchestrated/ansible.md):如果用于生产环境,推荐使用 TiDB Ansible 部署 TiDB 集群。
- [使用 Ansible 离线部署](/how-to/deploy/orchestrated/offline-ansible.md)如果部署环境无法访问网络,可使用 TiDB Ansible 进行离线部署
- [使用 TiDB Operator 部署](https://pingcap.com/docs-cn/tidb-in-kubernetes/stable/deploy-tidb-operator/):使用 TiDB Operator 在 Kubernetes 集群上部署生产就绪的 TiDB 集群,支持[部署到 AWS EKS](https://pingcap.com/docs-cn/tidb-in-kubernetes/stable/deploy-on-aws-eks/)[部署到谷歌云 GKE (beta)](https://pingcap.com/docs-cn/tidb-in-kubernetes/stable/deploy-on-gcp-gke/)[部署到阿里云 ACK](https://pingcap.com/docs-cn/tidb-in-kubernetes/stable/deploy-on-alibaba-cloud/)
- [使用 TiUP 部署](/how-to/deploy/orchestrated/tiup.md):如果用于生产环境,推荐使用 TiUP 部署 TiDB 集群。
- [使用 TiDB Ansible 部署](/how-to/deploy/orchestrated/ansible.md)如果用于生产环境,也可以使用 TiDB Ansible 部署 TiDB 集群
- [使用 TiDB Ansible 离线部署](/how-to/deploy/orchestrated/offline-ansible.md):如果部署环境无法访问网络,可使用 Ansible 进行离线部署
- [使用 Docker Compose 部署](/how-to/get-started/deploy-tidb-from-docker-compose.md):如果你只是想测试 TiDB、体验 TiDB 的特性,或者用于开发环境,可以使用 Docker Compose 在本地快速部署 TiDB 集群。该部署方式不适用于生产环境。
- [使用 Docker 部署](/how-to/deploy/orchestrated/docker.md):你可以使用 Docker 部署 TiDB 集群,但该部署方式不适用于生产环境。
- [使用 TiDB Operator 部署](https://pingcap.com/docs-cn/tidb-in-kubernetes/stable/deploy-tidb-operator/):使用 TiDB Operator 在 Kubernetes 集群上部署生产就绪的 TiDB 集群,支持[部署到 AWS EKS](https://pingcap.com/docs-cn/tidb-in-kubernetes/stable/deploy-on-aws-eks/)[部署到谷歌云 GKE (beta)](https://pingcap.com/docs-cn/tidb-in-kubernetes/stable/deploy-on-gcp-gke/)[部署到阿里云 ACK](https://pingcap.com/docs-cn/tidb-in-kubernetes/stable/deploy-on-alibaba-cloud/) 等。
- [使用 TiDB Operator 部署到 Minikube](https://pingcap.com/docs-cn/tidb-in-kubernetes/stable/deploy-tidb-from-kubernetes-minikube/):你可以使用 TiDB Operator 将 TiDB 集群部署到本地 Minikube 启动的 Kubernetes 集群中。该部署方式不适用于生产环境。
- [使用 TiDB Operator 部署到 kind](https://pingcap.com/docs-cn/tidb-in-kubernetes/stable/deploy-tidb-from-kubernetes-kind/):你可以使用 TiDB Operator 将 TiDB 集群部署到以 kind 方式启动的 Kubernetes 本地集群中。该部署方式不适用于生产环境。

Expand Down

0 comments on commit a5a8899

Please sign in to comment.