Skip to content

Commit f487787

Browse files
author
mrmahi2003
committed
docs: add raft connection flags section
Signed-off-by: mrmahi2003 <maahirchauhan20@icloud.com>
1 parent 7047ac4 commit f487787

1 file changed

Lines changed: 60 additions & 0 deletions

File tree

content/en/docs/v3.5/op-guide/configuration.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,66 @@ The list of flags provided below may not be up-to-date due to ongoing developmen
8383
--socket-reuse-address 'false'
8484
Enable to set socket option SO_REUSEADDR on listeners allowing binding to an address in TIME_WAIT state.
8585
```
86+
### Raft connection flags
87+
88+
```nocode
89+
--max-snapshots '5'
90+
Maximum number of snapshot files to retain (0 is unlimited).
91+
92+
--max-wals '5'
93+
Maximum number of wal files to retain (0 is unlimited).
94+
95+
--snapshot-count '100000'
96+
Number of committed transactions to trigger a snapshot to disk.
97+
98+
--heartbeat-interval '100'
99+
Time (in milliseconds) of a heartbeat interval.
100+
101+
--election-timeout '1000'
102+
Time (in milliseconds) for an election to timeout.
103+
104+
--initial-election-tick-advance 'true'
105+
Whether to fast-forward initial election ticks on boot for faster election.
106+
107+
--quota-backend-bytes '0'
108+
Raise alarms when backend size exceeds the given quota (0 defaults to low space quota).
109+
110+
--backend-bbolt-freelist-type 'map'
111+
BackendFreelistType specifies the type of freelist that boltdb backend uses (array and map are supported types).
112+
113+
--backend-batch-interval '0'
114+
BackendBatchInterval is the maximum time before commit the backend transaction.
115+
116+
--backend-batch-limit '0'
117+
BackendBatchLimit is the maximum operations before commit the backend transaction.
118+
119+
--max-txn-ops '128'
120+
Maximum number of operations permitted in a transaction.
121+
122+
--max-request-bytes '1572864'
123+
Maximum client request size in bytes the server will accept.
124+
125+
--grpc-keepalive-min-time '5s'
126+
Minimum interval duration that a client should wait before pinging server.
127+
128+
--grpc-keepalive-interval '2h'
129+
Frequency duration of server-to-client ping to check if a connection is alive (0 to disable).
130+
131+
--grpc-keepalive-timeout '20s'
132+
Additional duration of wait before closing a non-responsive connection (0 to disable).
133+
134+
--socket-reuse-port 'false'
135+
Enable to set socket option SO_REUSEPORT on listeners allowing rebinding of a port already in use.
136+
137+
--socket-reuse-address 'false'
138+
Enable to set socket option SO_REUSEADDR on listeners allowing binding to an address in TIME_WAIT state.
139+
140+
--max-concurrent-streams 'math.MaxUint32'
141+
Maximum concurrent streams that each client can open at a time.
142+
143+
--raft-read-timeout '10s'
144+
Read timeout set on each rafthttp connection.
145+
```
86146
### Clustering
87147

88148
```nocode

0 commit comments

Comments
 (0)