-
Notifications
You must be signed in to change notification settings - Fork 112
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
f59f0ac
commit 39901aa
Showing
1 changed file
with
199 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,199 @@ | ||
| --- | ||
| # generated by https://github.com/hashicorp/terraform-plugin-docs | ||
| page_title: "consul_config_entry_service_defaults Resource - terraform-provider-consul" | ||
| subcategory: "" | ||
| description: |- | ||
| The consul_config_entry_service_defaults resource configures a service defaults https://developer.hashicorp.com/consul/docs/connect/config-entries/service-defaults that contains common configuration settings for service mesh services, such as upstreams and gateways. | ||
| --- | ||
|
|
||
| # consul_config_entry_service_defaults (Resource) | ||
|
|
||
| The `consul_config_entry_service_defaults` resource configures a [service defaults](https://developer.hashicorp.com/consul/docs/connect/config-entries/service-defaults) that contains common configuration settings for service mesh services, such as upstreams and gateways. | ||
|
|
||
|
|
||
|
|
||
| <!-- schema generated by tfplugindocs --> | ||
| ## Schema | ||
|
|
||
| ### Required | ||
|
|
||
| - `expose` (Block Set, Min: 1) Specifies default configurations for exposing HTTP paths through Envoy. (see [below for nested schema](#nestedblock--expose)) | ||
| - `name` (String) Specifies the name of the service you are setting the defaults for. | ||
| - `protocol` (String) Specifies the default protocol for the service. | ||
|
|
||
| ### Optional | ||
|
|
||
| - `balance_inbound_connections` (String) Specifies the strategy for allocating inbound connections to the service across Envoy proxy threads. | ||
| - `destination` (Block Set) Configures the destination for service traffic through terminating gateways. (see [below for nested schema](#nestedblock--destination)) | ||
| - `envoy_extensions` (Block List) List of extensions to modify Envoy proxy configuration. (see [below for nested schema](#nestedblock--envoy_extensions)) | ||
| - `external_sni` (String) Specifies the TLS server name indication (SNI) when federating with an external system. | ||
| - `local_connect_timeout_ms` (Number) Specifies the number of milliseconds allowed for establishing connections to the local application instance before timing out. | ||
| - `local_request_timeout_ms` (Number) Specifies the timeout for HTTP requests to the local application instance. | ||
| - `max_inbound_connections` (Number) Specifies the maximum number of concurrent inbound connections to each service instance. | ||
| - `mesh_gateway` (Block Set) Specifies the default mesh gateway mode field for the service. (see [below for nested schema](#nestedblock--mesh_gateway)) | ||
| - `meta` (Map of String) Specifies a set of custom key-value pairs to add to the Consul KV store. | ||
| - `mode` (String) Specifies a mode for how the service directs inbound and outbound traffic. | ||
| - `mutual_tls_mode` (String) Controls whether mutual TLS is required for incoming connections to this service. This setting is only supported for services with transparent proxy enabled. | ||
| - `namespace` (String) Specifies the Consul namespace that the configuration entry applies to. | ||
| - `partition` (String) Specifies the name of the name of the Consul admin partition that the configuration entry applies to. Refer to Admin Partitions for additional information. | ||
| - `transparent_proxy` (Block Set) Controls configurations specific to proxies in transparent mode. Refer to Transparent Proxy Mode for additional information. (see [below for nested schema](#nestedblock--transparent_proxy)) | ||
| - `upstream_config` (Block Set) Controls default upstream connection settings and custom overrides for individual upstream services. (see [below for nested schema](#nestedblock--upstream_config)) | ||
|
|
||
| ### Read-Only | ||
|
|
||
| - `id` (String) The ID of this resource. | ||
|
|
||
| <a id="nestedblock--expose"></a> | ||
| ### Nested Schema for `expose` | ||
|
|
||
| Optional: | ||
|
|
||
| - `checks` (Boolean) | ||
| - `paths` (Block List) (see [below for nested schema](#nestedblock--expose--paths)) | ||
|
|
||
| <a id="nestedblock--expose--paths"></a> | ||
| ### Nested Schema for `expose.paths` | ||
|
|
||
| Optional: | ||
|
|
||
| - `listener_port` (Number) | ||
| - `local_path_port` (Number) | ||
| - `path` (String) | ||
| - `protocol` (String) | ||
|
|
||
|
|
||
|
|
||
| <a id="nestedblock--destination"></a> | ||
| ### Nested Schema for `destination` | ||
|
|
||
| Required: | ||
|
|
||
| - `addresses` (List of String) | ||
| - `port` (Number) | ||
|
|
||
|
|
||
| <a id="nestedblock--envoy_extensions"></a> | ||
| ### Nested Schema for `envoy_extensions` | ||
|
|
||
| Optional: | ||
|
|
||
| - `arguments` (Map of String) | ||
| - `consul_version` (String) | ||
| - `envoy_version` (String) | ||
| - `name` (String) | ||
| - `required` (Boolean) | ||
|
|
||
|
|
||
| <a id="nestedblock--mesh_gateway"></a> | ||
| ### Nested Schema for `mesh_gateway` | ||
|
|
||
| Required: | ||
|
|
||
| - `mode` (String) | ||
|
|
||
|
|
||
| <a id="nestedblock--transparent_proxy"></a> | ||
| ### Nested Schema for `transparent_proxy` | ||
|
|
||
| Required: | ||
|
|
||
| - `dialed_directly` (Boolean) | ||
| - `outbound_listener_port` (Number) | ||
|
|
||
|
|
||
| <a id="nestedblock--upstream_config"></a> | ||
| ### Nested Schema for `upstream_config` | ||
|
|
||
| Optional: | ||
|
|
||
| - `defaults` (Block Set) Specifies configurations that set default upstream settings. For information about overriding the default configurations for in for individual upstreams, refer to UpstreamConfig.Overrides. (see [below for nested schema](#nestedblock--upstream_config--defaults)) | ||
| - `overrides` (Block List) Specifies options that override the default upstream configurations for individual upstreams. (see [below for nested schema](#nestedblock--upstream_config--overrides)) | ||
|
|
||
| <a id="nestedblock--upstream_config--defaults"></a> | ||
| ### Nested Schema for `upstream_config.defaults` | ||
|
|
||
| Optional: | ||
|
|
||
| - `balance_outbound_connections` (String) Sets the strategy for allocating outbound connections from upstreams across Envoy proxy threads. | ||
| - `connect_timeout_ms` (Number) | ||
| - `limits` (Block Set) Map that specifies a set of limits to apply to when connecting upstream services. (see [below for nested schema](#nestedblock--upstream_config--defaults--limits)) | ||
| - `mesh_gateway` (Block Set) Specifies the default mesh gateway mode field for all upstreams. (see [below for nested schema](#nestedblock--upstream_config--defaults--mesh_gateway)) | ||
| - `passive_health_check` (Block Set) Map that specifies a set of rules that enable Consul to remove hosts from the upstream cluster that are unreachable or that return errors. (see [below for nested schema](#nestedblock--upstream_config--defaults--passive_health_check)) | ||
| - `protocol` (String) Specifies the default protocol for the service. | ||
|
|
||
| <a id="nestedblock--upstream_config--defaults--limits"></a> | ||
| ### Nested Schema for `upstream_config.defaults.limits` | ||
|
|
||
| Optional: | ||
|
|
||
| - `max_concurrent_requests` (Number) Specifies the maximum number of concurrent requests. | ||
| - `max_connections` (Number) Specifies the maximum number of connections a service instance can establish against the upstream. | ||
| - `max_pending_requests` (Number) Specifies the maximum number of requests that are queued while waiting for a connection to establish. | ||
|
|
||
|
|
||
| <a id="nestedblock--upstream_config--defaults--mesh_gateway"></a> | ||
| ### Nested Schema for `upstream_config.defaults.mesh_gateway` | ||
|
|
||
| Optional: | ||
|
|
||
| - `mode` (String) | ||
|
|
||
|
|
||
| <a id="nestedblock--upstream_config--defaults--passive_health_check"></a> | ||
| ### Nested Schema for `upstream_config.defaults.passive_health_check` | ||
|
|
||
| Optional: | ||
|
|
||
| - `base_ejection_time` (String) Specifies the minimum amount of time that an ejected host must remain outside the cluster before rejoining. | ||
| - `enforcing_consecutive_5xx` (Number) Specifies a percentage that indicates how many times out of 100 that Consul ejects the host when it detects an outlier status. | ||
| - `interval` (String) Specifies the time between checks. | ||
| - `max_ejection_percent` (Number) Specifies the maximum percentage of an upstream cluster that Consul ejects when the proxy reports an outlier. | ||
| - `max_failures` (Number) Specifies the number of consecutive failures allowed per check interval. If exceeded, Consul removes the host from the load balancer. | ||
|
|
||
|
|
||
|
|
||
| <a id="nestedblock--upstream_config--overrides"></a> | ||
| ### Nested Schema for `upstream_config.overrides` | ||
|
|
||
| Optional: | ||
|
|
||
| - `balance_outbound_connections` (String) Sets the strategy for allocating outbound connections from upstreams across Envoy proxy threads. | ||
| - `connect_timeout_ms` (Number) | ||
| - `envoy_listener_json` (String) | ||
| - `limits` (Block Set) Map that specifies a set of limits to apply to when connecting upstream services. (see [below for nested schema](#nestedblock--upstream_config--overrides--limits)) | ||
| - `mesh_gateway` (Block Set) Specifies the default mesh gateway mode field for all upstreams. (see [below for nested schema](#nestedblock--upstream_config--overrides--mesh_gateway)) | ||
| - `name` (String) Specifies the name of the service you are setting the defaults for. | ||
| - `namespace` (String) Specifies the namespace containing the upstream service that the configuration applies to. | ||
| - `partition` (String) Specifies the name of the name of the Consul admin partition that the configuration entry applies to. | ||
| - `passive_health_check` (Block Set) Map that specifies a set of rules that enable Consul to remove hosts from the upstream cluster that are unreachable or that return errors. (see [below for nested schema](#nestedblock--upstream_config--overrides--passive_health_check)) | ||
| - `peer` (String) Specifies the peer name of the upstream service that the configuration applies to. | ||
| - `protocol` (String) Specifies the default protocol for the service. | ||
|
|
||
| <a id="nestedblock--upstream_config--overrides--limits"></a> | ||
| ### Nested Schema for `upstream_config.overrides.limits` | ||
|
|
||
| Optional: | ||
|
|
||
| - `max_concurrent_requests` (Number) Specifies the maximum number of concurrent requests. | ||
| - `max_connections` (Number) Specifies the maximum number of connections a service instance can establish against the upstream. | ||
| - `max_pending_requests` (Number) Specifies the maximum number of requests that are queued while waiting for a connection to establish. | ||
|
|
||
|
|
||
| <a id="nestedblock--upstream_config--overrides--mesh_gateway"></a> | ||
| ### Nested Schema for `upstream_config.overrides.mesh_gateway` | ||
|
|
||
| Optional: | ||
|
|
||
| - `mode` (String) | ||
|
|
||
|
|
||
| <a id="nestedblock--upstream_config--overrides--passive_health_check"></a> | ||
| ### Nested Schema for `upstream_config.overrides.passive_health_check` | ||
|
|
||
| Optional: | ||
|
|
||
| - `base_ejection_time` (String) Specifies the minimum amount of time that an ejected host must remain outside the cluster before rejoining. | ||
| - `enforcing_consecutive_5xx` (Number) Specifies a percentage that indicates how many times out of 100 that Consul ejects the host when it detects an outlier status. | ||
| - `interval` (String) Specifies the time between checks. | ||
| - `max_ejection_percent` (Number) Specifies the maximum percentage of an upstream cluster that Consul ejects when the proxy reports an outlier. | ||
| - `max_failures` (Number) Specifies the number of consecutive failures allowed per check interval. If exceeded, Consul removes the host from the load balancer. |