Skip to content

Commit 73f0337

Browse files
authored
titan-configuration: remove the unrecommended steps of updating TiKV configuration (#21217) (#21224)
1 parent e724b49 commit 73f0337

File tree

2 files changed

+13
-12
lines changed

2 files changed

+13
-12
lines changed

storage-engine/titan-configuration.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -112,13 +112,21 @@ To adjust Titan-related parameters using TiUP, refer to [Modify the configuratio
112112

113113
## Disable Titan (experimental)
114114

115+
> **Warning:**
116+
>
117+
> Disabling Titan is an experimental feature. It is **NOT** recommended to use it if not necessary.
118+
115119
To disable Titan, you can configure the `rocksdb.defaultcf.titan.blob-run-mode` option. The optional values for `blob-run-mode` are as follows:
116120

117121
- When the option is set to `normal`, Titan performs read and write operations normally.
118122
- When the option is set to `read-only`, all newly written values are written into RocksDB, regardless of the value size.
119123
- When the option is set to `fallback`, all newly written values are written into RocksDB, regardless of the value size. Also, all compacted values stored in the Titan blob file are automatically moved back to RocksDB.
120124

121-
To disable Titan, perform the following steps:
125+
To disable Titan for all existing and future data, you can take the following steps. Note that you can skip Step 2 because it greatly affects online traffic performance. In fact even without Step 2, the data compaction consumes extra I/O and CPU resources when it moves data from Titan to RocksDB, and performance will degrade (sometimes as much as 50%) when TiKV I/O or CPU resources are limited.
126+
127+
> **Warning:**
128+
>
129+
> When disabling Titan for TiDB versions earlier than v8.5.0, it is not recommended to modify the TiKV configuration item [`rocksdb.titan.enabled`](/tikv-configuration-file.md#enabled) to `false`, as this might cause TiKV to crash. Following Step 1 is sufficient to disable Titan.
122130

123131
1. Update the configuration file of the TiKV nodes you wish to disable Titan for and restart TiKV:
124132

@@ -137,17 +145,6 @@ To disable Titan, perform the following steps:
137145

138146
3. After the compaction is finished, wait until the **Blob file count** metrics under **TiKV-Details/Titan - kv** decrease to `0`.
139147

140-
4. Update the configuration of these TiKV nodes to disable Titan.
141-
142-
```toml
143-
[rocksdb.titan]
144-
enabled = false
145-
```
146-
147-
> **Warning:**
148-
>
149-
> Disabling Titan is an experimental feature. It is **NOT** recommended to use it if not necessary.
150-
151148
## Level Merge (experimental)
152149

153150
In TiKV 4.0, [Level Merge](/storage-engine/titan-overview.md#level-merge), a new algorithm, is introduced to improve the performance of range query and to reduce the impact of Titan GC on the foreground write operations. You can enable Level Merge using the following option:

tikv-configuration-file.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1156,6 +1156,10 @@ Configuration items related to Titan.
11561156

11571157
### `enabled`
11581158

1159+
> **Warning**
1160+
>
1161+
> When disabling Titan for TiDB versions earlier than v8.5.0, it is not recommended to modify this configuration item to `false`, as this might cause TiKV to crash. To disable Titan, refer to the steps in [Disable Titan (experimental)](/storage-engine/titan-configuration.md#disable-titan-experimental).
1162+
11591163
+ Enables or disables Titan
11601164
+ Default value: `false`
11611165

0 commit comments

Comments
 (0)