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..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,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. 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 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..153cda54dad37 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. Make sure your 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 following command: + + ```bash + brew install helm@2 + brew link --force helm@2 + ``` 2. Install Helm server. diff --git a/v2.1-legacy/op-guide/docker-compose.md b/v2.1-legacy/op-guide/docker-compose.md index ce2887157b2a1..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. To use Helm, you only need to download its binary file: + [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 @@ -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`. @@ -175,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. 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..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. 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. Make sure your 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..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. 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. Make sure your 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.