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: add release notes for v1.3.1 #1694

Merged
merged 16 commits into from
Feb 24, 2022
1 change: 1 addition & 0 deletions en/TOC.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions en/releases/release-1.3.0-beta.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 4 additions & 0 deletions en/releases/release-1.3.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -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))
Expand Down
45 changes: 45 additions & 0 deletions en/releases/release-1.3.1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
title: TiDB Operator 1.3.1 Release Notes
---

# TiDB Operator 1.3.1 Release Notes

Release date: February 23, 2022
DanielZhangQD marked this conversation as resolved.
Show resolved Hide resolved

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.
KanShiori marked this conversation as resolved.
Show resolved Hide resolved

```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 does not work if the `tmp_path` field is not set in TiFlash's config ([#4430](https://github.com/pingcap/tidb-operator/pull/4430), [@KanShiori](https://github.com/KanShiori))
4 changes: 4 additions & 0 deletions en/whats-new-in-v1.3.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions zh/TOC.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions zh/releases/release-1.3.0-beta.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 及以上版本。
Expand Down
4 changes: 4 additions & 0 deletions zh/releases/release-1.3.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 及之后版本,再执行升级操作。
DanielZhangQD marked this conversation as resolved.
Show resolved Hide resolved

- 由于 [#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))
Expand Down
47 changes: 47 additions & 0 deletions zh/releases/release-1.3.1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
title: TiDB Operator 1.3.1 Release Notes
---

# TiDB Operator 1.3.1 Release Notes

发布日期: 2022 年 2 月 23 日
DanielZhangQD marked this conversation as resolved.
Show resolved Hide resolved

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` 没有显示配置,也需要显式添加。
KanShiori marked this conversation as resolved.
Show resolved Hide resolved

```yaml
spec:
# ...
tiflash:
config:
config: |
# ...
[storage]
DanielZhangQD marked this conversation as resolved.
Show resolved Hide resolved
[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-backend` 后端作为默认后端 ([#4426](https://github.com/pingcap/tidb-operator/pull/4426), [@KanShiori](https://github.com/KanShiori))
KanShiori marked this conversation as resolved.
Show resolved Hide resolved

## 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` 字段时无法使用 TiFlash 的问题 ([#4430](https://github.com/pingcap/tidb-operator/pull/4430), [@KanShiori](https://github.com/KanShiori))
KanShiori marked this conversation as resolved.
Show resolved Hide resolved
4 changes: 4 additions & 0 deletions zh/whats-new-in-v1.3.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 及以上版本。
Expand Down