Skip to content
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.

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

Backport of Updated docs added explanation. into release/1.15.x #17792

6 changes: 5 additions & 1 deletion website/content/commands/operator/raft.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,10 @@ Raft configuration.
`Voter` is "true" or "false", indicating if the server has a vote in the Raft
configuration.

`Commit Index` is the last log index the server has a record of in its Raft log.

`Trails Leader By` is the difference in commit index the server has from the leader.

#### Command Options

- `-stale` - Enables non-leader servers to provide cluster state information.
Expand Down Expand Up @@ -109,7 +113,7 @@ The return code will indicate success or failure.

Corresponding HTTP API Endpoint: [\[POST\] /v1/operator/raft/transfer-leader](/consul/api-docs/operator/raft#transfer-raft-leadership)

This command transfers Raft leadership to another server agent. If an `id` is provided, Consul transfers leadership to the server with that id.
This command transfers Raft leadership to another server agent. If an `id` is provided, Consul transfers leadership to the server with that id.

Use this command to change leadership without restarting the leader node, which maintains quorum and workload capacity.

Expand Down