/docs/connect/config-entries

This commit is contained in:
boruszak 2022-09-13 16:04:13 -05:00
parent 38fd65bb2c
commit 2b69d809ce
11 changed files with 33 additions and 51 deletions

View File

@ -1,12 +1,11 @@
--- ---
layout: docs layout: docs
page_title: 'Configuration Entry Kind: Exported Services' page_title: Exported Services: Configuration Entry Reference
description: >- description: >-
The exported-services configuration entry enables you to export services from a single file. The exported services configuration entry kind defines service availability across admin partitions and cluster peerings. Use the reference guide to learn about `""exported-services""` config entry parameters and exporting services to other datacenters.
Settings in this configuration entry can apply to services in any namespace of the specified partition. Write access to the mesh resource is required.
--- ---
# Exported Services # Exported Services Configuration Entry
This topic describes the `exported-services` configuration entry type. The `exported-services` configuration entry enables Consul to export service instances to other clusters from a single file and connect services across clusters. For additional information, refer to [Cluster Peering](/docs/connect/cluster-peering) and [Admin Partitions](/docs/enterprise/admin-partitions). This topic describes the `exported-services` configuration entry type. The `exported-services` configuration entry enables Consul to export service instances to other clusters from a single file and connect services across clusters. For additional information, refer to [Cluster Peering](/docs/connect/cluster-peering) and [Admin Partitions](/docs/enterprise/admin-partitions).

View File

@ -1,12 +1,11 @@
--- ---
layout: docs layout: docs
page_title: Configuration Entry Definitions page_title: Configuration Entry Overview
description: >- description: >-
Consul allows storing configuration entries centrally to be used as defaults Configuration entries define global proxy behaviors in the service mesh in order to secure and manage traffic. Learn about Consuls different config entry kind and get links to configuration reference pages.
for configuring other aspects of Consul.
--- ---
# Configuration Entries # Configuration Entry Overview
Configuration entries can be used to configure the behavior of Consul Connect. Configuration entries can be used to configure the behavior of Consul Connect.

View File

@ -1,12 +1,11 @@
--- ---
layout: docs layout: docs
page_title: 'Configuration Entry Kind: Ingress Gateway' page_title: Ingress Gateway: Configuration Entry Reference
description: >- description: >-
The `ingress-gateway` config entry kind allows for configuring Ingress gateways The ingress gateway configuration entry kind defines proxy behavior to secure incoming communication between the service mesh and external sources. Use the reference guide to learn about `""ingress-gateway""` config entry parameters and exposing TCP and HTTP listeners.
with listeners that expose a set of services outside the Consul service mesh.
--- ---
# Ingress Gateway # Ingress Gateway Configuration Entry
This topic provides reference information for the `ingress-gateway` configuration entry. This topic provides reference information for the `ingress-gateway` configuration entry.

View File

@ -1,14 +1,11 @@
--- ---
layout: docs layout: docs
page_title: 'Configuration Entry Kind: Mesh' page_title: Mesh: Configuration Entry Reference
description: >- description: >-
The mesh config entry kind allows for globally defining default The mesh configuration entry kind defines global default settings like TLS version requirements for proxies inside the service mesh. Use the reference guide to learn about `""mesh`"" config entry parameters and how to prevent transparent proxies from communicating with services outside of the mesh.
configuration across all services mesh proxies.
Settings in this config entry apply across all namespaces and federated datacenters.
Currently, only one mesh entry is supported.
--- ---
# Mesh # Mesh Configuration Entry
-> **v1.10.0+:** This configuration entry is supported in Consul versions 1.10.0+. -> **v1.10.0+:** This configuration entry is supported in Consul versions 1.10.0+.

View File

@ -1,14 +1,11 @@
--- ---
layout: docs layout: docs
page_title: 'Configuration Entry Kind: Proxy Defaults' page_title: Proxy Defaults: Configuration Entry Reference
description: >- description: >-
The proxy-defaults config entry kind allows for configuring global config The proxy defaults configuration entry kind defines default behaviors for sidecar proxies in the service mesh. Use the reference guide to learn about `""proxy-defaults""` config entry parameters and how to expose HTTP paths through Envoy.
defaults across all services for Connect proxy configuration. Currently, only
one global entry is supported.
--- ---
# Proxy Defaults # Proxy Defaults Configuration Entry
The `proxy-defaults` configuration entry (`ProxyDefaults` on Kubernetes) allows you The `proxy-defaults` configuration entry (`ProxyDefaults` on Kubernetes) allows you
to configure global defaults across all services for Connect proxy to configure global defaults across all services for Connect proxy

View File

@ -1,12 +1,11 @@
--- ---
layout: docs layout: docs
page_title: 'Configuration Entry Kind: Service Defaults' page_title: Service Defaults: Configuration Entry Reference
description: >- description: >-
The service-defaults config entry kind controls default global values for a The service intentions configuration entry kind defines sets of communication permissions between service types as intentions. Use the reference guide to learn about `""service-intentions""` config entry parameters and how to authorize L4 and L7 communication in the service mesh with intentions.
service, such as its protocol.
--- ---
# Service Defaults # Service Defaults Configuration Entry
-> **v1.8.4+:** On Kubernetes, the `ServiceDefaults` custom resource is supported in Consul versions 1.8.4+.<br /> -> **v1.8.4+:** On Kubernetes, the `ServiceDefaults` custom resource is supported in Consul versions 1.8.4+.<br />
**v1.5.0+:** On other platforms, this config entry is supported in Consul versions 1.5.0+. **v1.5.0+:** On other platforms, this config entry is supported in Consul versions 1.5.0+.

