From 4ad6aaab72897173c30e8568d0e05d0dea5e17f6 Mon Sep 17 00:00:00 2001 From: hc-github-team-consul-core Date: Wed, 21 Jun 2023 02:17:04 -0400 Subject: [PATCH] Backport of Updated docs added explanation. into release/1.15.x (#17792) * backport of commit 2f94024b356f774d0032ad069babb1a3fce6cfbd * backport of commit 7626d0992dd59f424d893dd462bbde3a9cb0646c * backport of commit 79aabc958aed60b2bd97c836529d53a627262124 * backport of commit 44eee4168b5a0d405636dbcb5b14ee7959334550 * 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 * nits * updated docs * explanation added --------- Co-authored-by: Semir Patel --------- Co-authored-by: Ashesh Vidyut Co-authored-by: Ashesh Vidyut <134911583+absolutelightning@users.noreply.github.com> Co-authored-by: Semir Patel --- website/content/commands/operator/raft.mdx | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/website/content/commands/operator/raft.mdx b/website/content/commands/operator/raft.mdx index 25dea30ba62f..b89c0385ac88 100644 --- 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.