Skip to content

Commit

Permalink
Fix Docs for Trails Leader By (#17763)
Browse files Browse the repository at this point in the history
* init

* fix tests

* added -detailed in docs

* added change log

* fix doc

* checking for entry in map

* fix tests

* removed detailed flag

* removed detailed flag

* revert unwanted changes

* removed unwanted changes

* updated change log

* pr review comment changes

* pr comment changes single API instead of two

* fix change log

* fix tests

* fix tests

* fix test operator raft endpoint test

* Update .changelog/17582.txt

Co-authored-by: Semir Patel <[email protected]>

* nits

* updated docs

* explanation added

* fix doc

* fix docs

---------

Co-authored-by: Semir Patel <[email protected]>
  • Loading branch information
absolutelightning and analogue committed Jun 17, 2023
1 parent 37636ea commit 00c8575
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions website/content/commands/operator/raft.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ 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.
`Trails Leader By` is the number of commits a follower trails the leader by.

#### Command Options

Expand Down Expand Up @@ -113,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

0 comments on commit 00c8575

Please sign in to comment.