From 39f5a6519b5efdcdca43ca8d4fad1e2efe07f8b4 Mon Sep 17 00:00:00 2001 From: Yichen Yan Date: Thu, 20 Feb 2020 15:54:40 +0800 Subject: [PATCH 1/8] reference: specific Helm version --- .../get-started/deploy-tidb-from-docker-compose.md | 6 ++++-- dev/tidb-in-kubernetes/reference/tools/in-kubernetes.md | 9 +++++++-- v3.0/tidb-in-kubernetes/reference/tools/in-kubernetes.md | 9 +++++++-- v3.1/tidb-in-kubernetes/reference/tools/in-kubernetes.md | 9 +++++++-- 4 files changed, 25 insertions(+), 8 deletions(-) diff --git a/dev/how-to/get-started/deploy-tidb-from-docker-compose.md b/dev/how-to/get-started/deploy-tidb-from-docker-compose.md index f04c0ba54d833..425a6b9aa6a60 100644 --- a/dev/how-to/get-started/deploy-tidb-from-docker-compose.md +++ b/dev/how-to/get-started/deploy-tidb-from-docker-compose.md @@ -67,7 +67,8 @@ To customize the cluster, you can edit the `docker-compose.yml` file directly. I 1. Install Helm. - [Helm](https://helm.sh) can be used as a template rendering engine. To use Helm, you only need to download its binary file: + [Helm](https://helm.sh) can be used as a template rendering engine. Currently we only support Helm version >= 2.9.0 and < 3.0.0. + To use Helm, you only need to download its binary file: ```bash curl https://raw.githubusercontent.com/kubernetes/helm/master/scripts/get | bash @@ -76,7 +77,8 @@ To customize the cluster, you can edit the `docker-compose.yml` file directly. I For macOS, you can also install Helm using the following command in Homebrew: ```bash - brew install kubernetes-helm + brew install helm@2 + brew link --force helm@2 ``` 2. Download `tidb-docker-compose`. diff --git a/dev/tidb-in-kubernetes/reference/tools/in-kubernetes.md b/dev/tidb-in-kubernetes/reference/tools/in-kubernetes.md index 3fa32c8f892f3..42fc9d06ea054 100644 --- a/dev/tidb-in-kubernetes/reference/tools/in-kubernetes.md +++ b/dev/tidb-in-kubernetes/reference/tools/in-kubernetes.md @@ -138,7 +138,7 @@ tidb-ctl schema in mysql ## Use Helm -[Helm](https://helm.sh/) is a package management tool for Kubernetes. Refer to [Helm Documentation](https://github.com/helm/helm#install) to install Helm. The steps are as follows: +[Helm](https://helm.sh/) is a package management tool for Kubernetes. Currently we only support Helm version >= 2.9.0 and < 3.0.0. The installation steps are as follows: 1. Install Helm client @@ -148,7 +148,12 @@ tidb-ctl schema in mysql curl https://raw.githubusercontent.com/kubernetes/helm/master/scripts/get | bash ``` - Or if on macOS, you can use homebrew to install Helm via the `brew install kubernetes-helm` command. + Or if on macOS, you can use homebrew to install Helm via the command below: + + ```bash + brew install helm@2 + brew link --force helm@2 + ``` 2. Install Helm server. diff --git a/v3.0/tidb-in-kubernetes/reference/tools/in-kubernetes.md b/v3.0/tidb-in-kubernetes/reference/tools/in-kubernetes.md index 423a6608fbb68..a969e0a52ae94 100644 --- a/v3.0/tidb-in-kubernetes/reference/tools/in-kubernetes.md +++ b/v3.0/tidb-in-kubernetes/reference/tools/in-kubernetes.md @@ -139,7 +139,7 @@ tidb-ctl schema in mysql ## Use Helm -[Helm](https://helm.sh/) is a package management tool for Kubernetes. Refer to [Helm Documentation](https://github.com/helm/helm#install) to install Helm. The steps are as follows: +[Helm](https://helm.sh/) is a package management tool for Kubernetes. Currently we only support Helm version >= 2.9.0 and < 3.0.0. The installation steps are as follows: 1. Install Helm client @@ -149,7 +149,12 @@ tidb-ctl schema in mysql curl https://raw.githubusercontent.com/kubernetes/helm/master/scripts/get | bash ``` - Or if on macOS, you can use homebrew to install Helm via the `brew install kubernetes-helm` command. + For macOS, you can also install Helm using the following command in Homebrew: + + ```bash + brew install helm@2 + brew link --force helm@2 + ``` 2. Install Helm server. diff --git a/v3.1/tidb-in-kubernetes/reference/tools/in-kubernetes.md b/v3.1/tidb-in-kubernetes/reference/tools/in-kubernetes.md index 988a688457517..64ebfdd75f03e 100644 --- a/v3.1/tidb-in-kubernetes/reference/tools/in-kubernetes.md +++ b/v3.1/tidb-in-kubernetes/reference/tools/in-kubernetes.md @@ -138,7 +138,7 @@ tidb-ctl schema in mysql ## Use Helm -[Helm](https://helm.sh/) is a package management tool for Kubernetes. Refer to [Helm Documentation](https://github.com/helm/helm#install) to install Helm. The steps are as follows: +[Helm](https://helm.sh/) is a package management tool for Kubernetes. Currently we only support Helm version >= 2.9.0 and < 3.0.0. The installation steps are as follows: 1. Install Helm client @@ -148,7 +148,12 @@ tidb-ctl schema in mysql curl https://raw.githubusercontent.com/kubernetes/helm/master/scripts/get | bash ``` - Or if on macOS, you can use homebrew to install Helm via the `brew install kubernetes-helm` command. + For macOS, you can also install Helm using the following command in Homebrew: + + ```bash + brew install helm@2 + brew link --force helm@2 + ``` 2. Install Helm server. From e8c515ed3322e2a5dd915f92bcc51365beaf4418 Mon Sep 17 00:00:00 2001 From: Yichen Yan Date: Thu, 20 Feb 2020 16:02:59 +0800 Subject: [PATCH 2/8] also v2.1 --- v2.1-legacy/op-guide/docker-compose.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/v2.1-legacy/op-guide/docker-compose.md b/v2.1-legacy/op-guide/docker-compose.md index ce2887157b2a1..974f367b0a6ff 100755 --- a/v2.1-legacy/op-guide/docker-compose.md +++ b/v2.1-legacy/op-guide/docker-compose.md @@ -63,7 +63,7 @@ To customize the cluster, you can edit the `docker-compose.yml` file directly. I 1. Install Helm. - [Helm](https://helm.sh) can be used as a template rendering engine. To use Helm, you only need to download its binary file: + [Helm](https://helm.sh) can be used as a template rendering engine. Currently we only support Helm version >= 2.9.0 and < 3.0.0. The installation steps are as follows: ```bash curl https://raw.githubusercontent.com/kubernetes/helm/master/scripts/get | bash @@ -72,7 +72,8 @@ To customize the cluster, you can edit the `docker-compose.yml` file directly. I For macOS, you can also install Helm using the following command in Homebrew: ```bash - brew install kubernetes-helm + brew install helm@2 + brew link --force helm@2 ``` 2. Download `tidb-docker-compose`. From 7b7dc102db133f1089d3d9647ce112941502b22a Mon Sep 17 00:00:00 2001 From: Yichen Date: Thu, 20 Feb 2020 23:26:14 +0800 Subject: [PATCH 3/8] Update dev/tidb-in-kubernetes/reference/tools/in-kubernetes.md Co-Authored-By: Lilian Lee --- dev/tidb-in-kubernetes/reference/tools/in-kubernetes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dev/tidb-in-kubernetes/reference/tools/in-kubernetes.md b/dev/tidb-in-kubernetes/reference/tools/in-kubernetes.md index 42fc9d06ea054..bac19dc9c5012 100644 --- a/dev/tidb-in-kubernetes/reference/tools/in-kubernetes.md +++ b/dev/tidb-in-kubernetes/reference/tools/in-kubernetes.md @@ -138,7 +138,7 @@ tidb-ctl schema in mysql ## Use Helm -[Helm](https://helm.sh/) is a package management tool for Kubernetes. Currently we only support Helm version >= 2.9.0 and < 3.0.0. The installation steps are as follows: +[Helm](https://helm.sh/) is a package management tool for Kubernetes. Make sure your Helm version >= 2.9.0 and < 3.0.0. The installation steps are as follows: 1. Install Helm client From fd86bf259b765fadbbf14931cefb6604efc0444f Mon Sep 17 00:00:00 2001 From: Yichen Date: Thu, 20 Feb 2020 23:26:29 +0800 Subject: [PATCH 4/8] Update v3.0/tidb-in-kubernetes/reference/tools/in-kubernetes.md Co-Authored-By: Lilian Lee --- v3.0/tidb-in-kubernetes/reference/tools/in-kubernetes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/v3.0/tidb-in-kubernetes/reference/tools/in-kubernetes.md b/v3.0/tidb-in-kubernetes/reference/tools/in-kubernetes.md index a969e0a52ae94..dd0ee7676e03a 100644 --- a/v3.0/tidb-in-kubernetes/reference/tools/in-kubernetes.md +++ b/v3.0/tidb-in-kubernetes/reference/tools/in-kubernetes.md @@ -139,7 +139,7 @@ tidb-ctl schema in mysql ## Use Helm -[Helm](https://helm.sh/) is a package management tool for Kubernetes. Currently we only support Helm version >= 2.9.0 and < 3.0.0. The installation steps are as follows: +[Helm](https://helm.sh/) is a package management tool for Kubernetes. Make sure your Helm version >= 2.9.0 and < 3.0.0. The installation steps are as follows: 1. Install Helm client From 2cedb845703d297b52399db781cc9a11d3d4890b Mon Sep 17 00:00:00 2001 From: Yichen Date: Thu, 20 Feb 2020 23:26:44 +0800 Subject: [PATCH 5/8] Update dev/tidb-in-kubernetes/reference/tools/in-kubernetes.md Co-Authored-By: Lilian Lee --- dev/tidb-in-kubernetes/reference/tools/in-kubernetes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dev/tidb-in-kubernetes/reference/tools/in-kubernetes.md b/dev/tidb-in-kubernetes/reference/tools/in-kubernetes.md index bac19dc9c5012..153cda54dad37 100644 --- a/dev/tidb-in-kubernetes/reference/tools/in-kubernetes.md +++ b/dev/tidb-in-kubernetes/reference/tools/in-kubernetes.md @@ -148,7 +148,7 @@ tidb-ctl schema in mysql curl https://raw.githubusercontent.com/kubernetes/helm/master/scripts/get | bash ``` - Or if on macOS, you can use homebrew to install Helm via the command below: + Or if on macOS, you can use Homebrew to install Helm via the following command: ```bash brew install helm@2 From 061e89fb3e278807b44f19b78efd18c93a06df1f Mon Sep 17 00:00:00 2001 From: Yichen Date: Thu, 20 Feb 2020 23:27:00 +0800 Subject: [PATCH 6/8] Update v2.1-legacy/op-guide/docker-compose.md Co-Authored-By: Lilian Lee --- v2.1-legacy/op-guide/docker-compose.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/v2.1-legacy/op-guide/docker-compose.md b/v2.1-legacy/op-guide/docker-compose.md index 974f367b0a6ff..cfc1d3397fc21 100755 --- a/v2.1-legacy/op-guide/docker-compose.md +++ b/v2.1-legacy/op-guide/docker-compose.md @@ -63,7 +63,7 @@ To customize the cluster, you can edit the `docker-compose.yml` file directly. I 1. Install Helm. - [Helm](https://helm.sh) can be used as a template rendering engine. Currently we only support Helm version >= 2.9.0 and < 3.0.0. The installation steps are as follows: + [Helm](https://helm.sh) can be used as a template rendering engine. Make sure your Helm version >= 2.9.0 and < 3.0.0. The installation steps are as follows: ```bash curl https://raw.githubusercontent.com/kubernetes/helm/master/scripts/get | bash @@ -176,4 +176,4 @@ docker-compose exec tispark-master /opt/spark/bin/sparkR For more details about TiSpark, see [here](../tispark/tispark-quick-start-guide.md). -Here is [a 5-minute tutorial](https://pingcap.com/blog/how_to_spin_up_an_htap_database_in_5_minutes_with_tidb_tispark/) for macOS users that shows how to spin up a standard TiDB cluster using Docker Compose on your local computer. \ No newline at end of file +Here is [a 5-minute tutorial](https://pingcap.com/blog/how_to_spin_up_an_htap_database_in_5_minutes_with_tidb_tispark/) for macOS users that shows how to spin up a standard TiDB cluster using Docker Compose on your local computer. From bcc2a8967d7da0def47a35685c1b5c80600e6d4e Mon Sep 17 00:00:00 2001 From: Yichen Date: Thu, 20 Feb 2020 23:28:23 +0800 Subject: [PATCH 7/8] Update dev/how-to/get-started/deploy-tidb-from-docker-compose.md Co-Authored-By: Lilian Lee --- dev/how-to/get-started/deploy-tidb-from-docker-compose.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dev/how-to/get-started/deploy-tidb-from-docker-compose.md b/dev/how-to/get-started/deploy-tidb-from-docker-compose.md index 425a6b9aa6a60..faffafb14e0f5 100644 --- a/dev/how-to/get-started/deploy-tidb-from-docker-compose.md +++ b/dev/how-to/get-started/deploy-tidb-from-docker-compose.md @@ -67,7 +67,7 @@ To customize the cluster, you can edit the `docker-compose.yml` file directly. I 1. Install Helm. - [Helm](https://helm.sh) can be used as a template rendering engine. Currently we only support Helm version >= 2.9.0 and < 3.0.0. + [Helm](https://helm.sh) can be used as a template rendering engine. Make sure your Helm version >= 2.9.0 and < 3.0.0. To use Helm, you only need to download its binary file: To use Helm, you only need to download its binary file: ```bash From 3acce7259459c1dc0a3427015fe8f06ce8b7bce6 Mon Sep 17 00:00:00 2001 From: Yichen Date: Thu, 20 Feb 2020 23:28:38 +0800 Subject: [PATCH 8/8] Update v3.1/tidb-in-kubernetes/reference/tools/in-kubernetes.md Co-Authored-By: Lilian Lee --- v3.1/tidb-in-kubernetes/reference/tools/in-kubernetes.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/v3.1/tidb-in-kubernetes/reference/tools/in-kubernetes.md b/v3.1/tidb-in-kubernetes/reference/tools/in-kubernetes.md index 64ebfdd75f03e..281378e317e86 100644 --- a/v3.1/tidb-in-kubernetes/reference/tools/in-kubernetes.md +++ b/v3.1/tidb-in-kubernetes/reference/tools/in-kubernetes.md @@ -138,7 +138,7 @@ tidb-ctl schema in mysql ## Use Helm -[Helm](https://helm.sh/) is a package management tool for Kubernetes. Currently we only support Helm version >= 2.9.0 and < 3.0.0. The installation steps are as follows: +[Helm](https://helm.sh/) is a package management tool for Kubernetes. Make sure your Helm version >= 2.9.0 and < 3.0.0. The installation steps are as follows: 1. Install Helm client