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.

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

Transport configuration not documented #1467

Open
eikenb opened this issue May 5, 2021 · 1 comment
Open

Transport configuration not documented #1467

eikenb opened this issue May 5, 2021 · 1 comment
Labels
Milestone

Comments

@eikenb
Copy link
Contributor

eikenb commented May 5, 2021

Both Vault and Consul blocks support a transport block with various settings..

type TransportConfig struct {
// DialKeepAlive is the amount of time for keep-alives.
DialKeepAlive *time.Duration `mapstructure:"dial_keep_alive"`
// DialTimeout is the amount of time to wait to establish a connection.
DialTimeout *time.Duration `mapstructure:"dial_timeout"`
// DisableKeepAlives determines if keep-alives should be used. Disabling this
// significantly decreases performance.
DisableKeepAlives *bool `mapstructure:"disable_keep_alives"`
// IdleConnTimeout is the timeout for idle connections.
IdleConnTimeout *time.Duration `mapstructure:"idle_conn_timeout"`
// MaxIdleConns is the maximum number of total idle connections.
MaxIdleConns *int `mapstructure:"max_idle_conns"`
// MaxIdleConnsPerHost is the maximum number of idle connections per remote
// host.
MaxIdleConnsPerHost *int `mapstructure:"max_idle_conns_per_host"`
// TLSHandshakeTimeout is the amount of time to wait to complete the TLS
// handshake.
TLSHandshakeTimeout *time.Duration `mapstructure:"tls_handshake_timeout"`
}

Need to add config documentation for these.

@eikenb eikenb added the docs label May 5, 2021
@eikenb
Copy link
Contributor Author

eikenb commented Oct 14, 2021

Be sure to get the changes from #1520 in these docs.

@eikenb eikenb added this to the Documentation milestone Oct 14, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant