Document pre-vote flag

[serathius]

What would you like to be added?

Current flag documentation in command line:

  --pre-vote 'true'
    Enable to run an additional Raft election phase.

From the original PR #9352

Why is this needed?

Users are not aware of this feature #17326. Expect lack of proper documentation is the main reason.

[UtkarshUmre]

@serathius What needs to be done to resolve this issue?Is this a good first issue?

[serathius]

Read the feature description in #9352 and improve the existing command line documentation for the flag

etcd/server/embed/config.go

Line 647 in ca41186

fs.BoolVar(&cfg.PreVote, "pre-vote", cfg.PreVote, "Enable to run an additional Raft election phase.")

Basically expand the text Enable to run an additional Raft election phase.

Is this a good first issue?

Depends, no coding but it requires a good understanding of raft protocol.

[UtkarshUmre]

I understand, and I will look more into this before raising a pull request soon. Where can I find more information about the Raft protocol?

[serathius]

https://raft.github.io/ and https://raft.github.io/raft.pdf

[shreemaan-abhishek]

I would like to take this up.

[nitishfy]

Hi there, If possible, I'd like to work on this:)