Skip to content

Commit de115ed

Browse files
committed
fix(v1): clarify truncate-shards operates on hot shards
1 parent bba78ea commit de115ed

File tree

1 file changed

+18
-22
lines changed
  • content/enterprise_influxdb/v1/administration/manage/clusters

1 file changed

+18
-22
lines changed

content/enterprise_influxdb/v1/administration/manage/clusters/rebalance.md

Lines changed: 18 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -70,9 +70,9 @@ data node to expand the total disk capacity of the cluster.
7070
In the next steps, you will safely move shards from one of the two original data
7171
nodes to the new data node.
7272

73-
### Step 1: Truncate Hot Shards
73+
### Step 1: Truncate hot shards
7474

75-
Hot shards are shards that are currently receiving writes.
75+
Hot shards are shards that currently receive writes.
7676
Performing any action on a hot shard can lead to data inconsistency within the
7777
cluster which requires manual intervention from the user.
7878

@@ -84,12 +84,9 @@ cluster which requires manual intervention from the user.
8484
> For more information, see [`truncate-shards` and future data](/enterprise_influxdb/v1/tools/influxd-ctl/truncate-shards/#understand-the-risks-with-future-data)
8585
> or [contact InfluxData support](https://support.influxdata.com).
8686
87-
To prevent data inconsistency, truncate hot shards before moving any shards
87+
To prevent data inconsistency, truncate shards before moving any shards
8888
across data nodes.
89-
The command below creates a new hot shard which is automatically distributed
90-
across all data nodes in the cluster, and the system writes all new points to
91-
that shard.
92-
All previous writes are now stored in cold shards.
89+
The following command truncates all hot shards and creates new shards to write data to:
9390

9491
```
9592
influxd-ctl truncate-shards
@@ -101,10 +98,11 @@ The expected output of this command is:
10198
Truncated shards.
10299
```
103100

104-
Once you truncate the shards, you can work on redistributing the cold shards
105-
without the threat of data inconsistency in the cluster.
106-
Any hot or new shards are now evenly distributed across the cluster and require
107-
no further intervention.
101+
New shards are automatically distributed across all data nodes, and InfluxDB writes new points to them.
102+
Previous writes are stored in cold shards.
103+
104+
After truncating shards, you can redistribute cold shards without data inconsistency.
105+
Hot and new shards are evenly distributed and require no further intervention.
108106

109107
### Step 2: Identify Cold Shards
110108

@@ -309,9 +307,9 @@ name duration shardGroupDuration replicaN default
309307
autogen 0s 1h0m0s 3 #👍 true
310308
```
311309

312-
### Step 2: Truncate Hot Shards
310+
### Step 2: Truncate hot shards
313311

314-
Hot shards are shards that are currently receiving writes.
312+
Hot shards are shards that currently receive writes.
315313
Performing any action on a hot shard can lead to data inconsistency within the
316314
cluster which requires manual intervention from the user.
317315

@@ -323,12 +321,9 @@ cluster which requires manual intervention from the user.
323321
> For more information, see [`truncate-shards` and future data](/enterprise_influxdb/v1/tools/influxd-ctl/truncate-shards/#understand-the-risks-with-future-data)
324322
> or [contact InfluxData support](https://support.influxdata.com).
325323
326-
To prevent data inconsistency, truncate hot shards before copying any shards
324+
To prevent data inconsistency, truncate shards before copying any shards
327325
to the new data node.
328-
The command below creates a new hot shard which is automatically distributed
329-
across the three data nodes in the cluster, and the system writes all new points
330-
to that shard.
331-
All previous writes are now stored in cold shards.
326+
The following command truncates all hot shards and creates new shards to write data to:
332327

333328
```
334329
influxd-ctl truncate-shards
@@ -340,10 +335,11 @@ The expected output of this command is:
340335
Truncated shards.
341336
```
342337

343-
Once you truncate the shards, you can work on distributing the cold shards
344-
without the threat of data inconsistency in the cluster.
345-
Any hot or new shards are now automatically distributed across the cluster and
346-
require no further intervention.
338+
New shards are automatically distributed across all data nodes, and InfluxDB writes new points to them.
339+
Previous writes are stored in cold shards.
340+
341+
After truncating shards, you can redistribute cold shards without data inconsistency.
342+
Hot and new shards are evenly distributed and require no further intervention.
347343

348344
### Step 3: Identify Cold Shards
349345

0 commit comments

Comments
 (0)