luxolus
/
open-consul
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity

Merge pull request #9259 from hashicorp/dnephin/doc-streaming-experimental 

docs: mark streaming as experimental
This commit is contained in:
Daniel Nephin 2020-11-23 16:13:40 -05:00 committed by GitHub
parent 8731fa5a97 7d7cffb613
commit b3b07a62ee
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
website/pages/docs/agent/options.mdx
View File

@ -1828,9 +1828,10 @@ Valid time units are 'ns', 'us' (or 'µs'), 'ms', 's', 'm', 'h'."
- `rpc` configuration for Consul servers. - `rpc` configuration for Consul servers.
- `enable_streaming` ((#rpc_enable_streaming)) enables the gRPC subscribe endpoint on a Consul Server. All - `enable_streaming` ((#rpc_enable_streaming)) (experimental) enables the gRPC subscribe endpoint on a Consul Server. All
servers in all federated datacenters must have this enabled before any client can use servers in all federated datacenters must have this enabled before any client can use
[`use_streaming_backend`](#use_streaming_backend). This setting will default to true in a future release of Consul. [`use_streaming_backend`](#use_streaming_backend).
This setting will default to true in a future version of Consul.
- `segment` <EnterpriseAlert inline /> - Equivalent to the [`-segment` command-line flag](#_segment). - `segment` <EnterpriseAlert inline /> - Equivalent to the [`-segment` command-line flag](#_segment).
@ -2204,13 +2205,14 @@ Valid time units are 'ns', 'us' (or 'µs'), 'ms', 's', 'm', 'h'."
currently only supports numeric IDs. currently only supports numeric IDs.
- `mode` - The permission bits to set on the file. - `mode` - The permission bits to set on the file.
- `use_streaming_backend` when enabled Consul client agents will use streaming rpc to - `use_streaming_backend` (experimental) when enabled Consul client agents will use
populate, instead of the traditional blocking queries, for endpoints which support streaming rpc, instead of the traditional blocking queries, for endpoints which support
streaming. All servers must have [`rpc.enable_streaming`](#rpc_enable_streaming) streaming. All servers must have [`rpc.enable_streaming`](#rpc_enable_streaming)
enabled before any client can enable `use_streaming_backend`. enabled before any client can enable `use_streaming_backend`.
At least one of [`dns.use_cache`](#dns_use_cache) or At least one of [`dns.use_cache`](#dns_use_cache) or
[`http_config.use_cache`](#http_config_use_cache) must be enabled, otherwise [`http_config.use_cache`](#http_config_use_cache) must be enabled, otherwise
this setting has no effect. this setting has no effect.
`use_streaming_backend` will default to true in a future version of Consul.
- `verify_incoming` - If set to true, Consul - `verify_incoming` - If set to true, Consul
requires that all incoming connections make use of TLS and that the client requires that all incoming connections make use of TLS and that the client