Skip to content

Update forget docs for ban-list propagation #1057

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 15, 2025
Merged

Update forget docs for ban-list propagation #1057

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
484faa6
Update forget docs for ban-list propagation
nosammai Jan 15, 2025
955a993
Update content/commands/cluster-forget/index.md
nosammai Jan 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions content/commands/cluster-forget/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@ complexity: O(1)
description: Removes a node from the nodes table.
group: cluster
hidden: false
history:
- - 7.2.0
- Forgotten nodes are automatically propagated across the cluster via gossip.
linkTitle: CLUSTER FORGET
since: 3.0.0
summary: Removes a node from the nodes table.
Expand All @@ -49,6 +52,10 @@ table of the node receiving the command, it also implements a ban-list, not
allowing the same node to be added again as a side effect of processing the
*gossip section* of the heartbeat packets received from other nodes.

Starting with Redis 7.2.0, the ban-list is included in cluster gossip ping/pong messages.
This means that `CLUSTER FORGET` doesn't need to be sent to all nodes in a cluster.
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.

## Details on why the ban-list is needed

In the following example we'll show why the command must not just remove
Expand Down Expand Up @@ -86,3 +93,8 @@ The command does not succeed and returns an error in the following cases:
1. The specified node ID is not found in the nodes table.
2. The node receiving the command is a replica, and the specified node ID identifies its current master.
3. The node ID identifies the same node we are sending the command to.

## Behavior change history

* `>= 7.2.0`: Automatically propagate node deletion to other nodes in a cluster, allowing nodes to be deleted with a single call
in most cases.
Loading