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 v1.4 GA release notes and whats new #2144

Merged
merged 17 commits into from
Dec 29, 2022
Merged
3 changes: 2 additions & 1 deletion en/TOC.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +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.3](whats-new-in-v1.3.md)
- [What's New in v1.4](whats-new-in-v1.4.md)
- [Get Started](get-started.md)
- Deploy
- On Self-Managed Kubernetes
Expand Down Expand Up @@ -125,6 +125,7 @@
- [PingCAP Clinic Diagnostic Data](clinic-data-collection.md)
- Release Notes
- v1.4
- [1.4 GA](releases/release-1.4.0.md)
- [1.4.0-beta.3](releases/release-1.4.0-beta.3.md)
- [1.4.0-beta.2](releases/release-1.4.0-beta.2.md)
- [1.4.0-beta.1](releases/release-1.4.0-beta.1.md)
Expand Down
24 changes: 24 additions & 0 deletions en/releases/release-1.4.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: TiDB Operator 1.4.0 Release Notes
---

# TiDB Operator 1.4.0 Release Notes

Release date: December 29, 2022

TiDB Operator version: 1.4.0

## New features

- Support managing [TiDB Dashboard](https://github.com/pingcap/tidb-dashboard) in a separate `TidbDashboard` CRD ([#4787](https://github.com/pingcap/tidb-operator/pull/4787), [@SabaPing](https://github.com/SabaPing))
- Support configuring Liveness Probe for TiKV and PD ([#4763](https://github.com/pingcap/tidb-operator/pull/4763), [@mikechengwei](https://github.com/mikechengwei))
- Support backup and restore based on Amazon EBS volume-snapshot ([#4698](https://github.com/pingcap/tidb-operator/pull/4698),[@gozssky](https://github.com/gozssky)

ran-huang marked this conversation as resolved.
Show resolved Hide resolved
## Improvements

- Support configuring `.spec.preferIPv6: true` for compatibility with IPv6 network environments ([#4811](https://github.com/pingcap/tidb-operator/pull/4811),[@KanShiori](https://github.com/KanShiori)

## Bug fixes

- Fix the issue that the backup based on EBS snapshot cannot be restored to a different namespace ([#4795](https://github.com/pingcap/tidb-operator/pull/4795), [@fengou1](https://github.com/fengou1))
- Fix the issue that when the log backup stops occupying the Complete state, the caller mistakenly believes that the log backup CR has been completed, so that the log backup cannot be truncated ([#4810](https://github.com/pingcap/tidb-operator/pull/4810), [@WizardXiao](https://github.com/WizardXiao))
1 change: 1 addition & 0 deletions en/tidb-operator-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ 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 >= 5.4 | 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 |
Expand Down
53 changes: 0 additions & 53 deletions en/whats-new-in-v1.3.md

This file was deleted.

33 changes: 33 additions & 0 deletions en/whats-new-in-v1.4.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: What's New in TiDB Operator 1.4
---

# What's New in TiDB Operator 1.4

TiDB Operator 1.4 introduces the following key features, which helps you manage TiDB clusters and the tools more easily in terms of extensibility and usability.

## Compatibility changes

Due to the change in [#4683](https://github.com/pingcap/tidb-operator/pull/4683), the feature of modifying storage is disabled by default. If you want to resize the PVC for a component, you need to first enable this feature.

## Rolling upgrade changes

Due to the change in [#4493](https://github.com/pingcap/tidb-operator/pull/4494), if you deploy TiCDC without setting the `log-file` configuration item, the rolling upgrade of TiDB Operator to v1.4.0-alpha.1 and later versions will cause TiCDC to be rolling recreated.

## Extensibility

- Support managing [TiDB Dashboard](https://github.com/pingcap/tidb-dashboard) in a separate `TidbDashboard` CRD.
- Support backup and restore based on Amazon EBS volume-snapshot.
- Support scaling in or out multiple TiKV and TiFlash Pods at the same time.
- Support restoring a cluster to a specific time point from a snapshot backup or a log backup using BR.
- Support modifying the IOPS and throughput of AWS EBS storage used by a TiDB cluster.
- Support [TiProxy](https://github.com/pingcap/tiproxy) as an experimental feature.

## Usability

- Support configuring Liveness Probe for TiKV and PD.
- Support automatically setting the location labels for TiDB.
- Support mapping the short labels in the PD location labels to the well-known Kubernetes labels.
- Support customizing the Pod container configuration using the `additionalContainers` field.
- Support configuring the `--check-requirements` parameter for BR.
- Add metric port for TiFlash `Service`.
3 changes: 2 additions & 1 deletion zh/TOC.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
- [TiDB on Kubernetes 文档](https://docs.pingcap.com/zh/tidb-in-kubernetes/dev)
- 关于 TiDB Operator
- [简介](tidb-operator-overview.md)
- [v1.3 新特性](whats-new-in-v1.3.md)
- [v1.4 新特性](whats-new-in-v1.4.md)
- [快速上手](get-started.md)
- 部署
- 自托管的 Kubernetes
Expand Down Expand Up @@ -126,6 +126,7 @@
- [PingCAP Clinic 数据采集范围说明](clinic-data-collection.md)
- 版本发布历史
- v1.4
- [1.4 GA](releases/release-1.4.0.md)
- [1.4.0-beta.3](releases/release-1.4.0-beta.3.md)
- [1.4.0-beta.2](releases/release-1.4.0-beta.2.md)
- [1.4.0-beta.1](releases/release-1.4.0-beta.1.md)
Expand Down
24 changes: 24 additions & 0 deletions zh/releases/release-1.4.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: TiDB Operator 1.4.0 Release Notes
---

# TiDB Operator 1.4.0 Release Notes

发布日期: 2022 年 12 月 29 日

TiDB Operator 版本:1.4.0

## 新功能

- 支持使用新的 `TidbDashboard` CRD 独立管理 [TiDB Dashboard](https://github.com/pingcap/tidb-dashboard) ([#4787](https://github.com/pingcap/tidb-operator/pull/4787), [@SabaPing](https://github.com/SabaPing))
- 支持为 TiKV 与 PD 配置 Liveness Probe ([#4763](https://github.com/pingcap/tidb-operator/pull/4763), [@mikechengwei](https://github.com/mikechengwei))
- 支持基于 Amazon EBS 的 TiDB 集群 volume-snapshot 的备份和恢复 ([#4698](https://github.com/pingcap/tidb-operator/pull/4698),[@gozssky](https://github.com/gozssky)

ran-huang marked this conversation as resolved.
Show resolved Hide resolved
## 优化提升

- 支持配置 `.spec.preferIPv6: true` 兼容 IPv6 网络环境 ([#4811](https://github.com/pingcap/tidb-operator/pull/4811),[@KanShiori](https://github.com/KanShiori)

## Bug 修复

- 修复基于 EBS 快照备份无法恢复到不同 namespace 的问题 ([#4795](https://github.com/pingcap/tidb-operator/pull/4795), [@fengou1](https://github.com/fengou1))
- 修复日志备份停止占用 Complete 状态,导致调用方误认为日志备份 CR 已完成,从而无法继续对日志备份进行 Truncate 操作的问题 ([#4810](https://github.com/pingcap/tidb-operator/pull/4810), [@WizardXiao](https://github.com/WizardXiao))
1 change: 1 addition & 0 deletions zh/tidb-operator-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ TiDB Operator 与适用的 TiDB 版本的对应关系如下:
| TiDB 版本 | 适用的 TiDB Operator 版本 |
|:---|:---|
| dev | dev |
| TiDB >= 6.5 | 1.4(推荐),1.3 |
| TiDB >= 5.4 | 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 |
Expand Down
51 changes: 0 additions & 51 deletions zh/whats-new-in-v1.3.md

This file was deleted.

33 changes: 33 additions & 0 deletions zh/whats-new-in-v1.4.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: TiDB Operator v1.4 新特性
---

# TiDB Operator v1.4 新特性

TiDB Operator v1.4 引入了以下关键特性,从扩展性、易用性等方面帮助你更轻松地管理 TiDB 集群及其周边工具。

## 兼容性改动
ran-huang marked this conversation as resolved.
Show resolved Hide resolved

由于 [#4683](https://github.com/pingcap/tidb-operator/pull/4683) 的变更,存储修改的功能变为默认关闭的。如果你想扩容某个组件的 PVC,你需要先打开这个功能。

## 滚动更新改动

由于 [#4494](https://github.com/pingcap/tidb-operator/pull/4494) 的变更,如果你部署的 TiCDC 没有设置 `log-file` 配置项,那么升级 TiDB Operator 到 v1.4.0-alpha.1 及之后版本会导致 TiCDC 滚动重建。

## 扩展性

- 支持使用新的 `TidbDashboard` CRD 独立管理 [TiDB Dashboard](https://github.com/pingcap/tidb-dashboard)。
- 支持基于 Amazon EBS 的 TiDB 集群 volume-snapshot 的备份和恢复。
- 支持同时缩容或者扩容多个 TiKV 和 TiFlash Pods。
- 支持使用 BR 恢复集群到快照备份和日志备份的某个时间点。
- 支持修改 TiDB 集群所用的 AWS EBS 存储的 IOPS 与 throughput。
- 实验性支持 [TiProxy](https://github.com/pingcap/tiproxy)。

## 易用性

- 支持为 TiKV 与 PD 配置 Liveness Probe。
- 支持自动设置 TiDB 的 location labels。
- 支持将 PD 的 location labels 中的简短的 label 映射到众所周知的 Kubernetes 的 labels。
- 支持使用字段 `additionalContainers` 来自定义 Pod 容器的配置。
- 支持配置 BR 的 `--check-requirements` 参数。
- 为 TiFlash `Service` 添加 metric 端口。