Skip to content

Commit

Permalink
docs: note helm versions in deployment docs (#553)
Browse files Browse the repository at this point in the history
  • Loading branch information
AstroProfundis authored and weekface committed Jun 6, 2019
1 parent 76902fc commit 37403d6
Show file tree
Hide file tree
Showing 6 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion deploy/aws/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Before deploying a TiDB cluster on AWS EKS, make sure the following requirements
> **Note:** The access key must have at least permissions to: create VPC, create EBS, create EC2 and create role
* [terraform](https://learn.hashicorp.com/terraform/getting-started/install.html)
* [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-kubectl) >= 1.11
* [helm](https://github.com/helm/helm/blob/master/docs/install.md#installing-the-helm-client) >= 2.9.0
* [helm](https://github.com/helm/helm/blob/master/docs/install.md#installing-the-helm-client) >= 2.9.0 and < 3.0.0
* [jq](https://stedolan.github.io/jq/download/)
* [aws-iam-authenticator](https://docs.aws.amazon.com/eks/latest/userguide/install-aws-iam-authenticator.html) installed in `PATH`, to authenticate with AWS

Expand Down
2 changes: 1 addition & 1 deletion deploy/gcp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ First of all, make sure the following items are installed on your machine:
* [Google Cloud SDK](https://cloud.google.com/sdk/install)
* [terraform](https://www.terraform.io/downloads.html) >= 0.12
* [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-kubectl) >= 1.11
* [helm](https://github.com/helm/helm/blob/master/docs/install.md#installing-the-helm-client) >= 2.9.0
* [helm](https://github.com/helm/helm/blob/master/docs/install.md#installing-the-helm-client) >= 2.9.0 and < 3.0.0
* [jq](https://stedolan.github.io/jq/download/)

## Configure
Expand Down
2 changes: 1 addition & 1 deletion docs/aws-eks-tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ category: operations
## Requirements:
* [awscli](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html) >= 1.16.73
* [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-kubectl) >= 1.11
* [helm](https://github.com/helm/helm/blob/master/docs/install.md#installing-the-helm-client) >= 2.9.0
* [helm](https://github.com/helm/helm/blob/master/docs/install.md#installing-the-helm-client) >= 2.9.0 and < 3.0.0
* [jq](https://stedolan.github.io/jq/download/)
* [aws-iam-authenticator](https://github.com/kubernetes-sigs/aws-iam-authenticator#4-set-up-kubectl-to-use-authentication-tokens-provided-by-aws-iam-authenticator-for-kubernetes)
* [terraform](https://www.terraform.io/downloads.html)
Expand Down
2 changes: 1 addition & 1 deletion docs/local-dind-tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Before deploying a TiDB cluster to Kubernetes, make sure the following requireme
> **Note:** `kubeadm` validates installed Docker version during the installation process. If you are using Docker later than 18.06, there would be warning messages. The cluster might still be working, but it is recommended to use a Docker version between 17.03 and 18.06 for better compatibility. You can find older versions of docker [here](https://download.docker.com/).
- [Helm Client](https://github.com/helm/helm/blob/master/docs/install.md#installing-the-helm-client): 2.9.0 or later
- [Helm Client](https://github.com/helm/helm/blob/master/docs/install.md#installing-the-helm-client): version >= 2.9.0 and < 3.0.0
- [Kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl): 1.10 at least, 1.13 or later recommended

> **Note:** The outputs of different versions of `kubectl` might be slightly different.
Expand Down
2 changes: 1 addition & 1 deletion docs/minikube-tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This document describes how to deploy a TiDB cluster in the [minikube](https://k
* [Install minikube and start a Kubernetes cluster](#install-minikube-and-start-a-kubernetes-cluster)
* [Install kubectl to access the cluster](#install-kubectl-to-access-the-cluster)
- [Install TiDB operator and run a TiDB cluster with it](#install-tidb-operator-and-run-a-tidb-cluster-with-it)
* [Install helm](#install-helm)
* [Install helm](#install-helm) version >= 2.9.0 and < 3.0.0
* [Install TiDB operator in the Kubernetes cluster](#install-tidb-operator-in-the-kubernetes-cluster)
* [Launch a TiDB cluster](#launch-a-tidb-cluster)
* [Test TiDB cluster](#test-tidb-cluster)
Expand Down
2 changes: 1 addition & 1 deletion docs/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Before deploying the TiDB Operator, make sure the following requirements are sat
* [DNS addons](https://kubernetes.io/docs/tasks/access-application-cluster/configure-dns-cluster/)
* [PersistentVolume](https://kubernetes.io/docs/concepts/storage/persistent-volumes/)
* [RBAC](https://kubernetes.io/docs/admin/authorization/rbac) enabled (optional)
* [Helm](https://helm.sh) v2.8.2 or greater
* [Helm](https://helm.sh) version >= v2.8.2 and < v3.0.0
* Kubernetes v1.12 is required for zone-aware persistent volumes.

> **Note:** Allthough TiDB Operator can use network volume to persist TiDB data, this is slower due to redundant replication. It is highly recommended to set up [local volume](https://kubernetes.io/docs/concepts/storage/volumes/#local) for better performance.
Expand Down

0 comments on commit 37403d6

Please sign in to comment.