Do not configure the `Services` field if `TrafficDirection` is set to `inbound`.
If this field is not set, Envoy targets all applicable resources. When patching outbound listeners, the patch includes the outbound transparent proxy listener only if `Services` is unset and if the local service is in transparent proxy mode. | List of maps | ### `Patches[].Op` Specifies the JSON Patch operation to perform when the `ResourceFilter` matches a local Envoy proxy configuration. You can specify one of the following values for each patch: - `add`: Replaces a property or message specified by [`Path`](#patches-path) with the given value. The JSON patch format does not merge objects. To emulate merges, you must configure discrete `add` operations for each changed field. Consul returns an error if the target field does not exist in the corresponding schema. - `remove`: Unsets the value of the field specified by [`Path`](#patches-path). If the field is not set, no changes are made. Consul returns an error if the target field does not exist in the corresponding schema. #### Values - Default: None - This field is required. - Data type is one of the following string values: - `add` - `remove` ### `Patches[].Path` Specifies where the extension performs the associated operation on the specified resource type. Refer to [`ResourceType`](#patches-resourcefilter) for information about specifying a resource type to target. Refer to [`Op`](#patches-op) for information about setting an operation to perform on the resources. The `Path` field does not support addressing array elements or protobuf map field entries. Refer to [Constructing paths](/consul/docs/connect/proxies/envoy-extensions/usage/property-override#constructing-paths) for information about how to construct paths. When setting fields, the extension sets any unset intermediate fields to their default values. A a single operation on a nested field can set multiple intermediate fields. Because Consul sets the intermediate fields to their default values, you may need to configure subsequent patches to satisfy Envoy or Consul validation. #### Values - Default: None - This field is required. - Data type: String ### `Patches[].Value{}` Defines a value to set at the specified [path](#patches-path) if the [operation](#patches-op) is set to `add`. You can specify either a scalar or enum value or define a map that contains string keys and values corresponding to scalar or enum child fields. Refer to the [example configurations](#examples) for additional guidance and to the [Envoy API documentation](https://www.envoyproxy.io/docs/envoy/latest/api-v3/api) for additional information about Envoy proxy interfaces. If Envoy specifies a wrapper as the target field type, the extension automatically coerces simple values to the wrapped type when patching. For example, the value `32768` is allowed when targeting a cluster's `per_connection_buffer_limit_bytes`, which is a `UInt32Value` field. Refer to the [protobuf documentation](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/wrappers.proto) for additional information about wrappers. #### Values - Default: None - This field is required if [`Op`](#patches-op) is set to `add`, otherwise you must omit the field. - This field takes one of the following data types: - scalar - enum - map ## Examples The following examples demonstrate patterns that you may be able to model your configurations on. ### Enable `enforcing_consecutive_5xx` outlier detection In the following example, the `add` operation patches an outlier detection property into outbound cluster traffic. The `Path` specifies the `enforcing_consecutive_5xx` interface and sets a value of `1234`: ```hcl Kind = "service-defaults" Name = "my-svc" Protocol = "http" EnvoyExtensions = [ { Name = "builtin/property-override", Arguments = { ProxyType = "connect-proxy", Patches = [ { "ResourceFilter" = { "ResourceType" = "cluster", "TrafficDirection" = "outbound", "Service" = { "Name" = "other-svc" }, }, "Op" = "add", "Path" = "/outlier_detection/enforcing_consecutive_5xx", "Value" = 1234, } ] } } ] ``` ### Update multiple values in the default map In the following example, two `ResourceFilter` blocks target outbound traffic to the `db` service and add `/outlier_detection/enforcing_consecutive_5xx` and `/outlier_detection/failure_percentage_request_volume` properties: ```hcl Kind = "service-defaults" Name = "my-svc" Protocol = "http" EnvoyExtensions = [ { Name = "builtin/property-override", Arguments = { ProxyType = "connect-proxy", Patches = [ { ResourceFilter = { ResourceType = "cluster", TrafficDirection = "outbound", Services = [{ Name = "other-svc" }], }, Op = "add", Path = "/outlier_detection/enforcing_consecutive_5xx", Value = 1234, }, { ResourceFilter = { ResourceType = "cluster", TrafficDirection = "outbound", Services = [{ Name = "other-svc" }], }, Op = "add", Path = "/outlier_detection/failure_percentage_request_volume", Value = 2345, } ] } } ] ``` ### Set multiple values that replace the map In the following example, a `ResourceFilter` targets outbound traffic to the `db` service and replaces the map of properties located at `/outlier_detection` with `enforcing_consecutive_5xx` and `failure_percentage_request_volume` and properties: ```hcl Kind = "service-defaults" Name = "my-svc" Protocol = "http" EnvoyExtensions = [ { Name = "builtin/property-override", Arguments = { ProxyType = "connect-proxy", Patches = [ { ResourceFilter = { ResourceType = "cluster", TrafficDirection = "outbound", Services = [{ Name = "other-svc" }], }, Op = "add", Path = "/outlier_detection", Value = { "enforcing_consecutive_5xx" = 1234, "failure_percentage_request_volume" = 2345, }, } ] } } ] ```