Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

en, zh: Bump Operator to v1.2.1 (#1363) #1364

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions en/cheat-sheet.md
Original file line number Diff line number Diff line change
Expand Up @@ -484,7 +484,7 @@ For example:
{{< copyable "shell-regular" >}}

```shell
helm inspect values pingcap/tidb-operator --version=v1.2.0 > values-tidb-operator.yaml
helm inspect values pingcap/tidb-operator --version=v1.2.1 > values-tidb-operator.yaml
```

### Deploy using Helm chart
Expand All @@ -500,7 +500,7 @@ For example:
{{< copyable "shell-regular" >}}

```shell
helm install tidb-operator pingcap/tidb-operator --namespace=tidb-admin --version=v1.2.0 -f values-tidb-operator.yaml
helm install tidb-operator pingcap/tidb-operator --namespace=tidb-admin --version=v1.2.1 -f values-tidb-operator.yaml
```

### View the deployed Helm release
Expand All @@ -524,7 +524,7 @@ For example:
{{< copyable "shell-regular" >}}

```shell
helm upgrade tidb-operator pingcap/tidb-operator --version=v1.2.0 -f values-tidb-operator.yaml
helm upgrade tidb-operator pingcap/tidb-operator --version=v1.2.1 -f values-tidb-operator.yaml
```

### Delete Helm release
Expand Down
2 changes: 1 addition & 1 deletion en/deploy-on-alibaba-cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ All the instances except ACK mandatory workers are deployed across availability
tikv_count = 3
tidb_count = 2
pd_count = 3
operator_version = "v1.2.0"
operator_version = "v1.2.1"
```

* To deploy TiFlash in the cluster, set `create_tiflash_node_pool = true` in `terraform.tfvars`. You can also configure the node count and instance type of the TiFlash node pool by modifying `tiflash_count` and `tiflash_instance_type`. By default, the value of `tiflash_count` is `2`, and the value of `tiflash_instance_type` is `ecs.i2.2xlarge`.
Expand Down
2 changes: 1 addition & 1 deletion en/deploy-tidb-from-kubernetes-gke.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ After the `TidbCluster` CRD is created, install TiDB Operator in your Kubernetes

```shell
kubectl create namespace tidb-admin
helm install --namespace tidb-admin tidb-operator pingcap/tidb-operator --version v1.2.0
helm install --namespace tidb-admin tidb-operator pingcap/tidb-operator --version v1.2.1
kubectl get po -n tidb-admin -l app.kubernetes.io/name=tidb-operator
```

Expand Down
24 changes: 12 additions & 12 deletions en/deploy-tidb-operator.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ After creating CRDs in the step above, there are two methods to deploy TiDB Oper

> **Note:**
>
> `${chart_version}` represents the chart version of TiDB Operator. For example, `v1.2.0`. You can view the currently supported versions by running the `helm search repo -l tidb-operator` command.
> `${chart_version}` represents the chart version of TiDB Operator. For example, `v1.2.1`. You can view the currently supported versions by running the `helm search repo -l tidb-operator` command.

2. Configure TiDB Operator

Expand Down Expand Up @@ -148,15 +148,15 @@ If your server cannot access the Internet, install TiDB Operator offline by the
{{< copyable "shell-regular" >}}

```shell
wget http://charts.pingcap.org/tidb-operator-v1.2.0.tgz
wget http://charts.pingcap.org/tidb-operator-v1.2.1.tgz
```

Copy the `tidb-operator-v1.2.0.tgz` file to the target server and extract it to the current directory:
Copy the `tidb-operator-v1.2.1.tgz` file to the target server and extract it to the current directory:

{{< copyable "shell-regular" >}}

```shell
tar zxvf tidb-operator.v1.2.0.tgz
tar zxvf tidb-operator.v1.2.1.tgz
```

2. Download the Docker images used by TiDB Operator
Expand All @@ -168,8 +168,8 @@ If your server cannot access the Internet, install TiDB Operator offline by the
{{< copyable "" >}}

```shell
pingcap/tidb-operator:v1.2.0
pingcap/tidb-backup-manager:v1.2.0
pingcap/tidb-operator:v1.2.1
pingcap/tidb-backup-manager:v1.2.1
bitnami/kubectl:latest
pingcap/advanced-statefulset:v0.3.3
k8s.gcr.io/kube-scheduler:v1.16.9
Expand All @@ -182,13 +182,13 @@ If your server cannot access the Internet, install TiDB Operator offline by the
{{< copyable "shell-regular" >}}

```shell
docker pull pingcap/tidb-operator:v1.2.0
docker pull pingcap/tidb-backup-manager:v1.2.0
docker pull pingcap/tidb-operator:v1.2.1
docker pull pingcap/tidb-backup-manager:v1.2.1
docker pull bitnami/kubectl:latest
docker pull pingcap/advanced-statefulset:v0.3.3

docker save -o tidb-operator-v1.2.0.tar pingcap/tidb-operator:v1.2.0
docker save -o tidb-backup-manager-v1.2.0.tar pingcap/tidb-backup-manager:v1.2.0
docker save -o tidb-operator-v1.2.1.tar pingcap/tidb-operator:v1.2.1
docker save -o tidb-backup-manager-v1.2.1.tar pingcap/tidb-backup-manager:v1.2.1
docker save -o bitnami-kubectl.tar bitnami/kubectl:latest
docker save -o advanced-statefulset-v0.3.3.tar pingcap/advanced-statefulset:v0.3.3
```
Expand All @@ -198,8 +198,8 @@ If your server cannot access the Internet, install TiDB Operator offline by the
{{< copyable "shell-regular" >}}

```shell
docker load -i tidb-operator-v1.2.0.tar
docker load -i tidb-backup-manager-v1.2.0.tar
docker load -i tidb-operator-v1.2.1.tar
docker load -i tidb-backup-manager-v1.2.1.tar
docker load -i bitnami-kubectl.tar
docker load -i advanced-statefulset-v0.3.3.tar
```
Expand Down
8 changes: 4 additions & 4 deletions en/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -303,17 +303,17 @@ This section describes how to install TiDB Operator using Helm 3.
{{< copyable "shell-regular" >}}

```shell
helm install --namespace tidb-admin tidb-operator pingcap/tidb-operator --version v1.2.0
helm install --namespace tidb-admin tidb-operator pingcap/tidb-operator --version v1.2.1
```

If you have trouble accessing Docker Hub, you can try images hosted in Alibaba Cloud:

{{< copyable "shell-regular" >}}

```
helm install --namespace tidb-admin tidb-operator pingcap/tidb-operator --version v1.2.0 \
--set operatorImage=registry.cn-beijing.aliyuncs.com/tidb/tidb-operator:v1.2.0 \
--set tidbBackupManagerImage=registry.cn-beijing.aliyuncs.com/tidb/tidb-backup-manager:v1.2.0 \
helm install --namespace tidb-admin tidb-operator pingcap/tidb-operator --version v1.2.1 \
--set operatorImage=registry.cn-beijing.aliyuncs.com/tidb/tidb-operator:v1.2.1 \
--set tidbBackupManagerImage=registry.cn-beijing.aliyuncs.com/tidb/tidb-backup-manager:v1.2.1 \
--set scheduler.kubeSchedulerImageName=registry.cn-hangzhou.aliyuncs.com/google_containers/kube-scheduler
```

Expand Down
20 changes: 10 additions & 10 deletions en/tidb-toolkit.md
Original file line number Diff line number Diff line change
Expand Up @@ -200,12 +200,12 @@ helm search repo pingcap

```
NAME CHART VERSION APP VERSION DESCRIPTION
pingcap/tidb-backup v1.2.0 A Helm chart for TiDB Backup or Restore
pingcap/tidb-cluster v1.2.0 A Helm chart for TiDB Cluster
pingcap/tidb-drainer v1.2.0 A Helm chart for TiDB Binlog drainer.
pingcap/tidb-lightning v1.2.0 A Helm chart for TiDB Lightning
pingcap/tidb-operator v1.2.0 v1.2.0 tidb-operator Helm chart for Kubernetes
pingcap/tikv-importer v1.2.0 A Helm chart for TiKV Importer
pingcap/tidb-backup v1.2.1 A Helm chart for TiDB Backup or Restore
pingcap/tidb-cluster v1.2.1 A Helm chart for TiDB Cluster
pingcap/tidb-drainer v1.2.1 A Helm chart for TiDB Binlog drainer.
pingcap/tidb-lightning v1.2.1 A Helm chart for TiDB Lightning
pingcap/tidb-operator v1.2.1 v1.2.1 tidb-operator Helm chart for Kubernetes
pingcap/tikv-importer v1.2.1 A Helm chart for TiKV Importer
```

When a new version of chart has been released, you can use `helm repo update` to update the repository cached locally:
Expand Down Expand Up @@ -267,17 +267,17 @@ Use the following command to download the chart file required for cluster instal
{{< copyable "shell-regular" >}}

```shell
wget http://charts.pingcap.org/tidb-operator-v1.2.0.tgz
wget http://charts.pingcap.org/tidb-drainer-v1.2.0.tgz
wget http://charts.pingcap.org/tidb-lightning-v1.2.0.tgz
wget http://charts.pingcap.org/tidb-operator-v1.2.1.tgz
wget http://charts.pingcap.org/tidb-drainer-v1.2.1.tgz
wget http://charts.pingcap.org/tidb-lightning-v1.2.1.tgz
```

Copy these chart files to the server and decompress them. You can use these charts to install the corresponding components by running the `helm install` command. Take `tidb-operator` as an example:

{{< copyable "shell-regular" >}}

```shell
tar zxvf tidb-operator.v1.2.0.tgz
tar zxvf tidb-operator.v1.2.1.tgz
helm install ${release_name} ./tidb-operator --namespace=${namespace}
```

Expand Down
56 changes: 28 additions & 28 deletions en/upgrade-tidb-operator.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ This document describes how to upgrade TiDB Operator and Kubernetes.
{{< copyable "shell-regular" >}}

```shell
kubectl apply -f https://raw.githubusercontent.com/pingcap/tidb-operator/v1.2.0/manifests/crd.yaml && \
kubectl apply -f https://raw.githubusercontent.com/pingcap/tidb-operator/v1.2.1/manifests/crd.yaml && \
kubectl get crd tidbclusters.pingcap.com
```

Expand All @@ -28,16 +28,16 @@ This document describes how to upgrade TiDB Operator and Kubernetes.
{{< copyable "shell-regular" >}}

```shell
mkdir -p ${HOME}/tidb-operator/v1.2.0 && \
helm inspect values pingcap/tidb-operator --version=v1.2.0 > ${HOME}/tidb-operator/v1.2.0/values-tidb-operator.yaml
mkdir -p ${HOME}/tidb-operator/v1.2.1 && \
helm inspect values pingcap/tidb-operator --version=v1.2.1 > ${HOME}/tidb-operator/v1.2.1/values-tidb-operator.yaml
```

3. In the `${HOME}/tidb-operator/v1.2.0/values-tidb-operator.yaml` file, modify the `operatorImage` version to the new TiDB Operator version. Merge the customized configuration in the old `values.yaml` file to the `${HOME}/tidb-operator/v1.2.0/values-tidb-operator.yaml` file, and then execute `helm upgrade`:
3. In the `${HOME}/tidb-operator/v1.2.1/values-tidb-operator.yaml` file, modify the `operatorImage` version to the new TiDB Operator version. Merge the customized configuration in the old `values.yaml` file to the `${HOME}/tidb-operator/v1.2.1/values-tidb-operator.yaml` file, and then execute `helm upgrade`:

{{< copyable "shell-regular" >}}

```shell
helm upgrade tidb-operator pingcap/tidb-operator --version=v1.2.0 -f ${HOME}/tidb-operator/v1.2.0/values-tidb-operator.yaml
helm upgrade tidb-operator pingcap/tidb-operator --version=v1.2.1 -f ${HOME}/tidb-operator/v1.2.1/values-tidb-operator.yaml
```

After all the Pods start normally, execute the following command to check the image of TiDB Operator:
Expand All @@ -48,13 +48,13 @@ This document describes how to upgrade TiDB Operator and Kubernetes.
kubectl get po -n tidb-admin -l app.kubernetes.io/instance=tidb-operator -o yaml | grep 'image:.*operator:'
```

If TiDB Operator is successfully upgraded, the expected output is as follows. `v1.2.0` represents the desired version of TiDB Operator.
If TiDB Operator is successfully upgraded, the expected output is as follows. `v1.2.1` represents the desired version of TiDB Operator.

```
image: pingcap/tidb-operator:v1.2.0
image: docker.io/pingcap/tidb-operator:v1.2.0
image: pingcap/tidb-operator:v1.2.0
image: docker.io/pingcap/tidb-operator:v1.2.0
image: pingcap/tidb-operator:v1.2.1
image: docker.io/pingcap/tidb-operator:v1.2.1
image: pingcap/tidb-operator:v1.2.1
image: docker.io/pingcap/tidb-operator:v1.2.1
```

> **Note:**
Expand All @@ -72,27 +72,27 @@ If your server cannot access the Internet, you can take the following steps to u
{{< copyable "shell-regular" >}}

```shell
wget https://raw.githubusercontent.com/pingcap/tidb-operator/v1.2.0/manifests/crd.yaml
wget https://raw.githubusercontent.com/pingcap/tidb-operator/v1.2.1/manifests/crd.yaml
```

2. Download the `tidb-operator` chart package file.

{{< copyable "shell-regular" >}}

```shell
wget http://charts.pingcap.org/tidb-operator-v1.2.0.tgz
wget http://charts.pingcap.org/tidb-operator-v1.2.1.tgz
```

3. Download the Docker images required for the new TiDB Operator version:

{{< copyable "shell-regular" >}}

```shell
docker pull pingcap/tidb-operator:v1.2.0
docker pull pingcap/tidb-backup-manager:v1.2.0
docker pull pingcap/tidb-operator:v1.2.1
docker pull pingcap/tidb-backup-manager:v1.2.1

docker save -o tidb-operator-v1.2.0.tar pingcap/tidb-operator:v1.2.0
docker save -o tidb-backup-manager-v1.2.0.tar pingcap/tidb-backup-manager:v1.2.0
docker save -o tidb-operator-v1.2.1.tar pingcap/tidb-operator:v1.2.1
docker save -o tidb-backup-manager-v1.2.1.tar pingcap/tidb-backup-manager:v1.2.1
```

2. Upload the downloaded files and images to the server that needs to be upgraded, and then take the following steps for installation:
Expand All @@ -110,26 +110,26 @@ If your server cannot access the Internet, you can take the following steps to u
{{< copyable "shell-regular" >}}

```shell
tar zxvf tidb-operator-v1.2.0.tgz && \
mkdir -p ${HOME}/tidb-operator/v1.2.0 &&
cp tidb-operator/values.yaml ${HOME}/tidb-operator/v1.2.0/values-tidb-operator.yaml
tar zxvf tidb-operator-v1.2.1.tgz && \
mkdir -p ${HOME}/tidb-operator/v1.2.1 &&
cp tidb-operator/values.yaml ${HOME}/tidb-operator/v1.2.1/values-tidb-operator.yaml
```

3. Install the Docker images on the server:

{{< copyable "shell-regular" >}}

```shell
docker load -i tidb-operator-v1.2.0.tar
docker load -i tidb-backup-manager-v1.2.0.tar
docker load -i tidb-operator-v1.2.1.tar
docker load -i tidb-backup-manager-v1.2.1.tar
```

3. In the `${HOME}/tidb-operator/v1.2.0/values-tidb-operator.yaml` file, modify the `operatorImage` version to the new TiDB Operator version. Merge the customized configuration in the old `values.yaml` file to the `${HOME}/tidb-operator/v1.2.0/values-tidb-operator.yaml` file, and then execute `helm upgrade`:
3. In the `${HOME}/tidb-operator/v1.2.1/values-tidb-operator.yaml` file, modify the `operatorImage` version to the new TiDB Operator version. Merge the customized configuration in the old `values.yaml` file to the `${HOME}/tidb-operator/v1.2.1/values-tidb-operator.yaml` file, and then execute `helm upgrade`:

{{< copyable "shell-regular" >}}

```shell
helm upgrade tidb-operator ./tidb-operator --version=v1.2.0 -f ${HOME}/tidb-operator/v1.2.0/values-tidb-operator.yaml
helm upgrade tidb-operator ./tidb-operator --version=v1.2.1 -f ${HOME}/tidb-operator/v1.2.1/values-tidb-operator.yaml
```

After all the Pods start normally, execute the following command to check the image version of TiDB Operator:
Expand All @@ -140,13 +140,13 @@ If your server cannot access the Internet, you can take the following steps to u
kubectl get po -n tidb-admin -l app.kubernetes.io/instance=tidb-operator -o yaml | grep 'image:.*operator:'
```

If TiDB Operator is successfully upgraded, the expected output is as follows. `v1.2.0` represents the new version of TiDB Operator.
If TiDB Operator is successfully upgraded, the expected output is as follows. `v1.2.1` represents the new version of TiDB Operator.

```
image: pingcap/tidb-operator:v1.2.0
image: docker.io/pingcap/tidb-operator:v1.2.0
image: pingcap/tidb-operator:v1.2.0
image: docker.io/pingcap/tidb-operator:v1.2.0
image: pingcap/tidb-operator:v1.2.1
image: docker.io/pingcap/tidb-operator:v1.2.1
image: pingcap/tidb-operator:v1.2.1
image: docker.io/pingcap/tidb-operator:v1.2.1
```

> **Note:**
Expand Down
6 changes: 3 additions & 3 deletions zh/cheat-sheet.md
Original file line number Diff line number Diff line change
Expand Up @@ -484,7 +484,7 @@ helm inspect values ${chart_name} --version=${chart_version} > values.yaml
{{< copyable "shell-regular" >}}

```shell
helm inspect values pingcap/tidb-operator --version=v1.2.0 > values-tidb-operator.yaml
helm inspect values pingcap/tidb-operator --version=v1.2.1 > values-tidb-operator.yaml
```

### 使用 Helm Chart 部署
Expand All @@ -500,7 +500,7 @@ helm install ${name} ${chart_name} --namespace=${namespace} --version=${chart_ve
{{< copyable "shell-regular" >}}

```shell
helm install tidb-operator pingcap/tidb-operator --namespace=tidb-admin --version=v1.2.0 -f values-tidb-operator.yaml
helm install tidb-operator pingcap/tidb-operator --namespace=tidb-admin --version=v1.2.1 -f values-tidb-operator.yaml
```

### 查看已经部署的 Helm Release
Expand All @@ -524,7 +524,7 @@ helm upgrade ${name} ${chart_name} --version=${chart_version} -f ${values_file}
{{< copyable "shell-regular" >}}

```shell
helm upgrade tidb-operator pingcap/tidb-operator --version=v1.2.0 -f values-tidb-operator.yaml
helm upgrade tidb-operator pingcap/tidb-operator --version=v1.2.1 -f values-tidb-operator.yaml
```

### 删除 Helm Release
Expand Down
2 changes: 1 addition & 1 deletion zh/deploy-on-alibaba-cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ summary: 介绍如何在阿里云上部署 TiDB 集群。
tikv_count = 3
tidb_count = 2
pd_count = 3
operator_version = "v1.2.0"
operator_version = "v1.2.1"
```

如果需要在集群中部署 TiFlash,需要在 `terraform.tfvars` 中设置 `create_tiflash_node_pool = true`,也可以设置 `tiflash_count` 和 `tiflash_instance_type` 来配置 TiFlash 节点池的节点数量和实例类型,`tiflash_count` 默认为 `2`,`tiflash_instance_type` 默认为 `ecs.i2.2xlarge`。
Expand Down
2 changes: 1 addition & 1 deletion zh/deploy-tidb-from-kubernetes-gke.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ kubectl get crd tidbclusters.pingcap.com

```shell
kubectl create namespace tidb-admin
helm install --namespace tidb-admin tidb-operator pingcap/tidb-operator --version v1.2.0
helm install --namespace tidb-admin tidb-operator pingcap/tidb-operator --version v1.2.1
kubectl get po -n tidb-admin -l app.kubernetes.io/name=tidb-operator
```

Expand Down
Loading