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

* backport of commit 2f94024 * backport of commit 7626d09 * backport of commit 79aabc9 * backport of commit 44eee41 * fix conflicts * Updated docs added explanation. (#17751) * 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 --------- Co-authored-by: Semir Patel <[email protected]> --------- Co-authored-by: Ashesh Vidyut <[email protected]> Co-authored-by: Ashesh Vidyut <[email protected]> Co-authored-by: Semir Patel <[email protected]>
hashicorp · Jun 21, 2023 · 4ad6aaa · 4ad6aaa
1 parent 6a833cd
commit 4ad6aaa
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/website/content/commands/operator/raft.mdx b/website/content/commands/operator/raft.mdx
@@ -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.
@@ -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.