Skip to content

Commit 5087618

Browse files
Apply suggestions from code review
Co-authored-by: Jeff Boruszak <[email protected]>
1 parent ad97e0d commit 5087618

File tree

5 files changed

+54
-54
lines changed

5 files changed

+54
-54
lines changed

website/content/docs/connect/config-entries/proxy-defaults.mdx

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -330,7 +330,7 @@ Specifies an arbitrary map of configuration values used by service mesh proxies.
330330
#### Values
331331

332332
- Default: None
333-
- Data type: Map of
333+
- Data type: Map
334334

335335
### `EnvoyExtensions`
336336

@@ -339,7 +339,7 @@ Specifies a list of extensions that modify Envoy proxy configurations. Refer to
339339
#### Values
340340

341341
- Default: None
342-
- Data type: Map of containing the following fields:
342+
- Data type: List of maps containing the following fields:
343343
- `Name`
344344
- `Required`
345345
- `Arguments`
@@ -371,7 +371,7 @@ Specifies a mode for how proxies direct inbound and outbound traffic. You can sp
371371

372372
### `TransparentProxy`
373373

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.
375375

376376
#### Values
377377

@@ -384,8 +384,8 @@ The following table describes how to configure values in the `TransparentProxy`
384384

385385
| Parameter | Description | Data type | Default |
386386
| --- | --- | --- | --- |
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` |
389389

390390
### `MutualTLSMode`
391391

@@ -431,14 +431,14 @@ Example use-cases include exposing the `/metrics` endpoint to a monitoring syste
431431

432432
### `Expose{}.Checks`
433433

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.
435435

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.
437437

438438
#### Values
439439

440440
- Default: `false`
441-
- Data type: boolean
441+
- Data type: Boolean
442442

443443
### `Expose{}.Paths[]`
444444

@@ -447,7 +447,7 @@ Specifies a list of configuration maps that define paths to expose through Envoy
447447
#### Values
448448

449449
- Default: None
450-
- Data type: List of maps.
450+
- Data type: List of maps
451451

452452
The following table describes the parameters for each map you can define in the list:
453453

@@ -571,7 +571,7 @@ Specifies a list of extensions that modify Envoy proxy configurations. Refer to
571571
#### Values
572572

573573
- Default: None
574-
- Data type: Map of containing the following fields:
574+
- Data type: List of maps of containing the following fields:
575575
- `name`
576576
- `required`
577577
- `arguments`
@@ -603,7 +603,7 @@ Specifies a mode for how proxies direct inbound and outbound traffic. You can sp
603603

604604
### `spec.transparentProxy`
605605

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.
607607

608608
#### Values
609609

@@ -616,8 +616,8 @@ The following table describes how to configure values in the `TransparentProxy`
616616

617617
| Parameter | Description | Data type | Default |
618618
| --- | --- | --- | --- |
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` |
621621

622622
### `spec.mutualTLSMode`
623623

@@ -663,14 +663,14 @@ Example use-cases include exposing the `/metrics` endpoint to a monitoring syste
663663

664664
### `spec.expose{}.checks`
665665

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.
667667

668668
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.
669669

670670
#### Values
671671

672672
- Default: `false`
673-
- Data type: boolean
673+
- Data type: Boolean
674674

675675
### `spec.expose{}.paths[]`
676676

@@ -752,7 +752,7 @@ Config {
752752

753753
#### Consul Enterprise
754754

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.
756756

757757
```hcl
758758
Kind = "proxy-defaults"
@@ -780,7 +780,7 @@ spec:
780780
781781
#### Consul Enterprise
782782
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.
784784

785785
```yaml
786786
apiVersion: consul.hashicorp.com/v1alpha1
@@ -810,7 +810,7 @@ spec:
810810
```
811811
#### Consul Enterprise
812812

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.
814814

815815
```json
816816
{
@@ -877,7 +877,7 @@ spec:
877877

878878
### Access Logs
879879

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.
881881

882882
<Tabs>
883883
<Tab heading="HCL" group="hcl">

website/content/docs/connect/config-entries/service-defaults.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -778,7 +778,7 @@ Specifies the TLS server name indication (SNI) when federating with an external
778778

779779
### `Expose`
780780

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.
782782

783783
- Default: none
784784
- Data type: map
@@ -1198,7 +1198,7 @@ Specifies the TLS server name indication (SNI) when federating with an external
11981198

11991199
### `spec.expose`
12001200

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.
12021202

12031203
#### Values
12041204

website/content/docs/connect/proxies/deploy-service-mesh-proxies.mdx

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ description: >-
77

88
# Deploy service mesh proxies services
99

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).
1113

1214
## Overview
1315

@@ -16,21 +18,21 @@ Complete the following steps to deploy a service mesh proxy:
1618
1. It is not required, but you can create a proxy defaults configuration entry that contains global passthrough settings for all Envoy proxies.
1719
1. Create a service definition file and specify the proxy configurations in the `proxy` block.
1820
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.
2022

2123
## Requirements
2224

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.
2426

2527
## Configure global Envoy passthrough settings
2628

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.
2830

2931
1. Create a proxy defaults configuration entry and specify the following parameters:
3032
- `Kind`: Must be set to `proxy-defaults`
3133
- `Name`: Must be set to `global`
3234
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:
3436

3537
```shell-session
3638
$ consul config write proxy-defaults.hcl
@@ -48,7 +50,7 @@ Create a service definition file and configure the following fields to define a
4850

4951
Refer to the [Service mesh proxy configuration reference](/consul/docs/connect/proxies/proxy-config-reference) for example configurations.
5052

51-
## Register the service
53+
## Register the service
5254

5355
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:
5456

0 commit comments

Comments
 (0)