-
Notifications
You must be signed in to change notification settings - Fork 339
docs: add raft connection flags section #1109
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Mvrk08
wants to merge
1
commit into
etcd-io:main
Choose a base branch
from
Mvrk08:docs-add-raft-connection-flags
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -83,6 +83,51 @@ The list of flags provided below may not be up-to-date due to ongoing developmen | |
| --socket-reuse-address 'false' | ||
| Enable to set socket option SO_REUSEADDR on listeners allowing binding to an address in TIME_WAIT state. | ||
| ``` | ||
| ### Raft connection flags | ||
|
|
||
| ```nocode | ||
| --max-snapshots '5' | ||
| Maximum number of snapshot files to retain (0 is unlimited). | ||
| --max-wals '5' | ||
| Maximum number of wal files to retain (0 is unlimited). | ||
| --snapshot-count '100000' | ||
| Number of committed transactions to trigger a snapshot. | ||
| --heartbeat-interval '100' | ||
| Time (in milliseconds) of a heartbeat interval. | ||
| --election-timeout '1000' | ||
| Time (in milliseconds) for an election to timeout. | ||
| --initial-election-tick-advance 'true' | ||
| Whether to fast-forward initial election ticks on boot for faster election. | ||
| --quota-backend-bytes '0' | ||
| 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. | ||
| --backend-bbolt-freelist-type 'map' | ||
| BackendFreelistType specifies the type of freelist that boltdb backend uses (array and map are supported types). | ||
| --backend-batch-interval '0' | ||
| BackendBatchInterval is the maximum time before commit the backend transaction. | ||
| --backend-batch-limit '0' | ||
| BackendBatchLimit is the maximum operations before commit the backend transaction. | ||
| --max-txn-ops '128' | ||
| Maximum number of operations permitted in a transaction. | ||
| --max-request-bytes '1572864' | ||
| Maximum client request size in bytes the server will accept. | ||
| --grpc-keepalive-min-time '5s' | ||
| Minimum interval duration that a client should wait before pinging server. | ||
| --grpc-keepalive-interval '2h' | ||
| Frequency duration of server-to-client ping to check if a connection is alive (0 to disable). | ||
| --grpc-keepalive-timeout '20s' | ||
| Additional duration of wait before closing a non-responsive connection (0 to disable). | ||
| --socket-reuse-port 'false' | ||
| Enable to set socket option SO_REUSEPORT on listeners allowing rebinding of a port already in use. | ||
| --socket-reuse-address 'false' | ||
| Enable to set socket option SO_REUSEADDR on listeners allowing binding to an address in TIME_WAIT state. | ||
| --max-concurrent-streams 'math.MaxUint32' | ||
| Maximum concurrent streams that each client can open at a time. | ||
| --raft-read-timeout '5s' | ||
| Read timeout set on each rafthttp connection. | ||
| --raft-write-timeout '5s' | ||
| Write timeout set on each rafthttp connection. | ||
| ``` | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
|
|
||
| ### Clustering | ||
|
|
||
| ```nocode | ||
|
|
@@ -196,7 +241,7 @@ The list of flags provided below may not be up-to-date due to ongoing developmen | |
| --listen-metrics-urls '' | ||
| List of URLs to listen on for the metrics and health endpoints. | ||
| ``` | ||
| ### Logging | ||
| ### Logging flags {#logging} | ||
|
|
||
| ```nocode | ||
| --logger 'zap' | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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:
Deprecated in v3.6 and will be decommissioned in v3.8."Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think it's getting deprecated in 3.6 etcd-io/etcd#21163
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you @ishan16696.
As seen in the PR, the description should be updated to:
Number of committed transactions to trigger a snapshotxref