en,zh: add v1.5 GA release notes and whats new (#2397)

* en,zh: release note for 1.5.0 * update TOC * fix wording * add what's new * fix format * add rn * *: update eb2 privileges Signed-off-by: BornChanger <[email protected]> * update Recommended * add rn * en,zh: add contents about br federation manager * update release date * add 滚动升级改动 * en,zh: add privileges about EBS backup/restore * en: add CreateSnapshot privilege * Apply suggestions from code review Co-authored-by: Grace Cai <[email protected]> * Apply suggestions from code review Co-authored-by: Grace Cai <[email protected]> * Apply suggestions from code review Co-authored-by: Grace Cai <[email protected]> * Apply suggestions from code review Co-authored-by: Grace Cai <[email protected]> * address comments * en: modify new feature content * address comments * Apply suggestions from code review Co-authored-by: Ran <[email protected]> Co-authored-by: Grace Cai <[email protected]> * Update en/releases/release-1.5.0.md Co-authored-by: Grace Cai <[email protected]> * Update en/releases/release-1.5.0.md Co-authored-by: Grace Cai <[email protected]> * Update en/whats-new-in-v1.5.md Co-authored-by: Grace Cai <[email protected]> --------- Signed-off-by: BornChanger <[email protected]> Co-authored-by: BornChanger <[email protected]> Co-authored-by: WangLe1321 <[email protected]> Co-authored-by: Grace Cai <[email protected]> Co-authored-by: Ran <[email protected]>
pingcap · Aug 4, 2023 · d21d54d · d21d54d
1 parent cf63ac6
commit d21d54d
Show file tree

Hide file tree

Showing 10 changed files with 168 additions and 6 deletions.
diff --git a/en/TOC.md b/en/TOC.md
@@ -4,6 +4,7 @@
 - [TiDB on Kubernetes Docs](https://docs.pingcap.com/tidb-in-kubernetes/dev)
 - Introduction
   - [Overview](tidb-operator-overview.md)
+  - [What's New in v1.5](whats-new-in-v1.5.md)
 - [Get Started](get-started.md)
 - Deploy
   - On Self-Managed Kubernetes
@@ -125,6 +126,7 @@
   - [PingCAP Clinic Diagnostic Data](clinic-data-collection.md)
 - Release Notes
   - v1.5
+    - [1.5 GA](releases/release-1.5.0.md)
     - [1.5.0-beta.1](releases/release-1.5.0-beta.1.md)
   - v1.4
     - [1.4.7](releases/release-1.4.7.md)

diff --git a/en/grant-permissions-to-remote-storage.md b/en/grant-permissions-to-remote-storage.md
@@ -48,6 +48,7 @@ If you associate the user's [IAM](https://aws.amazon.com/cn/iam/) role with the
             "Action": [
                 "ec2:AttachVolume",
                 "ec2:CreateSnapshot",
+                "ec2:CreateSnapshots",
                 "ec2:CreateTags",
                 "ec2:CreateVolume",
                 "ec2:DeleteSnapshot",
@@ -57,7 +58,9 @@ If you associate the user's [IAM](https://aws.amazon.com/cn/iam/) role with the
                 "ec2:DescribeSnapshots",
                 "ec2:DescribeTags",
                 "ec2:DescribeVolumes",
-                "ec2:DetachVolume"
+                "ec2:DetachVolume",
+                "ebs:ListSnapshotBlocks",
+                "ebs:ListChangedBlocks"
             ],
             "Resource": "*"
         }
@@ -101,6 +104,7 @@ When you use this method to grant permissions, you can [create the EKS cluster](
             "Action": [
                 "ec2:AttachVolume",
                 "ec2:CreateSnapshot",
+                "ec2:CreateSnapshots",
                 "ec2:CreateTags",
                 "ec2:CreateVolume",
                 "ec2:DeleteSnapshot",
@@ -110,7 +114,9 @@ When you use this method to grant permissions, you can [create the EKS cluster](
                 "ec2:DescribeSnapshots",
                 "ec2:DescribeTags",
                 "ec2:DescribeVolumes",
-                "ec2:DetachVolume"
+                "ec2:DetachVolume",
+                "ebs:ListSnapshotBlocks",
+                "ebs:ListChangedBlocks"
             ],
             "Resource": "*"
         }

diff --git a/en/releases/release-1.5.0.md b/en/releases/release-1.5.0.md
@@ -0,0 +1,41 @@
+---
+title: TiDB Operator 1.5.0 Release Notes
+summary: Learn about new features, improvements, and bug fixes in TiDB Operator 1.5.0.
+---
+
+# TiDB Operator 1.5.0 Release Notes
+
+Release date: August 4, 2023
+
+TiDB Operator version: 1.5.0
+
+## Rolling update changes
+
+If TiFlash is deployed in a TiDB cluster that is v7.1.0 or later, the TiFlash component will be rolling updated after TiDB Operator is upgraded to v1.5.0 due to [#5075](https://github.com/pingcap/tidb-operator/pull/5075).
+
+## New features
+
+- Add the BR Federation Manager component to orchestrate `Backup` and `Restore` custom resources (CR) across multiple Kubernetes clusters ([#4996](https://github.com/pingcap/tidb-operator/pull/4996), [@csuzhangxc](https://github.com/csuzhangxc))
+- Support using the `VolumeBackup` CR to back up a TiDB cluster deployed across multiple Kubernetes clusters based on EBS snapshots ([#5013](https://github.com/pingcap/tidb-operator/pull/5013), [@WangLe1321](https://github.com/WangLe1321))
+- Support using the `VolumeRestore` CR to restore a TiDB cluster deployed across multiple Kubernetes clusters based on EBS snapshots ([#5039](https://github.com/pingcap/tidb-operator/pull/5039), [@WangLe1321](https://github.com/WangLe1321))
+- Support using the `VolumeBackupSchedule` CR to automatically back up a TiDB cluster deployed across multiple Kubernetes clusters based on EBS snapshots ([#5036](https://github.com/pingcap/tidb-operator/pull/5036), [@BornChanger](https://github.com/BornChanger))
+- Support backing up CRs related to `TidbCluster` when backing up a TiDB cluster deployed across multiple Kubernetes based on EBS snapshots ([#5207](https://github.com/pingcap/tidb-operator/pull/5207), [@WangLe1321](https://github.com/WangLe1321))
+
+## Improvements
+
+- Add the `startUpScriptVersion` field for DM master to specify the version of the startup script ([#4971](https://github.com/pingcap/tidb-operator/pull/4971), [@hanlins](https://github.com/hanlins))
+- Support `spec.preferIPv6` for DmCluster, TidbDashboard, TidbMonitor, and TidbNGMonitoring ([#4977](https://github.com/pingcap/tidb-operator/pull/4977), [@KanShiori](https://github.com/KanShiori))
+- Support setting expiration time for TiKV leader eviction and PD leader transfer ([#4997](https://github.com/pingcap/tidb-operator/pull/4997), [@Tema](https://github.com/Tema))
+- Support setting toleration for `TidbInitializer` ([#5047](https://github.com/pingcap/tidb-operator/pull/5047), [@csuzhangxc](https://github.com/csuzhangxc))
+- Support configuring the timeout for PD start ([#5071](https://github.com/pingcap/tidb-operator/pull/5071), [@oliviachenairbnb](https://github.com/oliviachenairbnb))
+- Skip evicting leaders for TiKV when changing PVC size to avoid leader eviction blocked caused by low disk space ([#5101](https://github.com/pingcap/tidb-operator/pull/5101), [@csuzhangxc](https://github.com/csuzhangxc))
+- Support updating annotations and labels in services for PD, TiKV, TiFlash, TiProxy, DM-master, and DM-worker ([#4973](https://github.com/pingcap/tidb-operator/pull/4973), [@wxiaomou](https://github.com/wxiaomou))
+- Enable volume resizing by default for PV expansion ([#5167](https://github.com/pingcap/tidb-operator/pull/5167), [@liubog2008](https://github.com/liubog2008))
+
+## Bug fixes
+
+- Fix the quorum loss issue during TiKV upgrade due to some TiKV stores going down ([#4979](https://github.com/pingcap/tidb-operator/pull/4979), [@Tema](https://github.com/Tema))
+- Fix the quorum loss issue during PD upgrade due to some members going down ([#4995](https://github.com/pingcap/tidb-operator/pull/4995), [@Tema](https://github.com/Tema))
+- Fix the issue that TiDB Operator panics when no Kubernetes cluster-level permission is configured ([#5058](https://github.com/pingcap/tidb-operator/pull/5058), [@liubog2008](https://github.com/liubog2008))
+- Fix the issue that TiDB Operator might panic when `AdditionalVolumeMounts` is set for the `TidbCluster` CR ([#5058](https://github.com/pingcap/tidb-operator/pull/5058), [@liubog2008](https://github.com/liubog2008))
+- Fix the issue that `baseImage` for the `TidbDashboard` CR is parsed incorrectly when custom image registry is used ([#5014](https://github.com/pingcap/tidb-operator/pull/5014), [@linkinghack](https://github.com/linkinghack))
diff --git a/en/tidb-operator-overview.md b/en/tidb-operator-overview.md
@@ -13,7 +13,8 @@ The corresponding relationship between TiDB Operator and TiDB versions is as fol
 | TiDB versions | Compatible TiDB Operator versions |
 |:---|:---|
 | dev               | dev                 |
-| TiDB >= 6.5       | 1.4 (Recommended), 1.3 |
+| TiDB >= 7.1       | 1.5 (Recommended), 1.4 |
+| 6.5 <= TiDB < 7.1 | 1.5, 1.4 (Recommended), 1.3 |
 | 5.4 <= TiDB < 6.5 | 1.4, 1.3 (Recommended)   |
 | 5.1 <= TiDB < 5.4 | 1.4, 1.3 (Recommended), 1.2      |
 | 3.0 <= TiDB < 5.1 | 1.4, 1.3 (Recommended), 1.2, 1.1 |

diff --git a/en/whats-new-in-v1.5.md b/en/whats-new-in-v1.5.md
@@ -0,0 +1,31 @@
+---
+title: What's New in TiDB Operator 1.5
+summary: Learn about new features in TiDB Operator 1.5.0.
+---
+
+# What's New in TiDB Operator 1.5
+
+TiDB Operator 1.5 introduces the following key features, which helps you manage TiDB clusters and the tools more easily in terms of extensibility and usability.
+
+## Compatibility changes
+
+To use the `PreferDualStack` feature (enabled with `spec.preferIPv6: true`) introduced in [#4959](https://github.com/pingcap/tidb-operator/pull/4959), Kubernetes version >= v1.20 is required.
+
+## Rolling update changes
+
+If TiFlash is deployed in a TiDB cluster that is v7.1.0 or later, the TiFlash component will be rolling updated after TiDB Operator is upgraded to v1.5.0 due to [#5075](https://github.com/pingcap/tidb-operator/pull/5075).
+
+## Extensibility
+
+- Support specifying an initialization SQL file to be executed during the first bootstrap of TiDB with the `bootstrapSQLConfigMapName` field.
+- Support setting `PreferDualStack` for all Service's `ipFamilyPolicy` with `spec.preferIPv6: true`.
+- Support managing TiCDC and TiProxy with [Advanced StatefulSet](advanced-statefulset.md).
+- Add the BR Federation Manager component to support the backup and restore of a TiDB cluster deployed across multiple Kubernetes clusters based on EBS snapshots.
+
+## Usability
+
+- Support using the `tidb.pingcap.com/pd-transfer-leader` annotation to restart PD Pods gracefully.
+- Support using the `tidb.pingcap.com/tidb-graceful-shutdown` annotation to restart TiDB Pods gracefully.
+- Allow users to define a strategy to restart failed backup jobs, enhancing backup stability.
+- Add metrics for the reconciler and worker queue to improve observability.
+- Add metrics for counting errors that occur during the reconciliation to improve observability.
diff --git a/zh/TOC.md b/zh/TOC.md
@@ -4,6 +4,7 @@
 - [TiDB on Kubernetes 文档](https://docs.pingcap.com/zh/tidb-in-kubernetes/dev)
 - 关于 TiDB Operator
   - [简介](tidb-operator-overview.md)
+  - [v1.5 新特性](whats-new-in-v1.5.md)
 - [快速上手](get-started.md)
 - 部署
   - 自托管的 Kubernetes
@@ -125,6 +126,7 @@
   - [PingCAP Clinic 数据采集范围说明](clinic-data-collection.md)
 - 版本发布历史
   - v1.5
+    - [1.5 GA](releases/release-1.5.0.md)
     - [1.5.0-beta.1](releases/release-1.5.0-beta.1.md)
   - v1.4
     - [1.4.7](releases/release-1.4.7.md)

diff --git a/zh/grant-permissions-to-remote-storage.md b/zh/grant-permissions-to-remote-storage.md
@@ -44,6 +44,7 @@ kubectl create secret generic s3-secret --from-literal=access_key=xxx --from-lit
             "Action": [
                 "ec2:AttachVolume",
                 "ec2:CreateSnapshot",
+                "ec2:CreateSnapshots",
                 "ec2:CreateTags",
                 "ec2:CreateVolume",
                 "ec2:DeleteSnapshot",
@@ -53,7 +54,9 @@ kubectl create secret generic s3-secret --from-literal=access_key=xxx --from-lit
                 "ec2:DescribeSnapshots",
                 "ec2:DescribeTags",
                 "ec2:DescribeVolumes",
-                "ec2:DetachVolume"
+                "ec2:DetachVolume",
+                "ebs:ListSnapshotBlocks",
+                "ebs:ListChangedBlocks"
             ],
             "Resource": "*"
         }
@@ -99,6 +102,7 @@ kubectl create secret generic s3-secret --from-literal=access_key=xxx --from-lit
             "Action": [
                 "ec2:AttachVolume",
                 "ec2:CreateSnapshot",
+                "ec2:CreateSnapshots",
                 "ec2:CreateTags",
                 "ec2:CreateVolume",
                 "ec2:DeleteSnapshot",
@@ -108,7 +112,9 @@ kubectl create secret generic s3-secret --from-literal=access_key=xxx --from-lit
                 "ec2:DescribeSnapshots",
                 "ec2:DescribeTags",
                 "ec2:DescribeVolumes",
-                "ec2:DetachVolume"
+                "ec2:DetachVolume",
+                "ebs:ListSnapshotBlocks",
+                "ebs:ListChangedBlocks"
             ],
             "Resource": "*"
         }

diff --git a/zh/releases/release-1.5.0.md b/zh/releases/release-1.5.0.md
@@ -0,0 +1,41 @@
+---
+title: TiDB Operator 1.5.0 Release Notes
+summary: 了解 TiDB Operator 1.5.0 版本的新功能、优化提升，以及 Bug 修复。
+---
+
+# TiDB Operator 1.5.0 Release Notes
+
+发布日期: 2023 年 8 月 4 日
+
+TiDB Operator 版本：1.5.0
+
+## 滚动升级改动
+
+由于 [#5075](https://github.com/pingcap/tidb-operator/pull/5075) 的改动，如果 TiDB v7.1.0 或以上版本的集群中部署了 TiFlash，升级 TiDB Operator 到 v1.5.0 之后 TiFlash 组件会滚动升级。
+
+## 新功能
+
+- 新增 BR Federation Manager 组件，支持跨多个 Kubernetes 集群编排 `Backup` 和 `Restore` custom resources (CR) ([#4996](https://github.com/pingcap/tidb-operator/pull/4996), [@csuzhangxc](https://github.com/csuzhangxc))
+- 支持使用 `VolumeBackup` CR 对跨多个 Kubernetes 部署的 TiDB 集群进行基于 EBS 快照的备份 ([#5013](https://github.com/pingcap/tidb-operator/pull/5013), [@WangLe1321](https://github.com/WangLe1321))
+- 支持使用 `VolumeRestore` CR 对跨多个 Kubernetes 部署的 TiDB 集群进行基于 EBS 快照的恢复 ([#5039](https://github.com/pingcap/tidb-operator/pull/5039), [@WangLe1321](https://github.com/WangLe1321))
+- 支持使用 `VolumeBackupSchedule` CR 对跨多个 Kubernetes 部署的 TiDB 集群进行基于 EBS 快照的自动备份 ([#5036](https://github.com/pingcap/tidb-operator/pull/5036), [@BornChanger](https://github.com/BornChanger))
+- 当对跨多个 Kubernetes 部署的 TiDB 集群进行基于 EBS 快照的备份时，支持备份与 `TidbCluster` 相关的 CR 数据 ([#5207](https://github.com/pingcap/tidb-operator/pull/5207), [@WangLe1321](https://github.com/WangLe1321))
+
+## 优化提升
+
+- 为 DM master 添加 `startUpScriptVersion` 字段，支持设置启动脚本的版本 ([#4971](https://github.com/pingcap/tidb-operator/pull/4971), [@hanlins](https://github.com/hanlins))
+- 为 DmCluster、TidbDashboard、TidbMonitor 以及 TidbNGMonitoring 增加 `spec.preferIPv6` 支持 ([#4977](https://github.com/pingcap/tidb-operator/pull/4977), [@KanShiori](https://github.com/KanShiori))
+- 支持为 TiKV 驱逐 leader 和 PD 转移 leader 设置过期时间 ([#4997](https://github.com/pingcap/tidb-operator/pull/4997), [@Tema](https://github.com/Tema))
+- 支持为 `TidbInitializer` 设置 tolerations  ([#5047](https://github.com/pingcap/tidb-operator/pull/5047), [@csuzhangxc](https://github.com/csuzhangxc))
+- 支持为 PD 设置启动超时时间 ([#5071](https://github.com/pingcap/tidb-operator/pull/5071), [@oliviachenairbnb](https://github.com/oliviachenairbnb))
+- 当 TiKV 在扩展 PVC 的大小时，不再执行驱逐 leader 操作，避免因磁盘容量不足而造成驱逐卡住 ([#5101](https://github.com/pingcap/tidb-operator/pull/5101), [@csuzhangxc](https://github.com/csuzhangxc))
+- 支持更新 PD、TiKV、TiFlash、TiProxy、DM-Master 与 DM-worker 组件 Service 的 annotation 与 label ([#4973](https://github.com/pingcap/tidb-operator/pull/4973), [@wxiaomou](https://github.com/wxiaomou))
+- 默认启用 volume resize，支持对 PV 的扩容 ([#5167](https://github.com/pingcap/tidb-operator/pull/5167), [@liubog2008](https://github.com/liubog2008))
+
+## Bug 修复
+
+- 修复升级 TiKV 时由于部分 store 下线而造成 quorum 丢失的问题 ([#4979](https://github.com/pingcap/tidb-operator/pull/4979), [@Tema](https://github.com/Tema))
+- 修复升级 PD 时由于部分 member 下线而造成 quorum 丢失的问题 ([#4995](https://github.com/pingcap/tidb-operator/pull/4995), [@Tema](https://github.com/Tema))
+- 修复 TiDB Operator 在未配置任何 Kubernetes 集群级别权限时 panic 的问题 ([#5058](https://github.com/pingcap/tidb-operator/pull/5058), [@liubog2008](https://github.com/liubog2008))
+- 修复在 `TidbCluster` CR 中设置 `AdditionalVolumeMounts` 时 TiDB Operator 可能 panic 的问题 ([#5058](https://github.com/pingcap/tidb-operator/pull/5058), [@liubog2008](https://github.com/liubog2008))
+- 修复 `TidbDashboard` CR 在使用自定义的 image registry 时解析 `baseImage` 错误的问题 ([#5014](https://github.com/pingcap/tidb-operator/pull/5014), [@linkinghack](https://github.com/linkinghack))
diff --git a/zh/tidb-operator-overview.md b/zh/tidb-operator-overview.md
@@ -13,7 +13,8 @@ TiDB Operator 与适用的 TiDB 版本的对应关系如下：
 | TiDB 版本 | 适用的 TiDB Operator 版本 |
 |:---|:---|
 | dev               | dev                 |
-| TiDB >= 6.5       | 1.4（推荐），1.3     |
+| TiDB >= 7.1       | 1.5（推荐），1.4 |
+| 6.5 <= TiDB < 7.1 | 1.5, 1.4（推荐），1.3     |
 | 5.4 <= TiDB < 6.5 | 1.4, 1.3（推荐）   |
 | 5.1 <= TiDB < 5.4 | 1.4，1.3（推荐），1.2      |
 | 3.0 <= TiDB < 5.1 | 1.4，1.3（推荐），1.2，1.1 |

diff --git a/zh/whats-new-in-v1.5.md b/zh/whats-new-in-v1.5.md
@@ -0,0 +1,31 @@
+---
+title: TiDB Operator v1.5 新特性
+Summary: 了解 TiDB Operator 1.5.0 版本引入的新特性。
+---
+
+# TiDB Operator v1.5 新特性
+
+TiDB Operator v1.5 引入了以下关键特性，从扩展性、易用性等方面帮助你更轻松地管理 TiDB 集群及其周边工具。
+
+## 兼容性改动
+
+如需使用在 [#4959](https://github.com/pingcap/tidb-operator/pull/4959) 中引入的 `PreferDualStack` 特性（通过 `spec.preferIPv6: true` 启用），Kubernetes 版本需要大于等于 v1.20。
+
+## 滚动升级改动
+
+由于 [#5075](https://github.com/pingcap/tidb-operator/pull/5075) 的改动，如果 TiDB v7.1.0 或以上版本的集群中部署了 TiFlash，升级 TiDB Operator 到 v1.5.0 之后 TiFlash 组件会滚动升级。
+
+## 扩展性
+
+- 支持通过 `bootstrapSQLConfigMapName` 字段指定 TiDB 首次启动时所执行的初始 SQL 文件。
+- 支持通过配置 `spec.preferIPv6: true` 为所有组件的 Service 的 `ipFamilyPolicy` 配置 `PreferDualStack`。
+- 支持使用 [Advanced StatefulSet](advanced-statefulset.md) 管理 TiCDC 和 TiProxy。
+- 新增 BR Federation Manager 组件，支持对跨多个 Kubernetes 部署的 TiDB 集群进行基于 EBS snapshot 的备份恢复。
+
+## 易用性
+
+- 支持通过为 PD Pod 加上 `tidb.pingcap.com/pd-transfer-leader` annotation 来优雅重启 PD Pod。
+- 支持通过为 TiDB Pod 加上 `tidb.pingcap.com/tidb-graceful-shutdown` annotation 来优雅重启 TiDB Pod。
+- 允许用户自定义策略来重启失败的备份任务，以提高备份的稳定性。
+- 添加与 reconciler 和 worker queue 相关的监控指标以提高可观测性。
+- 添加统计协调流程失败计数的监控指标以提高可观测性。