Skip to content

Commit

Permalink
docs: add docs for kv_max_value_size (hashicorp#7405)
Browse files Browse the repository at this point in the history
Apart from the added docs, the error messages are similar now and are
pointing to the corresponding options.
Fixes hashicorp#6708.
  • Loading branch information
hanshasselberg authored and alvin-huang committed May 6, 2020
1 parent be4424f commit 215b57f
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions website/source/docs/agent/options.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -1449,12 +1449,23 @@ Valid time units are 'ns', 'us' (or 'µs'), 'ms', 's', 'm', 'h'."
single RPC call to a Consul server. See
https://en.wikipedia.org/wiki/Token_bucket for more details about how
token bucket rate limiters operate.
* <a name="kv_max_value_size"></a><a href="#kv_max_value_size">
`kv_max_value_size`</a> - **(Advanced)** Configures the maximum number of
bytes for a kv request body to the [`/v1/kv`](/api/kv.html) endpoint.
This limit defaults to [raft's](https://github.com/hashicorp/raft)
suggested max size(512KB). **Note that tuning these improperly can cause
Consul to fail in unexpected ways**, it may potentially affect
leadership stability and prevent timely heartbeat signals by increasing
RPC IO duration.
This option affects the txn endpoint too, but Consul 1.7.2 introduced
`txn_max_req_len` which is the preferred way to set the limit for the
txn endpoint. If both limits are set, the higher one takes precedence.
* <a name="txn_max_req_len"></a><a href="#txn_max_req_len">
`txn_max_req_len`</a> - Configures the maximum number of
`txn_max_req_len`</a> - **(Advanced)** Configures the maximum number of
bytes for a transaction request body to the [`/v1/txn`](/api/txn.html)
endpoint. This limit defaults to [raft's](https://github.com/hashicorp/raft)
suggested max size. **Note that increasing beyond this default can
cause Consul to fail in unexpected ways**, it may potentially affect
suggested max size(512KB). **Note that tuning these improperly can cause
Consul to fail in unexpected ways**, it may potentially affect
leadership stability and prevent timely heartbeat signals by
increasing RPC IO duration.
Expand Down

0 comments on commit 215b57f

Please sign in to comment.