View File

@ -1,13 +1,11 @@
--- ---
layout: docs layout: docs
page_title: 'Configuration Entry Kind: Service Intentions' page_title: Service Intentions: Configuration Entry Reference
description: >- description: >-
The service-intentions config entry kind controls Connect traffic The service intentions configuration entry kind defines the communication permissions between service types. Use the reference guide to learn about `""service-intentions""` config entry parameters and how to authorize L4 and L7 communication int he service mesh with intentions.
authorization for both networking layer 4 (e.g. TCP) and networking layer 7
(e.g. HTTP).
--- ---
# Service Intentions ((#service-intentions)) # Service Intentions Configuration Entry ((#service-intentions))
-> **1.9.0+:** This config entry is available in Consul versions 1.9.0 and newer. -> **1.9.0+:** This config entry is available in Consul versions 1.9.0 and newer.

View File

@ -1,12 +1,11 @@
--- ---
layout: docs layout: docs
page_title: 'Configuration Entry Kind: Service Resolver' page_title: Service Resolver: Configuration Entry Reference
description: >- description: >-
The `service-resolver` config entry kind controls which service instances The service resolver configuration entry kind defines subsets of service instances that satisfy upstream discovery requests. Use the reference guide to learn about `""service-resolver""` config entry parameters and how filtering by service subsets helps route traffic based on properties like version number.
should satisfy Connect upstream discovery requests for a given service name.
--- ---
# Service Resolver # Service Resolver Configuration Entry
-> **v1.8.4+:** On Kubernetes, the `ServiceResolver` custom resource is supported in Consul versions 1.8.4+.<br /> -> **v1.8.4+:** On Kubernetes, the `ServiceResolver` custom resource is supported in Consul versions 1.8.4+.<br />
**v1.6.0+:** On other platforms, this config entry is supported in Consul versions 1.6.0+. **v1.6.0+:** On other platforms, this config entry is supported in Consul versions 1.6.0+.

View File

@ -1,12 +1,11 @@
--- ---
layout: docs layout: docs
page_title: 'Configuration Entry Kind: Service Router' page_title: Service Router: Configuration Entry Reference
description: >- description: >-
The service-router config entry kind controls Connect traffic routing and The service router configuration entry kind defines where the service mesh sends requests based on L7 network information. Use the reference guide to learn about `""service-router""` config entry parameters and how you can route requests and set up retries based on HTTP paths.
manipulation at networking layer 7 (e.g. HTTP).
--- ---
# Service Router # Service Router Configuration Entry
The `service-router` config entry kind (`ServiceRouter` on Kubernetes) controls Connect traffic routing and The `service-router` config entry kind (`ServiceRouter` on Kubernetes) controls Connect traffic routing and
manipulation at networking layer 7 (e.g. HTTP). manipulation at networking layer 7 (e.g. HTTP).

View File

@ -1,14 +1,11 @@
--- ---
layout: docs layout: docs
page_title: 'Configuration Entry Kind: Service Splitter' page_title: Service Splitter: Configuration Entry Reference
description: >- description: >-
The service-splitter config entry kind controls how to split incoming Connect The service splitter configuration entry kind defines how to divide service mesh traffic between service instances. Use the reference guide to learn about `""service-splitter""` config entry parameters and traffic management for deploying updated services.
requests across different subsets of a single service (like during staged
canary rollouts), or perhaps across different services (like during a v2
rewrite or other type of codebase migration).
--- ---
# Service Splitter # Service Splitter Configuration Entry
-> **v1.8.4+:** On Kubernetes, the `ServiceSplitter` custom resource is supported in Consul versions 1.8.4+.<br /> -> **v1.8.4+:** On Kubernetes, the `ServiceSplitter` custom resource is supported in Consul versions 1.8.4+.<br />
**v1.6.0+:** On other platforms, this config entry is supported in Consul versions 1.6.0+. **v1.6.0+:** On other platforms, this config entry is supported in Consul versions 1.6.0+.

View File

@ -1,12 +1,11 @@
--- ---
layout: docs layout: docs
page_title: 'Configuration Entry Kind: Terminating Gateway' page_title: Terminating Gateway: Configuration Entry Reference
description: >- description: >-
The `terminating-gateway` config entry kind allows for configuring terminating gateways The terminating gateway configuration entry kind defines proxy behavior to secure outgoing communication between the service mesh and external sources. Use the reference guide to learn about `""terminating-gateway""` config entry parameters and connecting service instances without Consul agents to your service mesh.
to proxy traffic from services in the Consul service mesh to services outside the mesh.
--- ---
# Terminating Gateway # Terminating Gateway Configuration Entry
-> **v1.8.4+:** On Kubernetes, the `TerminatingGateway` custom resource is supported in Consul versions 1.8.4+.<br /> -> **v1.8.4+:** On Kubernetes, the `TerminatingGateway` custom resource is supported in Consul versions 1.8.4+.<br />
**v1.8.0+:** On other platforms, this config entry is supported in Consul versions 1.8.0+. **v1.8.0+:** On other platforms, this config entry is supported in Consul versions 1.8.0+.