You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: website/content/docs/connect/config-entries/proxy-defaults.mdx
+19-19Lines changed: 19 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -330,7 +330,7 @@ Specifies an arbitrary map of configuration values used by service mesh proxies.
330
330
#### Values
331
331
332
332
- Default: None
333
-
- Data type: Map of
333
+
- Data type: Map
334
334
335
335
### `EnvoyExtensions`
336
336
@@ -339,7 +339,7 @@ Specifies a list of extensions that modify Envoy proxy configurations. Refer to
339
339
#### Values
340
340
341
341
- Default: None
342
-
- Data type: Map of containing the following fields:
342
+
- Data type: List of maps containing the following fields:
343
343
-`Name`
344
344
-`Required`
345
345
-`Arguments`
@@ -371,7 +371,7 @@ Specifies a mode for how proxies direct inbound and outbound traffic. You can sp
371
371
372
372
### `TransparentProxy`
373
373
374
-
Contains configurations for proxies that are running in transparent proxy mode. Refer to [Transparent proxy mode](/consul/docs/k8s/connect/transparent-proxy) for additional information.
374
+
Contains configurations for proxies that are running in transparent proxy mode. This mode enables permissive mTLS for Consul so that you can use your Kubernetes cluster's DNS service instead of Consul DNS. Refer to [Transparent proxy mode](/consul/docs/k8s/connect/transparent-proxy) for additional information.
375
375
376
376
#### Values
377
377
@@ -384,8 +384,8 @@ The following table describes how to configure values in the `TransparentProxy`
384
384
385
385
| Parameter | Description | Data type | Default |
386
386
| --- | --- | --- | --- |
387
-
|`OutboundListenerPort`| Specifies the port that the proxy listens on for outbound traffic. Outbound application traffic must be captured and redirected to this port. | Integer |`15001`|
388
-
|`DialedDirectly`| Determines whether other proxies in transparent mode can directly dial this proxy instance's IP address. Proxies in transparent mode commonly dial upstreams at the [`virtual`](/consul/docs/services/configuration/services-configuration-reference#tagged_addresses-virtual) tagged address, which load balances across instances. Dialing individual instances can be helpful when sending requests to stateful services, such as database clusters with a leader. | Boolean |`false`|
387
+
|`OutboundListenerPort`| Specifies the port that the proxy listens on for outbound traffic. Outbound application traffic must be captured and redirected to this port. | Integer |`15001`|
388
+
|`DialedDirectly`| Determines whether other proxies in transparent mode can directly dial this proxy instance's IP address. Proxies in transparent mode commonly dial upstreams at the [`virtual` tagged address](/consul/docs/services/configuration/services-configuration-reference#tagged_addresses-virtual), which load balances across instances. Dialing individual instances can be helpful when sending requests to stateful services, such as database clusters with a leader. | Boolean |`false`|
389
389
390
390
### `MutualTLSMode`
391
391
@@ -431,14 +431,14 @@ Example use-cases include exposing the `/metrics` endpoint to a monitoring syste
431
431
432
432
### `Expose{}.Checks`
433
433
434
-
Exposes all HTTP and gRPC checks registered with the agent when set to `true`. Envoy exposes listeners for the checks and only accepts connections originating from localhost or Consul's [`advertise_addr`](/consul/docs/agent/config/config-files#advertise). The ports for the listeners are dynamically allocated from the agent's [`expose_min_port`](/consul/docs/agent/config/config-files#expose_min_port) and [`expose_max_port`](/consul/docs/agent/config/config-files#expose_max_port) configurations.
434
+
Exposes all HTTP and gRPC checks registered with the agent when set to `true`. Envoy exposes listeners for the checks and only accepts connections originating from localhost or the [Consul agent's `advertise_addr`](/consul/docs/agent/config/config-files#advertise). The ports for the listeners are dynamically allocated from the [agent's `expose_min_port`](/consul/docs/agent/config/config-files#expose_min_port) and [`expose_max_port`](/consul/docs/agent/config/config-files#expose_max_port) configurations.
435
435
436
-
We recommend enabling the `Checks` configuration when a Consul client cannot reach registered services over localhost, such as when Consul agents run in their own pods in Kubernetes.
436
+
We recommend enabling the `Checks` configuration when a Consul client cannot reach registered services over localhost.
437
437
438
438
#### Values
439
439
440
440
- Default: `false`
441
-
- Data type: boolean
441
+
- Data type: Boolean
442
442
443
443
### `Expose{}.Paths[]`
444
444
@@ -447,7 +447,7 @@ Specifies a list of configuration maps that define paths to expose through Envoy
447
447
#### Values
448
448
449
449
- Default: None
450
-
- Data type: List of maps.
450
+
- Data type: List of maps
451
451
452
452
The following table describes the parameters for each map you can define in the list:
453
453
@@ -571,7 +571,7 @@ Specifies a list of extensions that modify Envoy proxy configurations. Refer to
571
571
#### Values
572
572
573
573
- Default: None
574
-
- Data type: Map of containing the following fields:
574
+
- Data type: List of maps of containing the following fields:
575
575
-`name`
576
576
-`required`
577
577
-`arguments`
@@ -603,7 +603,7 @@ Specifies a mode for how proxies direct inbound and outbound traffic. You can sp
603
603
604
604
### `spec.transparentProxy`
605
605
606
-
Contains configurations for proxies that are running in transparent proxy mode. Refer to [Transparent proxy mode](/consul/docs/k8s/connect/transparent-proxy) for additional information.
606
+
Contains configurations for proxies that are running in transparent proxy mode. This mode enables permissive mTLS for Consul so that you can use your Kubernetes cluster's DNS service instead of Consul DNS. Refer to [Transparent proxy mode](/consul/docs/k8s/connect/transparent-proxy) for additional information.
607
607
608
608
#### Values
609
609
@@ -616,8 +616,8 @@ The following table describes how to configure values in the `TransparentProxy`
616
616
617
617
| Parameter | Description | Data type | Default |
618
618
| --- | --- | --- | --- |
619
-
|`outboundListenerPort`| Specifies the port that the proxy listens on for outbound traffic. Outbound application traffic must be captured and redirected to this port. | Integer |`15001`|
620
-
|`dialedDirectly`| Determines whether other proxies in transparent mode can directly dial this proxy instance's IP address. Proxies in transparent mode commonly dial upstreams at the [`virtual`](/consul/docs/services/configuration/services-configuration-reference#tagged_addresses-virtual) tagged address, which load balances across instances. Dialing individual instances can be helpful when sending requests to stateful services, such as database clusters with a leader. | Boolean |`false`|
619
+
|`outboundListenerPort`| Specifies the port that the proxy listens on for outbound traffic. Outbound application traffic must be captured and redirected to this port. | Integer |`15001`|
620
+
|`dialedDirectly`| Determines whether other proxies in transparent mode can directly dial this proxy instance's IP address. Proxies in transparent mode commonly dial upstreams at the [`virtual` tagged address](/consul/docs/services/configuration/services-configuration-reference#tagged_addresses-virtual), which load balances across instances. Dialing individual instances can be helpful when sending requests to stateful services, such as database clusters with a leader. | Boolean |`false`|
621
621
622
622
### `spec.mutualTLSMode`
623
623
@@ -663,14 +663,14 @@ Example use-cases include exposing the `/metrics` endpoint to a monitoring syste
663
663
664
664
### `spec.expose{}.checks`
665
665
666
-
Exposes all HTTP and gRPC checks registered with the agent when set to `true`. Envoy exposes listeners for the checks and only accepts connections originating from localhost or Consul's [`advertise_addr`](/consul/docs/agent/config/config-files#advertise). The ports for the listeners are dynamically allocated from the agent's [`expose_min_port`](/consul/docs/agent/config/config-files#expose_min_port) and [`expose_max_port`](/consul/docs/agent/config/config-files#expose_max_port) configurations.
666
+
Exposes all HTTP and gRPC checks registered with the agent when set to `true`. Envoy exposes listeners for the checks and only accepts connections originating from localhost or the [Consul agent's `advertise_addr`](/consul/docs/agent/config/config-files#advertise). The ports for the listeners are dynamically allocated from the [agent's `expose_min_port`](/consul/docs/agent/config/config-files#expose_min_port) and [`expose_max_port`](/consul/docs/agent/config/config-files#expose_max_port) configurations.
667
667
668
668
We recommend enabling the `Checks` configuration when a Consul client cannot reach registered services over localhost, such as when Consul agents run in their own pods in Kubernetes.
669
669
670
670
#### Values
671
671
672
672
- Default: `false`
673
-
- Data type: boolean
673
+
- Data type: Boolean
674
674
675
675
### `spec.expose{}.paths[]`
676
676
@@ -752,7 +752,7 @@ Config {
752
752
753
753
#### Consul Enterprise
754
754
755
-
For Consul Enterprise, you can only create the configuration entry in the `default` namespace. The namepace configuration applies to proxies in all namespaces.
755
+
When using multiple namespaces with Consul Enterprise, the only configuration entry that affects proxy defaults is the one in the `default` namespace. This configuration applies to proxies in all namespaces.
756
756
757
757
```hcl
758
758
Kind = "proxy-defaults"
@@ -780,7 +780,7 @@ spec:
780
780
781
781
#### Consul Enterprise
782
782
783
-
For Consul Enterprise, you can only create the configuration entry in the `default` namespace. The namepace configuration applies to proxies in all namespaces.
783
+
When using multiple namespaces with Consul Enterprise, the only configuration entry that affects proxy defaults is the one in the `default` namespace. This configuration applies to proxies in all namespaces.
784
784
785
785
```yaml
786
786
apiVersion: consul.hashicorp.com/v1alpha1
@@ -810,7 +810,7 @@ spec:
810
810
```
811
811
#### Consul Enterprise
812
812
813
-
For Consul Enterprise, you can only create the configuration entry in the `default` namespace. The namepace configuration applies to proxies in all namespaces.
813
+
When using multiple namespaces with Consul Enterprise, the only configuration entry that affects proxy defaults is the one in the `default` namespace. This configuration applies to proxies in all namespaces.
814
814
815
815
```json
816
816
{
@@ -877,7 +877,7 @@ spec:
877
877
878
878
### Access Logs
879
879
880
-
The following example enables access logs for all proxies. efer to [access logs](/consul/docs/connect/observability/access-logs) for more detailed examples.
880
+
The following example enables access logs for all proxies. Refer to [access logs](/consul/docs/connect/observability/access-logs) for more detailed examples.
Copy file name to clipboardExpand all lines: website/content/docs/connect/config-entries/service-defaults.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -778,7 +778,7 @@ Specifies the TLS server name indication (SNI) when federating with an external
778
778
779
779
### `Expose`
780
780
781
-
Specifies default configurations for exposing HTTP paths through Envoy. Exposing paths through Envoy enables services to listen on localhost only. Applications that are not Consul service mesh-enabled can still contact an HTTP endpoint. Refer to [Expose Paths Configuration Reference](/consul/docs/proxies/proxy-config-reference#expose-paths-configuration-reference) for additional information and example configurations.
781
+
Specifies default configurations for exposing HTTP paths through Envoy. Exposing paths through Envoy enables services to listen on `localhost` only. Applications that are not Consul service mesh-enabled can still contact an HTTP endpoint. Refer to [Expose Paths Configuration Reference](/consul/docs/proxies/proxy-config-reference#expose-paths-configuration-reference) for additional information and example configurations.
782
782
783
783
- Default: none
784
784
- Data type: map
@@ -1198,7 +1198,7 @@ Specifies the TLS server name indication (SNI) when federating with an external
1198
1198
1199
1199
### `spec.expose`
1200
1200
1201
-
Specifies default configurations for exposing HTTP paths through Envoy. Exposing paths through Envoy enables services to listen on localhost only. Applications that are not Consul service mesh-enabled can still contact an HTTP endpoint. Refer to [Expose Paths Configuration Reference](/consul/docs/connect/proxies/proxy-config-reference#expose-paths-configuration-reference) for additional information and example configurations.
1201
+
Specifies default configurations for exposing HTTP paths through Envoy. Exposing paths through Envoy enables services to listen on `localhost` only. Applications that are not Consul service mesh-enabled can still contact an HTTP endpoint. Refer to [Expose Paths Configuration Reference](/consul/docs/connect/proxies/proxy-config-reference#expose-paths-configuration-reference) for additional information and example configurations.
Copy file name to clipboardExpand all lines: website/content/docs/connect/proxies/deploy-service-mesh-proxies.mdx
+8-6Lines changed: 8 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,9 @@ description: >-
7
7
8
8
# Deploy service mesh proxies services
9
9
10
-
This topic describes how to create, register, and start service mesh proxies in Consul. Refer to [Service mesh proxies overview](/consul/docs/connect/proxies) for additional information about how proxies enable Consul functionalities. For information about deployed sidecar proxies, refer to [Deploy sidecar proxy services](/consul/docs/connect/proxies/deploy-sidecar-services).
10
+
This topic describes how to create, register, and start service mesh proxies in Consul. Refer to [Service mesh proxies overview](/consul/docs/connect/proxies) for additional information about how proxies enable Consul functionalities.
11
+
12
+
For information about deploying proxies as sidecars for service instances, refer to [Deploy sidecar proxy services](/consul/docs/connect/proxies/deploy-sidecar-services).
11
13
12
14
## Overview
13
15
@@ -16,21 +18,21 @@ Complete the following steps to deploy a service mesh proxy:
16
18
1. It is not required, but you can create a proxy defaults configuration entry that contains global passthrough settings for all Envoy proxies.
17
19
1. Create a service definition file and specify the proxy configurations in the `proxy` block.
18
20
1. Register the service using the API or CLI.
19
-
1. Start the proxy service.
21
+
1. Start the proxy service. Proxies appear in the list of services registered to Consul, but they must be started before they begin to route traffic in your service mesh.
20
22
21
23
## Requirements
22
24
23
-
If [ACLs](/consul/docs/security/acl) are enabled and you want to configure global Envoy settings in the [proxy defaults configuration entry](/consul/docs/connect/config-entries/proxy-defaults), you must present a token with `operator:write` permissions. Refer to [Create a service token](/consul/docs/security/acl/tokens/create/create-a-service-token) for additional information.
25
+
If ACLs are enabled and you want to configure global Envoy settings using the [proxy defaults configuration entry](/consul/docs/connect/config-entries/proxy-defaults), you must present a token with `operator:write` permissions. Refer to [Create a service token](/consul/docs/security/acl/tokens/create/create-a-service-token) for additional information.
24
26
25
27
## Configure global Envoy passthrough settings
26
28
27
-
If you want to define global passthrough settings for all Envoy proxies, create a proxy defaults configuration entry and specify default settings, such as access log configuration. [Service defaults configuration entries](/consul/docs/connect/config-entries/service-defaults) override proxy defaults and individual service configurations override both configuration entries.
29
+
If you want to define global passthrough settings for all Envoy proxies, create a proxy defaults configuration entry and specify default settings, such as access log configuration. Note that [service defaults configuration entries](/consul/docs/connect/config-entries/service-defaults) override proxy defaults and individual service configurations override both configuration entries.
28
30
29
31
1. Create a proxy defaults configuration entry and specify the following parameters:
30
32
-`Kind`: Must be set to `proxy-defaults`
31
33
-`Name`: Must be set to `global`
32
34
1. Configure any additional settings you want to apply to all proxies. Refer to [Proxy defaults configuration entry reference](/consul/docs/connect/config-entries/proxy-defaults) for details about all settings available in the configuraiton entry.
33
-
1. Apply the configuration by either calling the [`/config` API endpoint](/consul/api-docs/config) or running the [`consul config write` CLI command](/consul/commands/config/write). The following example writes a proxy defaults configuration entry from a local HCL file using the CLI:
35
+
1. Apply the configuration by either calling the [`/config`HTTP API endpoint](/consul/api-docs/config) or running the [`consul config write` CLI command](/consul/commands/config/write). The following example writes a proxy defaults configuration entry from a local HCL file using the CLI:
34
36
35
37
```shell-session
36
38
$ consul config write proxy-defaults.hcl
@@ -48,7 +50,7 @@ Create a service definition file and configure the following fields to define a
48
50
49
51
Refer to the [Service mesh proxy configuration reference](/consul/docs/connect/proxies/proxy-config-reference) for example configurations.
50
52
51
-
## Register the service
53
+
## Register the service
52
54
53
55
Provide the service definition to the Consul agent to register your proxy service. You can use the same methods for registering proxy services as you do for registering application services:
0 commit comments