Skip to content

Commit

Permalink
en,zh: bump operator to v1.5.2 (#2486)
Browse files Browse the repository at this point in the history
  • Loading branch information
csuzhangxc authored Jan 19, 2024
1 parent 0083c3c commit 18b179b
Show file tree
Hide file tree
Showing 15 changed files with 121 additions and 121 deletions.
6 changes: 3 additions & 3 deletions en/cheat-sheet.md
Original file line number Diff line number Diff line change
Expand Up @@ -493,7 +493,7 @@ For example:
{{< copyable "shell-regular" >}}

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

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

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

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

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

### Delete Helm release
Expand Down
8 changes: 4 additions & 4 deletions en/deploy-br-federation.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ To deploy the BR Federation, you need to select one Kubernetes cluster as the co
The BR Federation uses [Custom Resource Definition (CRD)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#customresourcedefinitions) to extend Kubernetes. Before using the BR Federation, you must create the CRD in your Kubernetes cluster. After using the BR Federation Manager, you only need to perform the operation once.

```shell
kubectl create -f https://raw.githubusercontent.com/pingcap/tidb-operator/v1.5.1/manifests/federation-crd.yaml
kubectl create -f https://raw.githubusercontent.com/pingcap/tidb-operator/v1.5.2/manifests/federation-crd.yaml
```

### Step 2.2: Prepare the kubeconfig secret
Expand Down Expand Up @@ -190,7 +190,7 @@ This section describes how to install the BR Federation using [Helm 3](https://h
4. Install the BR Federation:

```shell
helm install --namespace br-fed-admin br-federation pingcap/br-federation --version v1.5.1
helm install --namespace br-fed-admin br-federation pingcap/br-federation --version v1.5.2
```

</div>
Expand Down Expand Up @@ -218,15 +218,15 @@ This section describes how to install the BR Federation using [Helm 3](https://h

```shell
mkdir -p ${HOME}/br-federation && \
helm inspect values pingcap/br-federation --version=v1.5.1 > ${HOME}/br-federation/values.yaml
helm inspect values pingcap/br-federation --version=v1.5.2 > ${HOME}/br-federation/values.yaml
```

5. Configure the BR Federation by modifying fields such as `image`, `limits`, `requests`, and `replicas` according to your needs.

6. Deploy the BR Federation.

```shell
helm install --namespace br-fed-admin br-federation pingcap/br-federation --version v1.5.1 -f ${HOME}/br-federation/values.yaml && \
helm install --namespace br-fed-admin br-federation pingcap/br-federation --version v1.5.2 -f ${HOME}/br-federation/values.yaml && \
kubectl get po -n br-fed-admin -l app.kubernetes.io/instance=br-federation
```

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 @@ -89,7 +89,7 @@ All the instances except ACK mandatory workers are deployed across availability
tikv_count = 3
tidb_count = 2
pd_count = 3
operator_version = "v1.5.1"
operator_version = "v1.5.2"
```

* 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 @@ -109,7 +109,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.5.1
helm install --namespace tidb-admin tidb-operator pingcap/tidb-operator --version v1.5.2
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 @@ -101,7 +101,7 @@ When you use TiDB Operator, `tidb-scheduler` is not mandatory. Refer to [tidb-sc

> **Note:**
>
> `${chart_version}` represents the chart version of TiDB Operator. For example, `v1.5.1`. 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.5.2`. 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 @@ -149,15 +149,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.5.1.tgz
wget http://charts.pingcap.org/tidb-operator-v1.5.2.tgz
```
Copy the `tidb-operator-v1.5.1.tgz` file to the target server and extract it to the current directory:
Copy the `tidb-operator-v1.5.2.tgz` file to the target server and extract it to the current directory:
{{< copyable "shell-regular" >}}
```shell
tar zxvf tidb-operator.v1.5.1.tgz
tar zxvf tidb-operator.v1.5.2.tgz
```
2. Download the Docker images used by TiDB Operator
Expand All @@ -169,8 +169,8 @@ If your server cannot access the Internet, install TiDB Operator offline by the
{{< copyable "" >}}
```shell
pingcap/tidb-operator:v1.5.1
pingcap/tidb-backup-manager:v1.5.1
pingcap/tidb-operator:v1.5.2
pingcap/tidb-backup-manager:v1.5.2
bitnami/kubectl:latest
pingcap/advanced-statefulset:v0.3.3
k8s.gcr.io/kube-scheduler:v1.16.9
Expand All @@ -183,13 +183,13 @@ If your server cannot access the Internet, install TiDB Operator offline by the
{{< copyable "shell-regular" >}}
```shell
docker pull pingcap/tidb-operator:v1.5.1
docker pull pingcap/tidb-backup-manager:v1.5.1
docker pull pingcap/tidb-operator:v1.5.2
docker pull pingcap/tidb-backup-manager:v1.5.2
docker pull bitnami/kubectl:latest
docker pull pingcap/advanced-statefulset:v0.3.3
docker save -o tidb-operator-v1.5.1.tar pingcap/tidb-operator:v1.5.1
docker save -o tidb-backup-manager-v1.5.1.tar pingcap/tidb-backup-manager:v1.5.1
docker save -o tidb-operator-v1.5.2.tar pingcap/tidb-operator:v1.5.2
docker save -o tidb-backup-manager-v1.5.2.tar pingcap/tidb-backup-manager:v1.5.2
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 @@ -199,8 +199,8 @@ If your server cannot access the Internet, install TiDB Operator offline by the
{{< copyable "shell-regular" >}}
```shell
docker load -i tidb-operator-v1.5.1.tar
docker load -i tidb-backup-manager-v1.5.1.tar
docker load -i tidb-operator-v1.5.2.tar
docker load -i tidb-backup-manager-v1.5.2.tar
docker load -i bitnami-kubectl.tar
docker load -i advanced-statefulset-v0.3.3.tar
```
Expand Down
2 changes: 1 addition & 1 deletion en/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,7 @@ To install TiDB Operator, you can use [Helm 3](https://helm.sh/docs/intro/instal
3. Install TiDB Operator:

```shell
helm install --namespace tidb-admin tidb-operator pingcap/tidb-operator --version v1.5.1
helm install --namespace tidb-admin tidb-operator pingcap/tidb-operator --version v1.5.2
```

<details>
Expand Down
18 changes: 9 additions & 9 deletions en/tidb-toolkit.md
Original file line number Diff line number Diff line change
Expand Up @@ -200,11 +200,11 @@ helm search repo pingcap

```
NAME CHART VERSION APP VERSION DESCRIPTION
pingcap/tidb-backup v1.5.1 A Helm chart for TiDB Backup or Restore
pingcap/tidb-cluster v1.5.1 A Helm chart for TiDB Cluster
pingcap/tidb-drainer v1.5.1 A Helm chart for TiDB Binlog drainer.
pingcap/tidb-lightning v1.5.1 A Helm chart for TiDB Lightning
pingcap/tidb-operator v1.5.1 v1.5.1 tidb-operator Helm chart for Kubernetes
pingcap/tidb-backup v1.5.2 A Helm chart for TiDB Backup or Restore
pingcap/tidb-cluster v1.5.2 A Helm chart for TiDB Cluster
pingcap/tidb-drainer v1.5.2 A Helm chart for TiDB Binlog drainer.
pingcap/tidb-lightning v1.5.2 A Helm chart for TiDB Lightning
pingcap/tidb-operator v1.5.2 v1.5.2 tidb-operator Helm chart for Kubernetes
```
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 @@ -266,17 +266,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.5.1.tgz
wget http://charts.pingcap.org/tidb-drainer-v1.5.1.tgz
wget http://charts.pingcap.org/tidb-lightning-v1.5.1.tgz
wget http://charts.pingcap.org/tidb-operator-v1.5.2.tgz
wget http://charts.pingcap.org/tidb-drainer-v1.5.2.tgz
wget http://charts.pingcap.org/tidb-lightning-v1.5.2.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.5.1.tgz
tar zxvf tidb-operator.v1.5.2.tgz
helm install ${release_name} ./tidb-operator --namespace=${namespace}
```

Expand Down
60 changes: 30 additions & 30 deletions en/upgrade-tidb-operator.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,27 +60,27 @@ If your server has access to the internet, you can perform online upgrade by tak
kubectl get crd tidbclusters.pingcap.com
```

This document takes TiDB v1.5.1 as an example. You can replace `${operator_version}` with the specific version you want to upgrade to.
This document takes TiDB v1.5.2 as an example. You can replace `${operator_version}` with the specific version you want to upgrade to.

3. Get the `values.yaml` file of the `tidb-operator` chart:

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

```bash
mkdir -p ${HOME}/tidb-operator/v1.5.1 && \
helm inspect values pingcap/tidb-operator --version=v1.5.1 > ${HOME}/tidb-operator/v1.5.1/values-tidb-operator.yaml
mkdir -p ${HOME}/tidb-operator/v1.5.2 && \
helm inspect values pingcap/tidb-operator --version=v1.5.2 > ${HOME}/tidb-operator/v1.5.2/values-tidb-operator.yaml
```

4. In the `${HOME}/tidb-operator/v1.5.1/values-tidb-operator.yaml` file, modify the `operatorImage` version to the new TiDB Operator version.
4. In the `${HOME}/tidb-operator/v1.5.2/values-tidb-operator.yaml` file, modify the `operatorImage` version to the new TiDB Operator version.

5. If you have added customized configuration in the old `values.yaml` file, merge your customized configuration to the `${HOME}/tidb-operator/v1.5.1/values-tidb-operator.yaml` file.
5. If you have added customized configuration in the old `values.yaml` file, merge your customized configuration to the `${HOME}/tidb-operator/v1.5.2/values-tidb-operator.yaml` file.

6. Perform upgrade:

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

```bash
helm upgrade tidb-operator pingcap/tidb-operator --version=v1.5.1 -f ${HOME}/tidb-operator/v1.5.1/values-tidb-operator.yaml -n tidb-admin
helm upgrade tidb-operator pingcap/tidb-operator --version=v1.5.2 -f ${HOME}/tidb-operator/v1.5.2/values-tidb-operator.yaml -n tidb-admin
```

7. After all the Pods start normally, check the image of TiDB Operator:
Expand All @@ -91,13 +91,13 @@ If your server has access to the internet, you can perform online upgrade by tak
kubectl get po -n tidb-admin -l app.kubernetes.io/instance=tidb-operator -o yaml | grep 'image:.*operator:'
```

If you see a similar output as follows, TiDB Operator is successfully upgraded. `v1.5.1` represents the TiDB Operator version you have upgraded to.
If you see a similar output as follows, TiDB Operator is successfully upgraded. `v1.5.2` represents the TiDB Operator version you have upgraded to.

```
image: pingcap/tidb-operator:v1.5.1
image: docker.io/pingcap/tidb-operator:v1.5.1
image: pingcap/tidb-operator:v1.5.1
image: docker.io/pingcap/tidb-operator:v1.5.1
image: pingcap/tidb-operator:v1.5.2
image: docker.io/pingcap/tidb-operator:v1.5.2
image: pingcap/tidb-operator:v1.5.2
image: docker.io/pingcap/tidb-operator:v1.5.2
```

## Offline upgrade
Expand All @@ -124,26 +124,26 @@ If your server cannot access the Internet, you can offline upgrade by taking the
wget -O crd.yaml https://raw.githubusercontent.com/pingcap/tidb-operator/${operator_version}/manifests/crd_v1beta1.yaml
```

This document takes TiDB v1.5.1 as an example. You can replace `${operator_version}` with the specific version you want to upgrade to.
This document takes TiDB v1.5.2 as an example. You can replace `${operator_version}` with the specific version you want to upgrade to.

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

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

```bash
wget http://charts.pingcap.org/tidb-operator-v1.5.1.tgz
wget http://charts.pingcap.org/tidb-operator-v1.5.2.tgz
```

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

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

```bash
docker pull pingcap/tidb-operator:v1.5.1
docker pull pingcap/tidb-backup-manager:v1.5.1
docker pull pingcap/tidb-operator:v1.5.2
docker pull pingcap/tidb-backup-manager:v1.5.2
docker save -o tidb-operator-v1.5.1.tar pingcap/tidb-operator:v1.5.1
docker save -o tidb-backup-manager-v1.5.1.tar pingcap/tidb-backup-manager:v1.5.1
docker save -o tidb-operator-v1.5.2.tar pingcap/tidb-operator:v1.5.2
docker save -o tidb-backup-manager-v1.5.2.tar pingcap/tidb-backup-manager:v1.5.2
```

2. Upload the downloaded files and images to the server where TiDB Operator is deployed, and install the new TiDB Operator version:
Expand Down Expand Up @@ -171,30 +171,30 @@ If your server cannot access the Internet, you can offline upgrade by taking the
{{< copyable "shell-regular" >}}

```bash
tar zxvf tidb-operator-v1.5.1.tgz && \
mkdir -p ${HOME}/tidb-operator/v1.5.1 && \
cp tidb-operator/values.yaml ${HOME}/tidb-operator/v1.5.1/values-tidb-operator.yaml
tar zxvf tidb-operator-v1.5.2.tgz && \
mkdir -p ${HOME}/tidb-operator/v1.5.2 && \
cp tidb-operator/values.yaml ${HOME}/tidb-operator/v1.5.2/values-tidb-operator.yaml
```

4. Install the Docker images on the server:

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

```bash
docker load -i tidb-operator-v1.5.1.tar && \
docker load -i tidb-backup-manager-v1.5.1.tar
docker load -i tidb-operator-v1.5.2.tar && \
docker load -i tidb-backup-manager-v1.5.2.tar
```

3. In the `${HOME}/tidb-operator/v1.5.1/values-tidb-operator.yaml` file, modify the `operatorImage` version to the new TiDB Operator version.
3. In the `${HOME}/tidb-operator/v1.5.2/values-tidb-operator.yaml` file, modify the `operatorImage` version to the new TiDB Operator version.

4. If you have added customized configuration in the old `values.yaml` file, merge your customized configuration to the `${HOME}/tidb-operator/v1.5.1/values-tidb-operator.yaml` file.
4. If you have added customized configuration in the old `values.yaml` file, merge your customized configuration to the `${HOME}/tidb-operator/v1.5.2/values-tidb-operator.yaml` file.

5. Perform upgrade:

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

```bash
helm upgrade tidb-operator ./tidb-operator --version=v1.5.1 -f ${HOME}/tidb-operator/v1.5.1/values-tidb-operator.yaml
helm upgrade tidb-operator ./tidb-operator --version=v1.5.2 -f ${HOME}/tidb-operator/v1.5.2/values-tidb-operator.yaml
```

6. After all the Pods start normally, check the image version of TiDB Operator:
Expand All @@ -205,13 +205,13 @@ If your server cannot access the Internet, you can offline upgrade by taking the
kubectl get po -n tidb-admin -l app.kubernetes.io/instance=tidb-operator -o yaml | grep 'image:.*operator:'
```

If you see a similar output as follows, TiDB Operator is successfully upgraded. `v1.5.1` represents the TiDB Operator version you have upgraded to.
If you see a similar output as follows, TiDB Operator is successfully upgraded. `v1.5.2` represents the TiDB Operator version you have upgraded to.

```
image: pingcap/tidb-operator:v1.5.1
image: docker.io/pingcap/tidb-operator:v1.5.1
image: pingcap/tidb-operator:v1.5.1
image: docker.io/pingcap/tidb-operator:v1.5.1
image: pingcap/tidb-operator:v1.5.2
image: docker.io/pingcap/tidb-operator:v1.5.2
image: pingcap/tidb-operator:v1.5.2
image: docker.io/pingcap/tidb-operator:v1.5.2
```

> **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 @@ -493,7 +493,7 @@ helm inspect values ${chart_name} --version=${chart_version} > values.yaml
{{< copyable "shell-regular" >}}

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

### 使用 Helm Chart 部署
Expand All @@ -509,7 +509,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.5.1 -f values-tidb-operator.yaml
helm install tidb-operator pingcap/tidb-operator --namespace=tidb-admin --version=v1.5.2 -f values-tidb-operator.yaml
```

### 查看已经部署的 Helm Release
Expand All @@ -533,7 +533,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.5.1 -f values-tidb-operator.yaml
helm upgrade tidb-operator pingcap/tidb-operator --version=v1.5.2 -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 @@ -89,7 +89,7 @@ aliases: ['/docs-cn/tidb-in-kubernetes/dev/deploy-on-alibaba-cloud/']
tikv_count = 3
tidb_count = 2
pd_count = 3
operator_version = "v1.5.1"
operator_version = "v1.5.2"
```

如果需要在集群中部署 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 @@ -106,7 +106,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.5.1
helm install --namespace tidb-admin tidb-operator pingcap/tidb-operator --version v1.5.2
kubectl get po -n tidb-admin -l app.kubernetes.io/name=tidb-operator
```

Expand Down
Loading

0 comments on commit 18b179b

Please sign in to comment.