Skip to content

Commit

Permalink
update envoyextension warning in proxy defaults so its inline
Browse files Browse the repository at this point in the history
  • Loading branch information
im2nguyen committed Feb 23, 2023
1 parent dff308a commit df03a72
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -281,8 +281,6 @@ spec:

### Configuration Parameters

Although you can apply `EnvoyExtensions` to `ProxyDefaults`, this may have unintended consequences. We recommend enabling `EnvoyExtensions` with `ServiceDefaults` in most cases.

<ConfigEntryReference
keys={[
{
Expand Down Expand Up @@ -353,7 +351,8 @@ Although you can apply `EnvoyExtensions` to `ProxyDefaults`, this may have unint
{
name: 'EnvoyExtensions',
type: 'array<EnvoyExtension>: []',
description: `A list of extensions to modify Envoy proxy configuration.`,
description: `A list of extensions to modify Envoy proxy configuration.<br><br>
Applying \`EnvoyExtensions\` to \`ProxyDefaults\` may produce unintended consequences. We recommend enabling \`EnvoyExtensions\` with [\`ServiceDefaults\`](/consul/docs/connect/config-entries/service-defaults#envoyextensions) in most cases.`,
children: [
{
name: 'Name',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ To use Envoy extensions, you must configure and apply a `proxy-defaults` or `ser
- When you configure Envoy extensions on `proxy-defaults`, they apply to every service.
- When you configure Envoy extensions on `service-defaults`, they apply to a specific service.

Consul applies Envoy extensions configured in `proxy-defaults`before it applies extensions in `service-defaults`. As a result, the Envoy extension configuration in `service-defaults` may override configurations in `proxy-defaults`.
Consul applies Envoy extensions configured in `proxy-defaults` before it applies extensions in `service-defaults`. As a result, the Envoy extension configuration in `service-defaults` may override configurations in `proxy-defaults`.

The following example configures the Lua Envoy extension on every service by using the `proxy-defaults`.

Expand Down

0 comments on commit df03a72

Please sign in to comment.