Skip to content

Commit 68d8a18

Browse files
Update forget docs for ban-list propagation (#1057)
* Update forget docs for ban-list propagation Update CLUSTER FORGET docs for changes in redis/redis#10869 * Update content/commands/cluster-forget/index.md Co-authored-by: David Dougherty <david.dougherty@redis.com> --------- Co-authored-by: David Dougherty <david.dougherty@redis.com>
1 parent 1278ccc commit 68d8a18

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

content/commands/cluster-forget/index.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@ complexity: O(1)
2626
description: Removes a node from the nodes table.
2727
group: cluster
2828
hidden: false
29+
history:
30+
- - 7.2.0
31+
- Forgotten nodes are automatically propagated across the cluster via gossip.
2932
linkTitle: CLUSTER FORGET
3033
since: 3.0.0
3134
summary: Removes a node from the nodes table.
@@ -49,6 +52,10 @@ table of the node receiving the command, it also implements a ban-list, not
4952
allowing the same node to be added again as a side effect of processing the
5053
*gossip section* of the heartbeat packets received from other nodes.
5154

55+
Starting with Redis 7.2.0, the ban-list is included in cluster gossip ping/pong messages.
56+
This means that `CLUSTER FORGET` doesn't need to be sent to all nodes in a cluster.
57+
You can run the command on one or more nodes, after which it will be propagated to the rest of the nodes in most cases.
58+
5259
## Details on why the ban-list is needed
5360

5461
In the following example we'll show why the command must not just remove
@@ -86,3 +93,8 @@ The command does not succeed and returns an error in the following cases:
8693
1. The specified node ID is not found in the nodes table.
8794
2. The node receiving the command is a replica, and the specified node ID identifies its current master.
8895
3. The node ID identifies the same node we are sending the command to.
96+
97+
## Behavior change history
98+
99+
* `>= 7.2.0`: Automatically propagate node deletion to other nodes in a cluster, allowing nodes to be deleted with a single call
100+
in most cases.

0 commit comments

Comments
 (0)