docs: add raft connection flags section #1109
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: Mvrk08 The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
Hi @Mvrk08. Thanks for your PR. I'm waiting for a etcd-io member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. DetailsInstructions 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. |
Mvrk08
force-pushed
the
docs-add-raft-connection-flags
branch
from
cf8e0a5 to
f487787
Compare
| --max-concurrent-streams 'math.MaxUint32' | ||
| Maximum concurrent streams that each client can open at a time. | ||
| --raft-read-timeout '10s' |
Mvrk08
force-pushed
the
docs-add-raft-connection-flags
branch
from
f487787 to
090a866
Compare
| --raft-read-timeout '10s' | ||
| Read timeout set on each rafthttp connection. | ||
| ``` |
There was a problem hiding this comment.
--raft-write-timeout https://github.com/etcd-io/etcd/blob/main/server/embed/config.go#L640 also needs to be added.
| ### Raft connection flags | ||
|
|
||
| ```nocode | ||
| --max-snapshots '5' |
There was a problem hiding this comment.
This flag will be deprecated in v3.6. When you will be backporting the changes to v3.6, you will have to remove this one.
It can be achieved in 2 steps:
- Keep the flag in v3.5 but add a comment saying that
Deprecated in v3.6 and will be decommissioned in v3.8." - Once you will be backporting the changes to v3.6, do not mention this flag.
There was a problem hiding this comment.
I don't think it's getting deprecated in 3.6 etcd-io/etcd#21163
There was a problem hiding this comment.
Thank you @ishan16696.
As seen in the PR, the description should be updated to: Number of committed transactions to trigger a snapshot
| Whether to fast-forward initial election ticks on boot for faster election. | ||
| --quota-backend-bytes '0' | ||
| Raise alarms when backend size exceeds the given quota (0 defaults to low space quota). |
There was a problem hiding this comment.
This comment should be Sets the maximum size (in bytes) that the etcd backend database may consume. Exceeding this triggers an alarm and puts etcd in read-only mode. Set to 0 to use the default 2GiB limit."
CodeRef
Mvrk08
force-pushed
the
docs-add-raft-connection-flags
branch
4 times, most recently
from
42a0194 to
bd8cc1e
Compare
Signed-off-by: mrmahi2003 <maahirchauhan20@icloud.com>
Mvrk08
force-pushed
the
docs-add-raft-connection-flags
branch
from
bd8cc1e to
9c80132
Compare
4 participants
Description :
This PR adds a new section for Raft connection flags to the configuration documentation. It documents the flags used for tuning Raft consensus and transport behavior.
Changes made :
Added the full list of Raft connection flags (e.g., --heartbeat-interval, --election-timeout, --raft-read-timeout).
Added --raft-write-timeout as requested in the review.
Updated descriptions for --snapshot-count and --quota-backend-bytes to match current behavior.
Build Fix: Added the missing {#logging} anchor to the "Logging flags" header. This fixes the check-links failure in the Netlify build where quickstart/index.html was unable to link to the logging section.
Part of #1074