Skip to content

Commit

Permalink
en,zh: bump operator to v1.6.0-beta.1
Browse files Browse the repository at this point in the history
  • Loading branch information
csuzhangxc committed Mar 25, 2024
1 parent a44aa6c commit 8a6d4fb
Show file tree
Hide file tree
Showing 29 changed files with 181 additions and 181 deletions.
4 changes: 2 additions & 2 deletions en/advanced-statefulset.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,15 @@ The [advanced StatefulSet controller](https://github.com/pingcap/advanced-statef
{{< copyable "shell-regular" >}}

```shell
kubectl apply -f https://raw.githubusercontent.com/pingcap/tidb-operator/master/manifests/advanced-statefulset-crd.v1beta1.yaml
kubectl apply -f https://raw.githubusercontent.com/pingcap/tidb-operator/v1.6.0-beta.1/manifests/advanced-statefulset-crd.v1beta1.yaml
```

* For Kubernetes versions >= 1.16:

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

```
kubectl apply -f https://raw.githubusercontent.com/pingcap/tidb-operator/master/manifests/advanced-statefulset-crd.v1.yaml
kubectl apply -f https://raw.githubusercontent.com/pingcap/tidb-operator/v1.6.0-beta.1/manifests/advanced-statefulset-crd.v1.yaml
```

2. Enable the `AdvancedStatefulSet` feature in `values.yaml` of the TiDB Operator chart:
Expand Down
4 changes: 2 additions & 2 deletions en/aggregate-multiple-cluster-monitor-data.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Thanos provides [Thanos Query](https://thanos.io/tip/components/query.md/) compo
{{< copyable "shell-regular" >}}

```shell
kubectl -n ${namespace} apply -f https://raw.githubusercontent.com/pingcap/tidb-operator/master/examples/monitor-with-thanos/tidb-monitor.yaml
kubectl -n ${namespace} apply -f https://raw.githubusercontent.com/pingcap/tidb-operator/v1.6.0-beta.1/examples/monitor-with-thanos/tidb-monitor.yaml
```

2. Deploy the Thanos Query component.
Expand All @@ -34,7 +34,7 @@ Thanos provides [Thanos Query](https://thanos.io/tip/components/query.md/) compo
{{< copyable "shell-regular" >}}

```
curl -sl -O https://raw.githubusercontent.com/pingcap/tidb-operator/master/examples/monitor-with-thanos/thanos-query.yaml
curl -sl -O https://raw.githubusercontent.com/pingcap/tidb-operator/v1.6.0-beta.1/examples/monitor-with-thanos/thanos-query.yaml
```

2. Manually modify the `--store` parameter in the `thanos-query.yaml` file by updating `basic-prometheus:10901` to `basic-prometheus.${namespace}:10901`.
Expand Down
4 changes: 2 additions & 2 deletions en/backup-to-s3.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,12 +49,12 @@ GRANT

### Step 1: Prepare for ad-hoc full backup

1. Execute the following command to create the role-based access control (RBAC) resources in the `tidb-cluster` namespace based on [backup-rbac.yaml](https://raw.githubusercontent.com/pingcap/tidb-operator/master/manifests/backup/backup-rbac.yaml):
1. Execute the following command to create the role-based access control (RBAC) resources in the `tidb-cluster` namespace based on [backup-rbac.yaml](https://raw.githubusercontent.com/pingcap/tidb-operator/v1.6.0-beta.1/manifests/backup/backup-rbac.yaml):

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

```shell
kubectl apply -f https://raw.githubusercontent.com/pingcap/tidb-operator/master/manifests/backup/backup-rbac.yaml -n tidb-cluster
kubectl apply -f https://raw.githubusercontent.com/pingcap/tidb-operator/v1.6.0-beta.1/manifests/backup/backup-rbac.yaml -n tidb-cluster
```

2. Grant permissions to the remote storage.
Expand Down
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.2 > values-tidb-operator.yaml
helm inspect values pingcap/tidb-operator --version=v1.6.0-beta.1 > 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.2 -f values-tidb-operator.yaml
helm install tidb-operator pingcap/tidb-operator --namespace=tidb-admin --version=v1.6.0-beta.1 -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.2 -f values-tidb-operator.yaml
helm upgrade tidb-operator pingcap/tidb-operator --version=v1.6.0-beta.1 -f values-tidb-operator.yaml
```

### Delete Helm release
Expand Down
4 changes: 2 additions & 2 deletions en/configure-storage-class.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ The `/mnt/ssd`, `/mnt/sharedssd`, `/mnt/monitoring`, and `/mnt/backup` directori
1. Download the deployment file for the local-volume-provisioner.
```shell
wget https://raw.githubusercontent.com/pingcap/tidb-operator/master/examples/local-pv/local-volume-provisioner.yaml
wget https://raw.githubusercontent.com/pingcap/tidb-operator/v1.6.0-beta.1/examples/local-pv/local-volume-provisioner.yaml
```
2. If you are using the same discovery directory as described in [Step 1: Pre-allocate local storage](#step-1-pre-allocate-local-storage), you can skip this step. If you are using a different path for the discovery directory than in the previous step, you need to modify the ConfigMap and DaemonSet spec.
Expand Down Expand Up @@ -163,7 +163,7 @@ The `/mnt/ssd`, `/mnt/sharedssd`, `/mnt/monitoring`, and `/mnt/backup` directori
3. Deploy the `local-volume-provisioner`.
```shell
kubectl apply -f https://raw.githubusercontent.com/pingcap/tidb-operator/master/manifests/local-dind/local-volume-provisioner.yaml
kubectl apply -f https://raw.githubusercontent.com/pingcap/tidb-operator/v1.6.0-beta.1/manifests/local-dind/local-volume-provisioner.yaml
```
4. Check the status of the Pod and PV.
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.2/manifests/federation-crd.yaml
kubectl create -f https://raw.githubusercontent.com/pingcap/tidb-operator/v1.6.0-beta.1/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.2
helm install --namespace br-fed-admin br-federation pingcap/br-federation --version v1.6.0-beta.1
```

</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.2 > ${HOME}/br-federation/values.yaml
helm inspect values pingcap/br-federation --version=v1.6.0-beta.1 > ${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.2 -f ${HOME}/br-federation/values.yaml && \
helm install --namespace br-fed-admin br-federation pingcap/br-federation --version v1.6.0-beta.1 -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.2"
operator_version = "v1.6.0-beta.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
8 changes: 4 additions & 4 deletions en/deploy-on-aws-eks.md
Original file line number Diff line number Diff line change
Expand Up @@ -341,7 +341,7 @@ The following `c5d.4xlarge` example shows how to configure StorageClass for the

2. [Mount the local storage](https://github.com/kubernetes-sigs/sig-storage-local-static-provisioner/blob/master/docs/operations.md#use-a-whole-disk-as-a-filesystem-pv) to the `/mnt/ssd` directory.

3. According to the mounting configuration, modify the [local-volume-provisioner.yaml](https://raw.githubusercontent.com/pingcap/tidb-operator/master/manifests/eks/local-volume-provisioner.yaml) file.
3. According to the mounting configuration, modify the [local-volume-provisioner.yaml](https://raw.githubusercontent.com/pingcap/tidb-operator/v1.6.0-beta.1/manifests/eks/local-volume-provisioner.yaml) file.

4. Deploy and create a `local-storage` storage class using the modified `local-volume-provisioner.yaml` file.

Expand Down Expand Up @@ -386,9 +386,9 @@ First, download the sample `TidbCluster` and `TidbMonitor` configuration files:
{{< copyable "shell-regular" >}}

```shell
curl -O https://raw.githubusercontent.com/pingcap/tidb-operator/master/examples/aws/tidb-cluster.yaml && \
curl -O https://raw.githubusercontent.com/pingcap/tidb-operator/master/examples/aws/tidb-monitor.yaml && \
curl -O https://raw.githubusercontent.com/pingcap/tidb-operator/master/examples/aws/tidb-dashboard.yaml
curl -O https://raw.githubusercontent.com/pingcap/tidb-operator/v1.6.0-beta.1/examples/aws/tidb-cluster.yaml && \
curl -O https://raw.githubusercontent.com/pingcap/tidb-operator/v1.6.0-beta.1/examples/aws/tidb-monitor.yaml && \
curl -O https://raw.githubusercontent.com/pingcap/tidb-operator/v1.6.0-beta.1/examples/aws/tidb-dashboard.yaml
```

Refer to [configure the TiDB cluster](configure-a-tidb-cluster.md) to further customize and configure the CR before applying.
Expand Down
8 changes: 4 additions & 4 deletions en/deploy-on-azure-aks.md
Original file line number Diff line number Diff line change
Expand Up @@ -238,9 +238,9 @@ First, download the sample `TidbCluster` and `TidbMonitor` configuration files:
{{< copyable "shell-regular" >}}

```shell
curl -O https://raw.githubusercontent.com/pingcap/tidb-operator/master/examples/aks/tidb-cluster.yaml && \
curl -O https://raw.githubusercontent.com/pingcap/tidb-operator/master/examples/aks/tidb-monitor.yaml && \
curl -O https://raw.githubusercontent.com/pingcap/tidb-operator/master/examples/aks/tidb-dashboard.yaml
curl -O https://raw.githubusercontent.com/pingcap/tidb-operator/v1.6.0-beta.1/examples/aks/tidb-cluster.yaml && \
curl -O https://raw.githubusercontent.com/pingcap/tidb-operator/v1.6.0-beta.1/examples/aks/tidb-monitor.yaml && \
curl -O https://raw.githubusercontent.com/pingcap/tidb-operator/v1.6.0-beta.1/examples/aks/tidb-dashboard.yaml
```

Refer to [configure the TiDB cluster](configure-a-tidb-cluster.md) to further customize and configure the CR before applying.
Expand Down Expand Up @@ -608,7 +608,7 @@ For instance types that provide local disks, refer to [Lsv2-series](https://docs
{{< copyable "shell-regular" >}}
```shell
kubectl apply -f https://raw.githubusercontent.com/pingcap/tidb-operator/master/manifests/eks/local-volume-provisioner.yaml
kubectl apply -f https://raw.githubusercontent.com/pingcap/tidb-operator/v1.6.0-beta.1/manifests/eks/local-volume-provisioner.yaml
```
3. Use local storage.
Expand Down
8 changes: 4 additions & 4 deletions en/deploy-on-gcp-gke.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ If you need to simulate bare-metal performance, some Google Cloud instance types
{{< copyable "shell-regular" >}}

```shell
kubectl apply -f https://raw.githubusercontent.com/pingcap/tidb-operator/master/manifests/gke/local-ssd-provision/local-ssd-provision.yaml
kubectl apply -f https://raw.githubusercontent.com/pingcap/tidb-operator/v1.6.0-beta.1/manifests/gke/local-ssd-provision/local-ssd-provision.yaml
```

3. Use the local storage.
Expand Down Expand Up @@ -174,9 +174,9 @@ First, download the sample `TidbCluster` and `TidbMonitor` configuration files:
{{< copyable "shell-regular" >}}

```shell
curl -O https://raw.githubusercontent.com/pingcap/tidb-operator/master/examples/gcp/tidb-cluster.yaml && \
curl -O https://raw.githubusercontent.com/pingcap/tidb-operator/master/examples/gcp/tidb-monitor.yaml && \
curl -O https://raw.githubusercontent.com/pingcap/tidb-operator/master/examples/gcp/tidb-dashboard.yaml
curl -O https://raw.githubusercontent.com/pingcap/tidb-operator/v1.6.0-beta.1/examples/gcp/tidb-cluster.yaml && \
curl -O https://raw.githubusercontent.com/pingcap/tidb-operator/v1.6.0-beta.1/examples/gcp/tidb-monitor.yaml && \
curl -O https://raw.githubusercontent.com/pingcap/tidb-operator/v1.6.0-beta.1/examples/gcp/tidb-dashboard.yaml
```

Refer to [configure the TiDB cluster](configure-a-tidb-cluster.md) to further customize and configure the CR before applying.
Expand Down
8 changes: 4 additions & 4 deletions en/deploy-tidb-from-kubernetes-gke.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ If you see `Ready` for all nodes, congratulations. You've set up your first Kube
TiDB Operator uses [Custom Resource Definition (CRD)](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#customresourcedefinitions) to extend Kubernetes. Therefore, to use TiDB Operator, you must first create the `TidbCluster` CRD.

```shell
kubectl create -f https://raw.githubusercontent.com/pingcap/tidb-operator/master/manifests/crd.yaml && \
kubectl create -f https://raw.githubusercontent.com/pingcap/tidb-operator/v1.6.0-beta.1/manifests/crd.yaml && \
kubectl get crd tidbclusters.pingcap.com
```

Expand All @@ -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.2
helm install --namespace tidb-admin tidb-operator pingcap/tidb-operator --version v1.6.0-beta.1
kubectl get po -n tidb-admin -l app.kubernetes.io/name=tidb-operator
```

Expand All @@ -126,13 +126,13 @@ To deploy the TiDB cluster, perform the following steps:
2. Deploy the TiDB cluster:

``` shell
kubectl apply -f https://raw.githubusercontent.com/pingcap/tidb-operator/master/examples/basic/tidb-cluster.yaml -n demo
kubectl apply -f https://raw.githubusercontent.com/pingcap/tidb-operator/v1.6.0-beta.1/examples/basic/tidb-cluster.yaml -n demo
```

3. Deploy the TiDB cluster monitor:

``` shell
kubectl apply -f https://raw.githubusercontent.com/pingcap/tidb-operator/master/examples/basic/tidb-monitor.yaml -n demo
kubectl apply -f https://raw.githubusercontent.com/pingcap/tidb-operator/v1.6.0-beta.1/examples/basic/tidb-monitor.yaml -n demo
```

4. View the Pod status:
Expand Down
28 changes: 14 additions & 14 deletions en/deploy-tidb-operator.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,15 +45,15 @@ TiDB Operator uses [Custom Resource Definition (CRD)](https://kubernetes.io/docs
{{< copyable "shell-regular" >}}

```shell
kubectl create -f https://raw.githubusercontent.com/pingcap/tidb-operator/master/manifests/crd.yaml
kubectl create -f https://raw.githubusercontent.com/pingcap/tidb-operator/v1.6.0-beta.1/manifests/crd.yaml
```

If the server cannot access the Internet, you need to download the `crd.yaml` file on a machine with Internet access before installing:

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

```shell
wget https://raw.githubusercontent.com/pingcap/tidb-operator/master/manifests/crd.yaml
wget https://raw.githubusercontent.com/pingcap/tidb-operator/v1.6.0-beta.1/manifests/crd.yaml
kubectl create -f ./crd.yaml
```

Expand Down 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.2`. 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.6.0-beta.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 @@ -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.2.tgz
wget http://charts.pingcap.org/tidb-operator-v1.6.0-beta.1.tgz
```
Copy the `tidb-operator-v1.5.2.tgz` file to the target server and extract it to the current directory:
Copy the `tidb-operator-v1.6.0-beta.1.tgz` file to the target server and extract it to the current directory:
{{< copyable "shell-regular" >}}
```shell
tar zxvf tidb-operator.v1.5.2.tgz
tar zxvf tidb-operator.v1.6.0-beta.1.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.2
pingcap/tidb-backup-manager:v1.5.2
pingcap/tidb-operator:v1.6.0-beta.1
pingcap/tidb-backup-manager:v1.6.0-beta.1
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.2
docker pull pingcap/tidb-backup-manager:v1.5.2
docker pull pingcap/tidb-operator:v1.6.0-beta.1
docker pull pingcap/tidb-backup-manager:v1.6.0-beta.1
docker pull bitnami/kubectl:latest
docker pull pingcap/advanced-statefulset:v0.3.3
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 tidb-operator-v1.6.0-beta.1.tar pingcap/tidb-operator:v1.6.0-beta.1
docker save -o tidb-backup-manager-v1.6.0-beta.1.tar pingcap/tidb-backup-manager:v1.6.0-beta.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 @@ -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.2.tar
docker load -i tidb-backup-manager-v1.5.2.tar
docker load -i tidb-operator-v1.6.0-beta.1.tar
docker load -i tidb-backup-manager-v1.6.0-beta.1.tar
docker load -i bitnami-kubectl.tar
docker load -i advanced-statefulset-v0.3.3.tar
```
Expand Down
10 changes: 5 additions & 5 deletions en/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ First, you need to install the Custom Resource Definitions (CRDs) that are requi
To install the CRDs, run the following command:

```shell
kubectl create -f https://raw.githubusercontent.com/pingcap/tidb-operator/master/manifests/crd.yaml
kubectl create -f https://raw.githubusercontent.com/pingcap/tidb-operator/v1.6.0-beta.1/manifests/crd.yaml
```

<details>
Expand Down 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.2
helm install --namespace tidb-admin tidb-operator pingcap/tidb-operator --version v1.6.0-beta.1
```

<details>
Expand Down Expand Up @@ -282,7 +282,7 @@ This section describes how to deploy a TiDB cluster and its monitoring services.
```shell
kubectl create namespace tidb-cluster && \
kubectl -n tidb-cluster apply -f https://raw.githubusercontent.com/pingcap/tidb-operator/master/examples/basic/tidb-cluster.yaml
kubectl -n tidb-cluster apply -f https://raw.githubusercontent.com/pingcap/tidb-operator/v1.6.0-beta.1/examples/basic/tidb-cluster.yaml
```

<details>
Expand All @@ -300,7 +300,7 @@ If you need to deploy a TiDB cluster on an ARM64 machine, refer to [Deploying a
### Deploy TiDB Dashboard independently

```shell
kubectl -n tidb-cluster apply -f https://raw.githubusercontent.com/pingcap/tidb-operator/master/examples/basic/tidb-dashboard.yaml
kubectl -n tidb-cluster apply -f https://raw.githubusercontent.com/pingcap/tidb-operator/v1.6.0-beta.1/examples/basic/tidb-dashboard.yaml
```

<details>
Expand All @@ -315,7 +315,7 @@ tidbdashboard.pingcap.com/basic created
### Deploy TiDB monitoring services

```shell
kubectl -n tidb-cluster apply -f https://raw.githubusercontent.com/pingcap/tidb-operator/master/examples/basic/tidb-monitor.yaml
kubectl -n tidb-cluster apply -f https://raw.githubusercontent.com/pingcap/tidb-operator/v1.6.0-beta.1/examples/basic/tidb-monitor.yaml
```

<details>
Expand Down
Loading

0 comments on commit 8a6d4fb

Please sign in to comment.