From d32afefd3b02c8c1ac1b90509032cf364f631447 Mon Sep 17 00:00:00 2001 From: Keke Yi <40977455+yikeke@users.noreply.github.com> Date: Tue, 16 Jun 2020 23:02:26 +0800 Subject: [PATCH 1/2] cherry pick #3626 to release-4.0 Signed-off-by: ti-srebot --- .markdownlint.yaml | 2 +- deploy-test-cluster-using-docker-compose.md | 6 +++--- quick-start-with-tidb.md | 1 - schedule-replicas-by-topology-labels.md | 2 +- test-deployment-using-docker.md | 10 +++++++--- 5 files changed, 12 insertions(+), 9 deletions(-) diff --git a/.markdownlint.yaml b/.markdownlint.yaml index b03529ab0dbd..f7e19803bc8a 100644 --- a/.markdownlint.yaml +++ b/.markdownlint.yaml @@ -1,4 +1,4 @@ -comment: 'Rules for PingCAP docs-cn' +comment: 'Markdownlint Rules for PingCAP docs-cn' # disable all by default default: false diff --git a/deploy-test-cluster-using-docker-compose.md b/deploy-test-cluster-using-docker-compose.md index ab76924d6e7c..16ae7d9564de 100644 --- a/deploy-test-cluster-using-docker-compose.md +++ b/deploy-test-cluster-using-docker-compose.md @@ -6,11 +6,11 @@ aliases: ['/docs-cn/stable/how-to/get-started/deploy-tidb-from-docker-compose/'] # 使用 Docker Compose 快速构建 TiDB 集群 -本文档介绍如何在单机上通过 Docker Compose 快速一键部署一套 TiDB 测试集群。[Docker Compose](https://docs.docker.com/compose/overview) 可以通过一个 YAML 文件定义多个容器的应用服务，然后一键启动或停止。 - > **警告：** > -> 对于生产环境，不要使用 Docker Compose 进行部署，而应[使用 TiUP 部署 TiDB 集群](/production-deployment-using-tiup.md)。 +> 本文提供的 Docker Compose 部署方案已停止维护。如果只是为了测试 TiDB，推荐参考[TiDB 数据库快速上手指南](/quick-start-with-tidb.md)进行部署。对于**生产环境**，不要使用 Docker Compose 进行部署，而应[使用 TiUP 部署 TiDB 集群](/production-deployment-using-tiup.md)。 + +本文档介绍如何在单机上通过 Docker Compose 快速一键部署一套 TiDB 测试集群。[Docker Compose](https://docs.docker.com/compose/overview) 可以通过一个 YAML 文件定义多个容器的应用服务，然后一键启动或停止。 ## 准备环境 diff --git a/quick-start-with-tidb.md b/quick-start-with-tidb.md index df99c2a3fb34..845f1cdb72f1 100644 --- a/quick-start-with-tidb.md +++ b/quick-start-with-tidb.md @@ -1,7 +1,6 @@ --- title: TiDB 数据库快速上手指南 category: how-to -aliases: ['/docs-cn/dev/test-deployment-using-docker/'] --- # TiDB 数据库快速上手指南 diff --git a/schedule-replicas-by-topology-labels.md b/schedule-replicas-by-topology-labels.md index 6553ea05fb60..7f58e2666e64 100644 --- a/schedule-replicas-by-topology-labels.md +++ b/schedule-replicas-by-topology-labels.md @@ -8,7 +8,7 @@ aliases: ['/docs-cn/stable/how-to/deploy/geographic-redundancy/location-awarenes 为了提升 TiDB 集群的高可用性和数据容灾能力，我们推荐让 TiKV 节点尽可能在物理层面上分散，例如让 TiKV 节点分布在不同的机架甚至不同的机房。PD 调度器根据 TiKV 的拓扑信息，会自动在后台通过调度使得 Region 的各个副本尽可能隔离，从而使得数据容灾能力最大化。 -要让这个机制生效，我们需要在部署时进行合理配置，把集群的拓扑信息（特别是 TiKV 的位置）上报给 PD。阅读本章前，请先确保阅读 [TiDB Ansible 部署方案](/online-deployment-using-ansible.md) 和 [Docker 部署方案](/test-deployment-using-docker.md)。 +要让这个机制生效，需要在部署时进行合理配置，把集群的拓扑信息（特别是 TiKV 的位置）上报给 PD。阅读本章前，请先确保阅读 [TiUP 部署方案](/production-deployment-using-tiup.md)。 ## 根据集群拓扑配置 labels diff --git a/test-deployment-using-docker.md b/test-deployment-using-docker.md index 9815d4cff54b..30b0f49338b3 100644 --- a/test-deployment-using-docker.md +++ b/test-deployment-using-docker.md @@ -1,17 +1,21 @@ --- title: TiDB Docker 部署方案 category: how-to +<<<<<<< HEAD aliases: ['/docs-cn/stable/how-to/deploy/orchestrated/docker/'] draft: true +======= +aliases: ['/docs-cn/dev/how-to/deploy/orchestrated/docker/'] +>>>>>>> 04f37ba... add deprecated warnings for outdated deployment methods (#3626) --- # TiDB Docker 部署方案 -本文介绍如何使用 Docker 部署一个多节点的 TiDB 集群。 - > **警告：** > -> 对于生产环境，不要使用 Docker 进行部署，而应[使用 TiUP 部署 TiDB 集群](/production-deployment-using-tiup.md)。 +> 本文提供的 Docker 部署方案已停止维护。如果只是为了测试 TiDB，推荐参考[TiDB 数据库快速上手指南](/quick-start-with-tidb.md)进行部署。对于**生产环境**，不要使用 Docker 进行部署，而应[使用 TiUP 部署 TiDB 集群](/production-deployment-using-tiup.md)。 + +本文介绍如何使用 Docker 在测试环境部署一个多节点的 TiDB 集群。 ## 环境准备 From e59aedef548ee926d5e523577d8437f5d40574e9 Mon Sep 17 00:00:00 2001 From: Keke Yi <40977455+yikeke@users.noreply.github.com> Date: Wed, 17 Jun 2020 11:23:07 +0800 Subject: [PATCH 2/2] Update test-deployment-using-docker.md --- test-deployment-using-docker.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/test-deployment-using-docker.md b/test-deployment-using-docker.md index 30b0f49338b3..cbfc7bc07e95 100644 --- a/test-deployment-using-docker.md +++ b/test-deployment-using-docker.md @@ -1,12 +1,7 @@ --- title: TiDB Docker 部署方案 category: how-to -<<<<<<< HEAD aliases: ['/docs-cn/stable/how-to/deploy/orchestrated/docker/'] -draft: true -======= -aliases: ['/docs-cn/dev/how-to/deploy/orchestrated/docker/'] ->>>>>>> 04f37ba... add deprecated warnings for outdated deployment methods (#3626) --- # TiDB Docker 部署方案