diff --git a/en/TOC.md b/en/TOC.md index 2a7308edd6..d5ce109683 100644 --- a/en/TOC.md +++ b/en/TOC.md @@ -111,6 +111,7 @@ - [Monitoring and Alert on Kubernetes](monitor-kubernetes.md) - Release Notes - v1.3 + - [1.3.1](releases/release-1.3.1.md) - [1.3 GA](releases/release-1.3.0.md) - [1.3.0-beta.1](releases/release-1.3.0-beta.1.md) - v1.2 diff --git a/en/releases/release-1.3.0-beta.1.md b/en/releases/release-1.3.0-beta.1.md index cf55c59ab0..b3271ce969 100644 --- a/en/releases/release-1.3.0-beta.1.md +++ b/en/releases/release-1.3.0-beta.1.md @@ -15,6 +15,10 @@ TiDB Operator version: 1.3.0-beta.1 1. Use the `baseImage` and `version` fields to replace the `image` field. For details, refer to [Configure TiDB deployment](../configure-a-tidb-cluster.md#version). 2. Upgrade TiDB Operator. +- Due to the issue in [#4434](https://github.com/pingcap/tidb-operator/pull/4434), if you upgrade TiFlash to v5.4.0 or later when using v1.3.0-beta.1 TiDB Operator, TiFlash might lose metadata and not work. If TiFlash is deployed in your cluster, it is recommended that you upgrade TiDB Operator to v1.3.1 or later versions before upgrading TiFlash. + +- Due to the issue in [#4435](https://github.com/pingcap/tidb-operator/pull/4435), when using TiDB Operator v1.3.0-beta.1, you must set the `tmp_path` field in TiFlash's config to use TiFlash v5.4.0 or later versions. It is recommended that you upgrade TiDB Operator to v1.3.1 or later versions before you deploy TiFlash. + ## Rolling Update Changes - Due to changes in [#4358](https://github.com/pingcap/tidb-operator/pull/4358), if the TiDB cluster (>= v5.4) is deployed by TiDB Operator v1.2, upgrading TiDB Operator to v1.3.0-beta.1 causes TiFlash to rolling upgrade. It is recommended to upgrade TiDB Operator to v1.3 before upgrading the TiDB cluster to v5.4.0 or later versions. diff --git a/en/releases/release-1.3.0.md b/en/releases/release-1.3.0.md index 58c6eeb1ac..9c93f04715 100644 --- a/en/releases/release-1.3.0.md +++ b/en/releases/release-1.3.0.md @@ -15,6 +15,10 @@ TiDB Operator version: 1.3.0 2. Add a new `spec.acrossK8s` field in TidbCluster spec and set it to `true`. 3. Upgrade TiDB Operator. +- Due to the issue in [#4434](https://github.com/pingcap/tidb-operator/pull/4434), if you upgrade TiFlash to v5.4.0 or later when using v1.3.0 TiDB Operator, TiFlash might lose metadata and not work. If TiFlash is deployed in your cluster, it is recommended that you upgrade TiDB Operator to v1.3.1 or later versions before upgrading TiFlash. + +- Due to the issue in [#4435](https://github.com/pingcap/tidb-operator/pull/4435), when using TiDB Operator v1.3.0, you must set the `tmp_path` field in TiFlash's config to use TiFlash v5.4.0 or later versions. It is recommended that you upgrade TiDB Operator to v1.3.1 or later versions before you deploy TiFlash. + ## New Features - Add a new field `spec.tidb.tlsClient.skipInternalClientCA` to skip server certificate verification when internal components access TiDB ([#4388](https://github.com/pingcap/tidb-operator/pull/4388), [@just1900](https://github.com/just1900)) diff --git a/en/releases/release-1.3.1.md b/en/releases/release-1.3.1.md new file mode 100644 index 0000000000..d8b5033aca --- /dev/null +++ b/en/releases/release-1.3.1.md @@ -0,0 +1,45 @@ +--- +title: TiDB Operator 1.3.1 Release Notes +--- + +# TiDB Operator 1.3.1 Release Notes + +Release date: February 24, 2022 + +TiDB Operator version: 1.3.1 + +## Compatibility Change + +- Due to the issues in [#4434](https://github.com/pingcap/tidb-operator/pull/4434) and [#4435](https://github.com/pingcap/tidb-operator/pull/4435), if you have deployed TiFlash v5.4.0 or later versions when using TiDB Operator v1.3.0 or v1.3.0-beta.1, you must upgrade TiDB Operator by taking the following steps to **avoid TiFlash losing metadata**. + + 1. In TidbCluster spec, if the `storage.rafe.dir` and `raft.kvstore_path` fields in TiFlash's config `spec.tiflash.config.config` are not explicitly configured, you need to add the `storage.raft.dir` field. If `storage.main.dir` is not explicitly configured, you need to add the field. + + ```yaml + spec: + # ... + tiflash: + config: + config: | + # ... + [storage] + [storage.main] + dir = ["/data0/db"] + [storage.raft] + dir = ["/data0/db/kvstore/"] + ``` + + 2. Upgrade TiDB Operator. + +## New Feature + +- Add a new field `spec.dnsPolicy` to support configuring `DNSPolicy` for Pods ([#4420](https://github.com/pingcap/tidb-operator/pull/4420), [@handlerww](https://github.com/handlerww)) + +## Improvement + +- `tidb-lightning` Helm chart uses `local` backend as the default backend ([#4426](https://github.com/pingcap/tidb-operator/pull/4426), [@KanShiori](https://github.com/KanShiori)) + +## Bug fixes + +- Fix the issue that if the `raft.kvstore_path` field or the `storage.raft.dir` field is not set in TiFlash's config, TiFlash will lose metadata after upgrading TiFlash to v5.4.0 or later versions when using TiDB Operator v1.3.0 or v1.3.0-beta.1 ([#4430](https://github.com/pingcap/tidb-operator/pull/4430), [@KanShiori](https://github.com/KanShiori)) + +- Fix the issue that TiFlash v5.4.0 or later versions does not work if the `tmp_path` field is not set in TiFlash's config when using TiDB Operator v1.3.0 or v1.3.0-beta.1 ([#4430](https://github.com/pingcap/tidb-operator/pull/4430), [@KanShiori](https://github.com/KanShiori)) diff --git a/en/whats-new-in-v1.3.md b/en/whats-new-in-v1.3.md index bcc6ee066d..0f7d99b124 100644 --- a/en/whats-new-in-v1.3.md +++ b/en/whats-new-in-v1.3.md @@ -20,6 +20,10 @@ TiDB Operator 1.3 introduces the following key features, which helps you manage 1. Use fields `baseImage` and `version` to replace the field `image`, refer to the document [Configure TiDB deployment](configure-a-tidb-cluster.md#version). 2. Upgrade TiDB Operator. +- Due to the issue in [#4434](https://github.com/pingcap/tidb-operator/pull/4434), if you upgrade TiFlash to v5.4.0 or later when using TiDB Operator v1.3.0-beta.1 or v1.3.0, TiFlash might lose metadata and not work. If TiFlash is deployed in your cluster, it is recommended that you upgrade TiDB Operator to v1.3.1 or later versions before upgrading TiFlash. + +- Due to the issue in [#4435](https://github.com/pingcap/tidb-operator/pull/4435), when using TiDB Operator v1.3.0 or v1.3.0-beta.1, you must set the `tmp_path` field in TiFlash's config to use TiFlash v5.4.0 or later versions. It is recommended that you upgrade TiDB Operator to v1.3.1 or later versions before you deploy TiFlash. + ## Rolling upgrade changes - Optimize the default configuration of TiFlash (>= v5.4.0). Since v1.3.0-beta.1, TiDB Operator optimizes the default configuration for TiFlash >= v5.4.0. If you deploy a TiDB cluster >= v5.4 using TiDB Operator v1.2, after upgrading TiDB Operator to v1.3.x, the TiFlash component will be rolling updated. It is recommended to upgrade TiDB Operator to v1.3.x before upgrading the TiDB cluster to v5.4.x. diff --git a/zh/TOC.md b/zh/TOC.md index 6d21bd9258..14bdf74032 100644 --- a/zh/TOC.md +++ b/zh/TOC.md @@ -115,6 +115,7 @@ - [Kubernetes 监控与告警](monitor-kubernetes.md) - 版本发布历史 - v1.3 + - [1.3.1](releases/release-1.3.1.md) - [1.3 GA](releases/release-1.3.0.md) - [1.3.0-beta.1](releases/release-1.3.0-beta.1.md) - v1.2 diff --git a/zh/releases/release-1.3.0-beta.1.md b/zh/releases/release-1.3.0-beta.1.md index 928ef8f756..c590201fbf 100644 --- a/zh/releases/release-1.3.0-beta.1.md +++ b/zh/releases/release-1.3.0-beta.1.md @@ -16,6 +16,10 @@ TiDB Operator 版本:1.3.0-beta.1 1. 在各组件的配置中,使用 `baseImage` 与 `version` 字段代替当前使用的 `image` 字段,可以参考文档[部署配置](../configure-a-tidb-cluster.md#版本)。 2. 升级 TiDB Operator。 +- 由于 [#4434](https://github.com/pingcap/tidb-operator/pull/4434) 的问题,在部署 v1.3.0-beta.1 版本的 TiDB Operator 情况下,直接升级 TiFlash 到 v5.4.0 及更高版本可能会导致 TiFlash **无法使用并且丢失元数据**。如果集群中部署了 TiFlash,推荐升级到 v1.3.1 及之后版本,再执行升级操作。 + +- 由于 [#4435](https://github.com/pingcap/tidb-operator/pull/4435) 的问题,在部署 v1.3.0-beta.1 版本的 TiDB Operator 情况下,必须在 TiFlash 的配置中显式配置 `tmp_path` 字段,才能使用 v5.4.0 及更高版本的 TiFlash。推荐升级到 v1.3.1 及之后版本后,再部署 TiFlash。 + ## 滚动升级改动 - 由于 [#4358](https://github.com/pingcap/tidb-operator/pull/4358) 的变更,如果使用 v1.2 版本 TiDB Operator 部署了 v5.4 及更新版本的 TiDB 集群,升级 TiDB Operator 到 v1.3.0-beta.1 版本会导致 TiFlash 组件滚动更新。建议在升级 TiDB 集群到 v5.4.0 或更新版本之前,先升级 TiDB Operator 到 v1.3 及以上版本。 diff --git a/zh/releases/release-1.3.0.md b/zh/releases/release-1.3.0.md index 9537cf3cc0..510b4b864d 100644 --- a/zh/releases/release-1.3.0.md +++ b/zh/releases/release-1.3.0.md @@ -15,6 +15,10 @@ TiDB Operator 版本:1.3.0 2. 添加新的 `spec.acrossK8s` 字段到 TidbCluster 定义,其值设置为 `true`。 3. 升级 TiDB Operator。 +- 由于 [#4434](https://github.com/pingcap/tidb-operator/pull/4434) 的问题,在部署 v1.3.0 版本的 TiDB Operator 情况下,直接升级 TiFlash 到 v5.4.0 及更高版本可能会导致 TiFlash **无法使用并且丢失元数据**。如果集群中部署了 TiFlash,推荐升级到 v1.3.1 及之后版本,再执行升级操作。 + +- 由于 [#4435](https://github.com/pingcap/tidb-operator/pull/4435) 的问题,在部署 v1.3.0 版本的 TiDB Operator 情况下,必须在 TiFlash 的配置中显式配置 `tmp_path` 字段,才能使用 v5.4.0 及更高版本的 TiFlash。推荐升级到 v1.3.1 及之后版本后,再部署 TiFlash。 + ## 新功能 - 添加新的 `spec.tidb.tlsClient.skipInternalClientCA` 字段,以支持内部组件访问 TiDB 时跳过服务端证书验证 ([#4388](https://github.com/pingcap/tidb-operator/pull/4388), [@just1900](https://github.com/just1900)) diff --git a/zh/releases/release-1.3.1.md b/zh/releases/release-1.3.1.md new file mode 100644 index 0000000000..fc872c0045 --- /dev/null +++ b/zh/releases/release-1.3.1.md @@ -0,0 +1,47 @@ +--- +title: TiDB Operator 1.3.1 Release Notes +--- + +# TiDB Operator 1.3.1 Release Notes + +发布日期: 2022 年 2 月 24 日 + +TiDB Operator 版本:1.3.1 + +## 兼容性改动 + +- 由于 [#4434](https://github.com/pingcap/tidb-operator/pull/4434) 和 [#4435](https://github.com/pingcap/tidb-operator/pull/4435) 的问题,如果已经使用 v1.3.0 或者 v1.3.0-beta.1 版本 TiDB Operator 部署了 v5.4.0 及以后版本的 TiFlash,你需要执行以下步骤来升级 TiDB Operator,以防止 TiFlash **丢失元数据**: + + 1. 如果 TidbCluster 定义中**没有显式**配置 TiFlash 配置 `spec.tiflash.config.config` 中的 `storage.raft.dir` 和 `raft.kvstore_path` 字段,则显式添加 `storage.raft.dir` 字段。如果 `storage.main.dir` 没有显式配置,也需要显式添加。 + + ```yaml + spec: + # ... + tiflash: + config: + config: | + # ... + [storage] + [storage.main] + dir = ["/data0/db"] + [storage.raft] + dir = ["/data0/db/kvstore/"] + ``` + + 配置后,等待 TiFlash 滚动更新结束。 + + 2. 升级 TiDB Operator。 + +## 新功能 + +- 添加新的 `spec.dnsPolicy` 字段,以支持配置 Pod 的 DNSPolicy ([#4420](https://github.com/pingcap/tidb-operator/pull/4420), [@handlerww](https://github.com/handlerww)) + +## 优化提升 + +- `tidb-lightning` Helm chart 使用 `local` 后端作为默认后端 ([#4426](https://github.com/pingcap/tidb-operator/pull/4426), [@KanShiori](https://github.com/KanShiori)) + +## Bug 修复 + +- 修复当没有显式设置 TiFlash 配置 `raft.kvstore_path` 或 `storage.raft.dir` 字段的情况下,使用 v1.3.0 或者 v1.3.0-beta.1 版本 TiDB Operator 升级 TiFlash 到 v5.4.0 及以后版本后,TiFlash 丢失元数据的问题 ([#4430](https://github.com/pingcap/tidb-operator/pull/4430), [@KanShiori](https://github.com/KanShiori)) + +- 修复 TiFlash 配置中缺少 `tmp_path` 字段时,使用 v1.3.0 或者 v1.3.0-beta.1 版本 TiDB Operator 无法使用 TiFlash v5.4.0 及以后版本的问题 ([#4430](https://github.com/pingcap/tidb-operator/pull/4430), [@KanShiori](https://github.com/KanShiori)) diff --git a/zh/whats-new-in-v1.3.md b/zh/whats-new-in-v1.3.md index fa1df5c965..a1f4901df8 100644 --- a/zh/whats-new-in-v1.3.md +++ b/zh/whats-new-in-v1.3.md @@ -20,6 +20,10 @@ TiDB Operator v1.3 引入了以下关键特性,从扩展性、易用性、安 1. 使用各组件配置 `baseImage` 与 `version` 替代当前使用的 `image` 字段,可以参考文档[部署配置](configure-a-tidb-cluster.md#版本)。 2. 升级 TiDB Operator。 +- 由于 [#4434](https://github.com/pingcap/tidb-operator/pull/4434) 的问题,在部署 v1.3.0 或 v1.3.0-beta.1 版本的 TiDB Operator 情况下,直接升级 TiFlash 到 v5.4.0 及更高版本可能会导致 TiFlash **无法使用并且丢失元数据**。如果集群中部署了 TiFlash,推荐升级到 v1.3.1 及之后版本,再执行升级操作。 + +- 由于 [#4435](https://github.com/pingcap/tidb-operator/pull/4435) 的问题,在部署 v1.3.0 或 v1.3.0-beta.1 版本的 TiDB Operator 情况下,必须在 TiFlash 的配置中显式配置 `tmp_path` 字段,才能使用 v5.4.0 及更高版本的 TiFlash。推荐升级到 v1.3.1 及之后版本后,再部署 TiFlash。 + ## 滚动更新改动 - TiFlash(>= v5.4.0)默认配置优化。TiDB Operator v1.3.0-beta.1 及之后版本针对 TiFlash v5.4.0 及之后版本的默认配置进行了优化,如果使用 v1.2 版本 TiDB Operator 部署了 v5.4 及更新版本的 TiDB 集群,升级 TiDB Operator 到 v1.3.0-beta.1 及之后版本会导致 TiFlash 组件滚动更新。建议在升级 TiDB 集群到 v5.4.0 或更新版本之前,先升级 TiDB Operator 到 v1.3 及以上版本。