Skip to content

Commit 5d5f669

Browse files
authored
titan-configuration: remove the unrecommended steps of updating TiKV configuration (#21217) (#21221)
1 parent 743fc24 commit 5d5f669

File tree

2 files changed

+9
-8
lines changed

2 files changed

+9
-8
lines changed

storage-engine/titan-configuration.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,11 @@ To disable Titan, you can configure the `rocksdb.defaultcf.titan.blob-run-mode`
118118
- When the option is set to `read-only`, all newly written values are written into RocksDB, regardless of the value size.
119119
- 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.
120120

121-
To fully disable Titan for all existing and future data, you can follow these steps:
121+
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.
122+
123+
> **Warning:**
124+
>
125+
> 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.
122126

123127
1. Update the configuration of the TiKV nodes you wish to disable Titan for. You can update configuration in two methods:
124128

@@ -139,13 +143,6 @@ To fully disable Titan for all existing and future data, you can follow these st
139143

140144
3. After the compaction is finished, you should wait for the **Blob file count** metrics under **TiKV-Details**/**Titan - kv** to decrease to `0`.
141145

142-
4. Update the configuration of these TiKV nodes to disable Titan.
143-
144-
```toml
145-
[rocksdb.titan]
146-
enabled = false
147-
```
148-
149146
## Level Merge (experimental)
150147

151148
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
@@ -1334,6 +1334,10 @@ Configuration items related to Titan.
13341334

13351335
### `enabled`
13361336

1337+
> **Warning**
1338+
>
1339+
> 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](/storage-engine/titan-configuration.md#disable-titan).
1340+
13371341
+ Enables or disables Titan
13381342
+ Default value: `false`
13391343

0 commit comments

Comments
 (0)