Skip to content

Commit c0cb195

Browse files
authored
add-tikv-config: add max-days and max-backups (#2777)
1 parent 78dda3e commit c0cb195

File tree

2 files changed

+14
-4
lines changed

2 files changed

+14
-4
lines changed

en/configure-a-tidb-cluster.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -408,13 +408,18 @@ spec:
408408
[storage]
409409
[storage.block-cache]
410410
capacity = "16GB"
411+
[log.file]
412+
max-days = 30
413+
max-backups = 30
411414
```
412415

413416
For all the configurable parameters of TiKV, refer to [TiKV Configuration File](https://docs.pingcap.com/tidb/stable/tikv-configuration-file).
414417

415418
> **Note:**
416419
>
417-
> If you deploy your TiDB cluster using CR, make sure that `Config: {}` is set, no matter you want to modify `config` or not. Otherwise, TiKV components might not be started successfully. This step is meant to be compatible with `Helm` deployment.
420+
> - If you deploy your TiDB cluster using CR, make sure that `Config: {}` is set, no matter you want to modify `config` or not. Otherwise, TiKV components might not be started successfully. This step is meant to be compatible with `Helm` deployment.
421+
> - TiKV RocksDB logs are stored in the `/var/lib/tikv` data directory by default. It is recommended that you configure `max-days` and `max-backups` to automatically clean log files.
422+
> - You can also use the `separateRocksDBLog` configuration item to configure TiKV to output RocksDB logs to stdout through a sidecar container. For more information, see the [TiDB Cluster example](https://github.com/pingcap/tidb-operator/blob/master/examples/advanced/tidb-cluster.yaml).
418423

419424
#### Configure PD parameters
420425

@@ -487,7 +492,7 @@ spec:
487492
level = "info"
488493
```
489494

490-
For all the configurable parameters of TiProxy, refer to [TiProxy Configuration File](https://docs.pingcap.com/tidb/v7.6/tiproxy-configuration).
495+
For all the configurable parameters of TiProxy, refer to [TiProxy Configuration File](https://docs.pingcap.com/tidb/stable/tiproxy-configuration).
491496

492497
#### Configure TiFlash parameters
493498

zh/configure-a-tidb-cluster.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -402,13 +402,18 @@ spec:
402402
[storage]
403403
[storage.block-cache]
404404
capacity = "16GB"
405+
[log.file]
406+
max-days = 30
407+
max-backups = 30
405408
```
406409

407410
获取所有可以配置的 TiKV 配置参数,请参考 [TiKV 配置文档](https://docs.pingcap.com/zh/tidb/stable/tikv-configuration-file)
408411

409412
> **注意:**
410413
>
411-
> 为了兼容 `helm` 部署,如果你是通过 CR 文件部署 TiDB 集群,即使你不设置 Config 配置,也需要保证 `Config: {}` 的设置,从而避免 TiKV 组件无法正常启动。
414+
> - 为了兼容 `helm` 部署,如果你是通过 CR 文件部署 TiDB 集群,即使你不设置 Config 配置,也需要保证 `Config: {}` 的设置,从而避免 TiKV 组件无法正常启动。
415+
> - TiKV 的 RocksDB 日志默认存储在 `/var/lib/tikv` 数据目录,建议配置 `max-days` 和 `max-backups` 来自动清理日志文件。
416+
> - 你也可通过配置 `separateRocksDBLog` 将 RocksDB 日志通过单独的 sidecar 容器输出到 stdout。完整配置项请参考 [TiDB Cluster 示例](https://github.com/pingcap/tidb-operator/blob/master/examples/advanced/tidb-cluster.yaml)。
412417

413418
#### 配置 PD 配置参数
414419

@@ -477,7 +482,7 @@ spec:
477482
level = "info"
478483
```
479484

480-
获取所有可以配置的 TiProxy 配置参数,请参考 [TiProxy 配置文档](https://docs.pingcap.com/zh/tidb/v7.6/tiproxy-configuration)。
485+
获取所有可以配置的 TiProxy 配置参数,请参考 [TiProxy 配置文档](https://docs.pingcap.com/zh/tidb/stable/tiproxy-configuration)。
481486

482487
#### 配置 TiFlash 配置参数
483488

0 commit comments

Comments
 (0)