Skip to content

Commit

Permalink
en,zh: Add release notes for v1.3.0-beta.1 (#1589)
Browse files Browse the repository at this point in the history
  • Loading branch information
just1900 authored Jan 12, 2022
1 parent 8820ba4 commit df526cb
Show file tree
Hide file tree
Showing 4 changed files with 81 additions and 0 deletions.
2 changes: 2 additions & 0 deletions en/TOC.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,8 @@
- [Log Collection](logs-collection.md)
- [Monitoring and Alert on Kubernetes](monitor-kubernetes.md)
- Release Notes
- v1.3
- [1.3.0-beta.1](releases/release-1.3.0-beta.1.md)
- v1.2
- [1.2.6](releases/release-1.2.6.md)
- [1.2.5](releases/release-1.2.5.md)
Expand Down
38 changes: 38 additions & 0 deletions en/releases/release-1.3.0-beta.1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
title: TiDB Operator 1.3.0-beta.1 Release Notes
---
# TiDB Operator 1.3.0-beta.1 Release Notes

Release date: January 12, 2022

TiDB Operator version: 1.3.0-beta.1

## Compatibility Change

Due to changes in [#4209](https://github.com/pingcap/tidb-operator/pull/4209), if Webhook is deployed and `ValidatingWebhook` and `MutatingWebhook` of Pods are enabled with TiDB Operator v1.2 or earlier versions, upgrading TiDB Operator to v1.3.0-beta.1 will cause `ValidatingWebhook` and `MutatingWebhook` to be deleted. But this has no impact on TiDB cluster management.

## 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.
- Due to changes in [#4169](https://github.com/pingcap/tidb-operator/pull/4169) , for TiDB clusters >= v5.0, if `spec.tikv.seperateRocksDBLog: true` or `spec.tikv.separateRaftLog: true` is configured, upgrading TiDB Operator to v1.3.0-beta.1 causes TiKV to rolling upgrade.

## New Features

- Support configuring the resource usage for the init container of TiFlash ([#4304](https://github.com/pingcap/tidb-operator/pull/4304), [@KanShiori](https://github.com/KanShiori))
- Support enabling continuous profiling for the TiDB cluster ([#4287](https://github.com/pingcap/tidb-operator/pull/4287), [@KanShiori](https://github.com/KanShiori))
- Support gracefully restarting TiKV through annotations ([#4279](https://github.com/pingcap/tidb-operator/pull/4279), [@july2993](https://github.com/july2993))
- Support `PodSecurityContext` and other configurations for Discovery ([#4259](https://github.com/pingcap/tidb-operator/pull/4259), [@csuzhangxc](https://github.com/csuzhangxc), [#4208](https://github.com/pingcap/tidb-operator/pull/4208), [@KanShiori](https://github.com/KanShiori))
- Support configuring `PodManagementPolicy` in TidbCluster CR ([#4211](https://github.com/pingcap/tidb-operator/pull/4211), [@mianhk](https://github.com/mianhk))
- Support configuring Prometheus shards in TidbMonitor CR ([#4198](https://github.com/pingcap/tidb-operator/pull/4198), [@mikechengwei](https://github.com/mikechengwei))
- Support deploying TiDB Operator in Kubernetes v1.22 or later versions ([#4195](https://github.com/pingcap/tidb-operator/pull/4195), [#4202](https://github.com/pingcap/tidb-operator/pull/4202), [@KanShiori](https://github.com/KanShiori))

## Improvements

- Remove and change some default configurations for TiFlash due to configuration changes in TiFlash v5.4.0. 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. ([#4358](https://github.com/pingcap/tidb-operator/pull/4358), [@KanShiori](https://github.com/KanShiori))
- Improve advanced deployment example of TidbMonitor. ([#4242](https://github.com/pingcap/tidb-operator/pull/4242), [@mianhk](https://github.com/mianhk))
- Optimize the user experience of heterogenous clusters by displaying the metrics for one TiDB cluster and its heterogeneous clusters in the same dashboards. ([#4210](https://github.com/pingcap/tidb-operator/pull/4210), [@mikechengwei](https://github.com/mikechengwei))
- Use `secretRef` to obtain Grafana password in TidbMonitor to avoid using plaintext password. ([#4135](https://github.com/pingcap/tidb-operator/pull/4135), [@mianhk](https://github.com/mianhk))
- Optimize the upgrade process for PD and TiKV components with fewer than two replicas, and force the upgrade of PD and TiKV components by default to avoid the upgrade process from taking too long ([#4107](https://github.com/pingcap/tidb-operator/pull/4107), [#4091](https://github.com/pingcap/tidb-operator/pull/4091), [@mianhk](https://github.com/mianhk))
- Update Grafana images in examples to 7.5.11 to enhance security ([#4212](https://github.com/pingcap/tidb-operator/pull/4212), [@makocchi-git](https://github.com/makocchi-git))
- Deprecate Pod validating and mutating webhook ([#4209](https://github.com/pingcap/tidb-operator/pull/4209), [@mianhk](https://github.com/mianhk))
- Support configuring the number of tidb-controller-manager workers in Helm chart ([#4111](https://github.com/pingcap/tidb-operator/pull/4111), [@mianhk](https://github.com/mianhk))
2 changes: 2 additions & 0 deletions zh/TOC.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,8 @@
- [日志收集](logs-collection.md)
- [Kubernetes 监控与告警](monitor-kubernetes.md)
- 版本发布历史
- v1.3
- [1.3.0-beta.1](releases/release-1.3.0-beta.1.md)
- v1.2
- [1.2.6](releases/release-1.2.6.md)
- [1.2.5](releases/release-1.2.5.md)
Expand Down
39 changes: 39 additions & 0 deletions zh/releases/release-1.3.0-beta.1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: TiDB Operator 1.3.0-beta.1 Release Notes
---

# TiDB Operator 1.3.0-beta.1 Release Notes

发布日期: 2022 年 1 月 12 日

TiDB Operator 版本:1.3.0-beta.1

## 兼容性改动

由于 [#4209](https://github.com/pingcap/tidb-operator/pull/4209) 的变更,如果使用 v1.2 及更早版本的 TiDB Operator 在集群部署了 Webhook,并启用了 Pod `ValidatingWebhook``MutatingWebhook`,升级 TiDB Operator 到 v1.3.0-beta.1 版本后,Pod `ValidatingWebhook``MutatingWebhook` 被删除,但这不会对 TiDB 集群管理产生影响,也不会影响正在运行的 TiDB 集群。

## 滚动升级改动

- 由于 [#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 及以上版本。
- 由于 [#4169](https://github.com/pingcap/tidb-operator/pull/4169) 的变更,如果部署了 v5.0 及更新版本的 TiDB 集群,并且设置了 `spec.tikv.seperateRocksDBLog: true` 或者 `spec.tikv.separateRaftLog: true`,升级 TiDB Operator 到 v1.3.0-beta.1 版本会导致 TiKV 组件滚动更新。

## 新功能

- 支持为 TiFlash 的 init container 配置资源使用量 ([#4304](https://github.com/pingcap/tidb-operator/pull/4304), [@KanShiori](https://github.com/KanShiori))
- 支持为 TiDB 集群开启[持续性能分析](https://docs.pingcap.com/zh/tidb-in-kubernetes/dev/access-dashboard#启用持续性能分析) ([#4287](https://github.com/pingcap/tidb-operator/pull/4287), [@KanShiori](https://github.com/KanShiori))
- 支持通过配置 annotation 的方式优雅重启单个 TiKV Pod ([#4279](https://github.com/pingcap/tidb-operator/pull/4279), [@july2993](https://github.com/july2993))
- 支持为 Discovery 组件自定义 PodSecurityContext 等更多配置 ([#4259](https://github.com/pingcap/tidb-operator/pull/4259), [@csuzhangxc](https://github.com/csuzhangxc), [#4208](https://github.com/pingcap/tidb-operator/pull/4208), [@KanShiori](https://github.com/KanShiori))
- 支持为 TidbCluster CR 配置 PodManagementPolicy ([#4211](https://github.com/pingcap/tidb-operator/pull/4211), [@mianhk](https://github.com/mianhk))
- 支持在 TidbMonitor CR 中配置 Prometheus 分片 ([#4198](https://github.com/pingcap/tidb-operator/pull/4198), [@mikechengwei](https://github.com/mikechengwei))
- 支持在 v1.22 及更新版本的 kubernetes 集群中使用 TiDB Operator ([#4195](https://github.com/pingcap/tidb-operator/pull/4195), [#4202](https://github.com/pingcap/tidb-operator/pull/4202), [@KanShiori](https://github.com/KanShiori))

## 优化提升

- 适配 v5.4.0 版本 TiFlash 的配置变动,去除和变更了 TiFlash 的默认配置。如果使用 v1.2 版本 TiDB Operator 部署了 v5.4 及更新版本的 TiDB 集群,升级 TiDB Operator 到 v1.3.0-beta.1 版本会导致 TiFlash 组件滚动更新。([#4358](https://github.com/pingcap/tidb-operator/pull/4358), [@KanShiori](https://github.com/KanShiori))
- 优化 TidbMonitor 部署示例 ([#4242](https://github.com/pingcap/tidb-operator/pull/4242), [@mianhk](https://github.com/mianhk))
- 优化异构集群使用体验,可以在同一个 Dashboard 中查看 TidbCluster 和与它异构部署的 TidbCluster 的监控项 ([#4210](https://github.com/pingcap/tidb-operator/pull/4210), [@mikechengwei](https://github.com/mikechengwei))
- 优化在 TidbMonitor 中使用 secretRef 来获取 Grafana 的密码,避免使用明文密码 ([#4135](https://github.com/pingcap/tidb-operator/pull/4135), [@mianhk](https://github.com/mianhk))
- 优化副本数小于 2 的 PD 和 TiKV 组件升级过程,默认强制升级 PD 和 TiKV 组件,避免升级过程耗时过长 ([#4107](https://github.com/pingcap/tidb-operator/pull/4107), [#4091](https://github.com/pingcap/tidb-operator/pull/4091), [@mianhk](https://github.com/mianhk))
- 升级 Grafana 镜像版本为 7.5.11,提升安全性 ([#4212](https://github.com/pingcap/tidb-operator/pull/4212), [@makocchi-git](https://github.com/makocchi-git))
- 废弃 Pod validating 和 mutating webhook ([#4209](https://github.com/pingcap/tidb-operator/pull/4209), [@mianhk](https://github.com/mianhk))
- Helm chart 支持配置 tidb-controller-manager 的 workers 数量 ([#4111](https://github.com/pingcap/tidb-operator/pull/4111), [@mianhk](https://github.com/mianhk))

0 comments on commit df526cb

Please sign in to comment.