docs(proposal): support multiple replicas with leader election

[ivankatliarchuk]

Description

Full pull request is here #5033

Motivation for split #4598 (comment)

The plan is to add documentation, and move main logic from main.go to it's own function as part of this pull request. This should help to focus on testing an actual feature, without constant need to rebase main.go file. Currently all the flags changes affects main.go, this may need to be addressed at some point as well.

Checklist

• Unit tests updated
• End user documentation updated

[ivankatliarchuk]

/kind documentation
/king feature
/label tide/merge-method-squash

[mloiseleur]

@ivankatliarchuk You need to link this doc in mkdocs.yml, like the other proposal, see here.

There is a typo in the diagram: "urrentLeader" instead of "CurrentLeader".

BTW, if you can do the schema with mermaid instead of a png, it's (way) easier to maintain it. See https://kubernetes.io/docs/contribute/style/diagram-guide/

[ivankatliarchuk]

Addressed

[mloiseleur]

Thanks, it's quite clear 👍 .
See my suggestion for minor improvements.

I'm unsure if you really wanted to add internal/testutils/logs.go to this PR ?

[ivankatliarchuk]

Yeah, that logs.go could w8. Removed.

[mloiseleur]

/retitle docs(proposal): support multiple replicas with leader election

[mloiseleur]

/lgtm

@szuecs @Raffo @Dadeos-Menlo You are more than welcome to review this proposal 🙏

[mloiseleur]

Part of #2430

[ivankatliarchuk]

/kind proposal

[k8s-ci-robot]

@ivankatliarchuk: The label(s) kind/proposal cannot be applied, because the repository doesn't have them.

In response to this:

/kind proposal

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

[k8s-ci-robot]

New changes are detected. LGTM label has been removed.

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from mloiseleur. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[ivankatliarchuk]

Added header

---
title: leader election proposal
version: v1
authors: 
creation-date: 
status: draft
---

[ivankatliarchuk]

/kind feature