Skip to content
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.

Sign up for GitHub

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

Expose etcd client MaxCallSendMsgSize config #28078

Merged
merged 3 commits into from
Jul 20, 2021
Merged

Expose etcd client MaxCallSendMsgSize config #28078

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d1608d7
Expose etcd client MaxCallSendMsgSize config
jasons42 Mar 12, 2021
162f853
Document max_request_bytes config
jasons42 Mar 13, 2021
5ff9b76
Fix broken link
jasons42 Mar 14, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions internal/backend/remote-state/etcdv3/backend.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ const (
usernameEnvVarName = "ETCDV3_USERNAME"
passwordKey = "password"
passwordEnvVarName = "ETCDV3_PASSWORD"
maxRequestBytesKey = "max_request_bytes"
prefixKey = "prefix"
lockKey = "lock"
cacertPathKey = "cacert_path"
Expand Down Expand Up @@ -49,6 +50,13 @@ func New() backend.Backend {
DefaultFunc: schema.EnvDefaultFunc(passwordEnvVarName, ""),
},

maxRequestBytesKey: &schema.Schema{
Type: schema.TypeInt,
Optional: true,
Description: "The max request size to send to etcd.",
Default: 0,
},

prefixKey: &schema.Schema{
Type: schema.TypeString,
Optional: true,
Expand Down Expand Up @@ -128,6 +136,9 @@ func (b *Backend) rawClient() (*etcdv3.Client, error) {
if v, ok := b.data.GetOk(passwordKey); ok && v.(string) != "" {
config.Password = v.(string)
}
if v, ok := b.data.GetOk(maxRequestBytesKey); ok && v.(int) != 0 {
config.MaxCallSendMsgSize = v.(int)
}
if v, ok := b.data.GetOk(cacertPathKey); ok && v.(string) != "" {
tlsInfo.TrustedCAFile = v.(string)
}
Expand Down
3 changes: 2 additions & 1 deletion website/docs/language/settings/backends/etcdv3.html.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ description: |-

**Kind: Standard (with locking)**

Stores the state in the [etcd](https://coreos.com/etcd/) KV store with a given prefix.
Stores the state in the [etcd](https://etcd.io/) KV store with a given prefix.

This backend supports [state locking](/docs/language/state/locking.html).

Expand Down Expand Up @@ -54,3 +54,4 @@ The following configuration options / environment variables are supported:
* `cacert_path` - (Optional) The path to a PEM-encoded CA bundle with which to verify certificates of TLS-enabled etcd servers.
* `cert_path` - (Optional) The path to a PEM-encoded certificate to provide to etcd for secure client identification.
* `key_path` - (Optional) The path to a PEM-encoded key to provide to etcd for secure client identification.
* `max_request_bytes` - (Optional) The max request size to send to etcd. This can be increased to enable storage of larger state. You must set the corresponding server-side flag [--max-request-bytes](https://etcd.io/docs/current/dev-guide/limit/#request-size-limit) as well and the value should be less than the client setting. Defaults to `2097152` (2.0 MiB). **Please Note:** Increasing etcd's request size limit may negatively impact overall latency.