Global Mesh Options

Port on which Envoy should listen for all outbound traffic to other services. Default port is 15001.

Port on which Envoy should listen for all inbound traffic to the pod/vm will be captured to. Default port is 15006.

Port on which Envoy should listen for HTTP PROXY requests if set.

Connection timeout used by Envoy. (MUST be >=1ms) Default timeout is 10s.

If set then set SO_KEEPALIVE on the socket to enable TCP Keepalives.

Class of ingress resources to be processed by Istio ingress controller. This corresponds to the value of kubernetes.io/ingress.class annotation.

Name of the Kubernetes service used for the istio ingress controller. If no ingress controller is specified, the default value istio-ingressgateway is used.

Defines whether to use Istio ingress controller for annotated or all ingress resources. Default mode is STRICT.

Defines which gateway deployment to use as the Ingress controller. This field corresponds to the Gateway.selector field, and will be set as istio: INGRESS_SELECTOR. By default, ingressgateway is used, which will select the default IngressGateway as it has the istio: ingressgateway labels. It is recommended that this is the same value as ingressService.

Flag to control generation of trace spans and request IDs. Requires a trace span collector defined in the proxy configuration.

File address for the proxy access log (e.g. /dev/stdout). Empty value disables access logging.

Format for the proxy access log Empty value results in proxy’s default access log format

Encoding for the proxy access log (TEXT or JSON). Default value is TEXT.

This flag enables Envoy’s gRPC Access Log Service. See Access Log Service for details about Envoy’s gRPC Access Log Service API. Default value is false.

This flag disables Envoy Listener logs. See Listener Access Log Istio Enables Envoy’s listener access logs on “NoRoute” response flag. Default value is false.

Default proxy config used by gateway and sidecars. In case of Kubernetes, the proxy config is applied once during the injection process, and remain constant for the duration of the pod. The rest of the mesh config can be changed at runtime and config gets distributed dynamically. On Kubernetes, this can be overridden on individual pods with the proxy.istio.io/config annotation.

Set the default behavior of the sidecar for handling outbound traffic from the application.

Can be overridden at a Sidecar level by setting the OutboundTrafficPolicy in the Sidecar API.

Default mode is ALLOW_ANY, which means outbound traffic to unknown destinations will be allowed.

Set the default behavior of the sidecar for handling inbound traffic to the application. If your application listens on localhost, you will need to set this to LOCALHOST.

ConfigSource describes a source of configuration data for networking rules, and other Istio configuration artifacts. Multiple data sources can be configured for a single control plane.

This flag is used to enable mutual TLS automatically for service to service communication within the mesh, default true. If set to true, and a given service does not have a corresponding DestinationRule configured, or its DestinationRule does not have ClientTLSSettings specified, Istio configures client side TLS configuration appropriately. More specifically, If the upstream authentication policy is in STRICT mode, use Istio provisioned certificate for mutual TLS to connect to upstream. If upstream service is in plain text mode, use plain text. If the upstream authentication policy is in PERMISSIVE mode, Istio configures clients to use mutual TLS when server sides are capable of accepting mutual TLS traffic. If service DestinationRule exists and has ClientTLSSettings specified, that is always used instead.

The trust domain corresponds to the trust root of a system. Refer to SPIFFE-ID

The trust domain aliases represent the aliases of trustDomain. For example, if we have

trustDomain: td1
trustDomainAliases: ["td2", "td3"]

Any service with the identity td1/ns/foo/sa/a-service-account, td2/ns/foo/sa/a-service-account, or td3/ns/foo/sa/a-service-account will be treated the same in the Istio mesh.

The extra root certificates for workload-to-workload communication. The plugin certificates (the ‘cacerts’ secret) or self-signed certificates (the ‘istio-ca-secret’ secret) are automatically added by Istiod. The CA certificate that signs the workload certificates is automatically added by Istio Agent.

The default value for the ServiceEntry.exportTo field and services imported through container registry integrations, e.g. this applies to Kubernetes Service resources. The value is a list of namespace names and reserved namespace aliases. The allowed namespace aliases are:

* - All Namespaces
. - Current Namespace
~ - No Namespace

If not set the system will use “*” as the default value which implies that services are exported to all namespaces.

All namespaces is a reasonable default for implementations that don’t need to restrict access or visibility of services across namespace boundaries. If that requirement is present it is generally good practice to make the default Current namespace so that services are only visible within their own namespaces by default. Operators can then expand the visibility of services to other namespaces as needed. Use of No Namespace is expected to be rare but can have utility for deployments where dependency management needs to be precise even within the scope of a single namespace.

For further discussion see the reference documentation for ServiceEntry, Sidecar, and Gateway.

The default value for the VirtualService.exportTo field. Has the same syntax as defaultServiceExportTo.

If not set the system will use “*” as the default value which implies that virtual services are exported to all namespaces

The default value for the DestinationRule.exportTo field. Has the same syntax as defaultServiceExportTo.

If not set the system will use “*” as the default value which implies that destination rules are exported to all namespaces

The namespace to treat as the administrative root namespace for Istio configuration. When processing a leaf namespace Istio will search for declarations in that namespace first and if none are found it will search in the root namespace. Any matching declaration found in the root namespace is processed as if it were declared in the leaf namespace.

The precise semantics of this processing are documented on each resource type.

Locality based load balancing distribution or failover settings. If unspecified, locality based load balancing will be enabled by default. However, this requires outlierDetection to actually take effect for a particular service, see https://istio.io/latest/docs/tasks/traffic-management/locality-load-balancing/failover/

Configures DNS refresh rate for Envoy clusters of type STRICT_DNS Default refresh rate is 60s.

Specify if http1.1 connections should be upgraded to http2 by default. if sidecar is installed on all pods in the mesh, then this should be set to UPGRADE. If one or more services or namespaces do not have sidecar(s), then this should be set to DO_NOT_UPGRADE. It can be enabled by destination using the destinationRule.trafficPolicy.connectionPool.http.h2UpgradePolicy override.

Name to be used while emitting statistics for inbound clusters. The same pattern is used while computing stat prefix for network filters like TCP and Redis. By default, Istio emits statistics with the pattern inbound|<port>|<port-name>|<service-FQDN>. For example inbound|7443|grpc-reviews|reviews.prod.svc.cluster.local. This can be used to override that pattern.

A Pattern can be composed of various pre-defined variables. The following variables are supported.

• %SERVICE% - Will be substituted with short hostname of the service.
• %SERVICE_NAME% - Will be substituted with name of the service.
• %SERVICE_FQDN% - Will be substituted with FQDN of the service.
• %SERVICE_PORT% - Will be substituted with port of the service.
• %TARGET_PORT% - Will be substituted with the target port of the service.
• %SERVICE_PORT_NAME% - Will be substituted with port name of the service.

Following are some examples of supported patterns for reviews:

• %SERVICE_FQDN%_%SERVICE_PORT% will use reviews.prod.svc.cluster.local_7443 as the stats name.
• %SERVICE% will use reviews.prod as the stats name.

Name to be used while emitting statistics for outbound clusters. The same pattern is used while computing stat prefix for network filters like TCP and Redis. By default, Istio emits statistics with the pattern outbound|<port>|<subsetname>|<service-FQDN>. For example outbound|8080|v2|reviews.prod.svc.cluster.local. This can be used to override that pattern.

A Pattern can be composed of various pre-defined variables. The following variables are supported.

• %SERVICE% - Will be substituted with short hostname of the service.
• %SERVICE_NAME% - Will be substituted with name of the service.
• %SERVICE_FQDN% - Will be substituted with FQDN of the service.
• %SERVICE_PORT% - Will be substituted with port of the service.
• %SERVICE_PORT_NAME% - Will be substituted with port name of the service.
• %SUBSET_NAME% - Will be substituted with subset.

Following are some examples of supported patterns for reviews:

• %SERVICE_FQDN%_%SERVICE_PORT% will use reviews.prod.svc.cluster.local_7443 as the stats name.
• %SERVICE% will use reviews.prod as the stats name.

If enabled, Istio agent will merge metrics exposed by the application with metrics from Envoy and Istio agent. The sidecar injection will replace prometheus.io annotations present on the pod and redirect them towards Istio agent, which will then merge metrics of from the application with Istio metrics. This relies on the annotations prometheus.io/scrape, prometheus.io/port, and prometheus.io/path annotations. If you are running a separately managed Envoy with an Istio sidecar, this may cause issues, as the metrics will collide. In this case, it is recommended to disable aggregation on that deployment with the prometheus.istio.io/merge-metrics: "false" annotation. If not specified, this will be enabled by default.

Defines a list of extension providers that extend Istio’s functionality. For example, the AuthorizationPolicy can be used with an extension provider to delegate the authorization decision to a custom authorization system.

Specifies extension providers to use by default in Istio configuration resources.

A list of Kubernetes selectors that specify the set of namespaces that Istio considers when computing configuration updates for sidecars. This can be used to reduce Istio’s computational load by limiting the number of entities (including services, pods, and endpoints) that are watched and processed. If omitted, Istio will use the default behavior of processing all namespaces in the cluster. Elements in the list are disjunctive (OR semantics), i.e. a namespace will be included if it matches any selector. The following example selects any namespace that matches either below:

1. The namespace has both of these labels: env: prod and region: us-east1
2. The namespace has label app equal to cassandra or spark.

discoverySelectors:
  - matchLabels:
      env: prod
      region: us-east1
  - matchExpressions:
    - key: app
      operator: In
      values:
        - cassandra
        - spark

Refer to the Kubernetes selector docs for additional detail on selector semantics.

ProxyPathNormalization configures how URL paths in incoming and outgoing HTTP requests are normalized by the sidecars and gateways. The normalized paths will be used in all aspects through the requests’ lifetime on the sidecars and gateways, which includes routing decisions in outbound direction (client proxy), authorization policy match and enforcement in inbound direction (server proxy), and the URL path proxied to the upstream service. If not set, the NormalizationType.DEFAULT configuration will be used.

Configure the default HTTP retry policy. The default number of retry attempts is set at 2 for these errors: “connect-failure,refused-stream,unavailable,cancelled,retriable-status-codes”. Setting the number of attempts to 0 disables retry policy globally. This setting can be overridden on a per-host basis using the Virtual Service API. All settings in the retry policy except perTryTimeout can currently be configured globally via this field.

The below configuration parameters can be used to specify TLSConfig for mesh traffic. For example, a user could enable min TLS version for ISTIO_MUTUAL traffic and specify a curve for non ISTIO_MUTUAL traffic like below:

meshConfig:
  meshMTLS:
    minProtocolVersion: TLSV1_3
  tlsDefaults:
    Note: applicable only for non ISTIO_MUTUAL scenarios
    ecdhCurves:
      - P-256
      - P-512

Configuration of mTLS for traffic between workloads with ISTIO_MUTUAL TLS traffic.

Note: Mesh mTLS does not respect ECDH curves.

Configuration of TLS for all traffic except for ISTIO_MUTUAL mode. Currently, this supports configuration of ecdhCurves and cipherSuites only. For ISTIO_MUTUAL TLS settings, use meshMTLS configuration.

Specify the kubernetes signers (External CA) that use this trustAnchor when Istiod is acting as RA(registration authority) If set, they are used for these signers. Otherwise, this trustAnchor is used for all signers.

Specify the list of trust domains to which this trustAnchor data belongs. If set, they are used for these trust domains. Otherwise, this trustAnchor is used for default trust domain and its aliases. Note that we can have multiple trustAnchor data for a same trustDomain. In that case, trustAnchors with a same trust domain will be merged and used together to verify peer certificates. If neither certSigners nor trustDomains is set, this trustAnchor is used for all trust domains and all signers. If only trustDomains is set, this trustAnchor is used for these trustDomains and all signers. If only certSigners is set, this trustAnchor is used for these certSigners and all trust domains. If both certSigners and trustDomains is set, this trustAnchor is only used for these signers and trust domains.

REQUIRED. Address of the CA server implementing the Istio CA gRPC API. Can be IP address or a fully qualified DNS name with port Eg: custom-ca.default.svc.cluster.local:8932, 192.168.23.2:9000

Use the tlsSettings to specify the tls mode to use. Regarding tlsSettings:

• DISABLE MODE is legitimate for the case Istiod is making the request via an Envoy sidecar. DISABLE MODE can also be used for testing
• TLS MUTUAL MODE be on by default. If the CA certificates (cert bundle to verify the CA server’s certificate) is omitted, Istiod will use the system root certs to verify the CA server’s certificate.

timeout for forward CSR requests from Istiod to External CA Default: 10s

Use istiodSide to specify CA Server integrate to Istiod side or Agent side Default: true

REQUIRED. A unique name identifying the extension provider.

Sets the maximum size of a message body that the ext-authz filter will hold in memory. If maxRequestBytes is reached, and allowPartialMessage is false, Envoy will return a 413 (Payload Too Large). Otherwise the request will be sent to the provider with a partial message. Note that this setting will have precedence over the failOpen field, the 413 will be returned even when the failOpen is set to true.

When this field is true, ext-authz filter will buffer the message until maxRequestBytes is reached. The authorization request will be dispatched and no 413 HTTP error will be returned by the filter. A “x-envoy-auth-partial-body: false|true” metadata header will be added to the authorization request message indicating if the body data is partial.

If true, the body sent to the external authorization service in the gRPC authorization request is set with raw bytes in the raw_body field. Otherwise, it will be filled with UTF-8 string in the body field. This field only works with the envoyExtAuthzGrpc provider and has no effect for the envoyExtAuthzHttp provider.

REQUIRED. Specifies the service that implements the Envoy ext_authz HTTP authorization service. The format is [<Namespace>/]<Hostname>. The specification of <Namespace> is required only when it is insufficient to unambiguously resolve a service in the service registry. The <Hostname> is a fully qualified host name of a service defined by the Kubernetes service or ServiceEntry.

Example: “my-ext-authz.foo.svc.cluster.local” or “bar/my-ext-authz.example.com”.

REQUIRED. Specifies the port of the service.

The maximum duration that the proxy will wait for a response from the provider (default timeout: 600s). When this timeout condition is met, the proxy marks the communication to the authorization service as failure. In this situation, the response sent back to the client will depend on the configured failOpen field.

Sets a prefix to the value of authorization request header Path. For example, setting this to “/check” for an original user request at path “/admin” will cause the authorization check request to be sent to the authorization service at the path “/check/admin” instead of “/admin”.

If true, the user request will be allowed even if the communication with the authorization service has failed, or if the authorization service has returned a HTTP 5xx error. Default is false and the request will be rejected with “Forbidden” response.

Sets the HTTP status that is returned to the client when there is a network error to the authorization service. The default status is “403” (HTTP Forbidden).

List of client request headers that should be included in the authorization request sent to the authorization service. Note that in addition to the headers specified here following headers are included by default:

1. Host, Method, Path and Content-Length are automatically sent.
2. Content-Length will be set to 0 and the request will not have a message body. However, the authorization request can include the buffered client request body (controlled by includeRequestBodyInCheck setting), consequently the value of Content-Length of the authorization request reflects the size of its payload size.

Exact, prefix and suffix matches are supported (similar to the authorization policy rule syntax except the presence match):

• Exact match: “abc” will match on value “abc”.
• Prefix match: “abc*” will match on value “abc” and “abcd”.
• Suffix match: “*abc” will match on value “abc” and “xabc”.

Set of additional fixed headers that should be included in the authorization request sent to the authorization service. Key is the header name and value is the header value. Note that client request of the same key or headers specified in includeRequestHeadersInCheck will be overridden.

If set, the client request body will be included in the authorization request sent to the authorization service.

List of headers from the authorization service that should be added or overridden in the original request and forwarded to the upstream when the authorization check result is allowed (HTTP code 200). If not specified, the original request will not be modified and forwarded to backend as-is. Note, any existing headers will be overridden.

Exact, prefix and suffix matches are supported (similar to the authorization policy rule syntax except the presence match):

• Exact match: “abc” will match on value “abc”.
• Prefix match: “abc*” will match on value “abc” and “abcd”.
• Suffix match: “*abc” will match on value “abc” and “xabc”.

List of headers from the authorization service that should be forwarded to downstream when the authorization check result is not allowed (HTTP code other than 200). If not specified, all the authorization response headers, except Authority (Host) will be in the response to the downstream. When a header is included in this list, Path, Status, Content-Length, WWWAuthenticate and Location are automatically added. Note, the body from the authorization service is always included in the response to downstream.

Exact, prefix and suffix matches are supported (similar to the authorization policy rule syntax except the presence match):

• Exact match: “abc” will match on value “abc”.
• Prefix match: “abc*” will match on value “abc” and “abcd”.
• Suffix match: “*abc” will match on value “abc” and “xabc”.

List of headers from the authorization service that should be forwarded to downstream when the authorization check result is allowed (HTTP code 200). If not specified, the original response will not be modified and forwarded to downstream as-is. Note, any existing headers will be overridden.

Exact, prefix and suffix matches are supported (similar to the authorization policy rule syntax except the presence match):

• Exact match: “abc” will match on value “abc”.
• Prefix match: “abc*” will match on value “abc” and “abcd”.
• Suffix match: “*abc” will match on value “abc” and “xabc”.

REQUIRED. Specifies the service that implements the Envoy ext_authz gRPC authorization service. The format is [<Namespace>/]<Hostname>. The specification of <Namespace> is required only when it is insufficient to unambiguously resolve a service in the service registry. The <Hostname> is a fully qualified host name of a service defined by the Kubernetes service or ServiceEntry.

Example: “my-ext-authz.foo.svc.cluster.local” or “bar/my-ext-authz.example.com”.

REQUIRED. Specifies the port of the service.

The maximum duration that the proxy will wait for a response from the provider, this is the timeout for a specific request (default timeout: 600s). When this timeout condition is met, the proxy marks the communication to the authorization service as failure. In this situation, the response sent back to the client will depend on the configured failOpen field.

If true, the HTTP request or TCP connection will be allowed even if the communication with the authorization service has failed, or if the authorization service has returned a HTTP 5xx error. Default is false. For HTTP request, it will be rejected with 403 (HTTP Forbidden). For TCP connection, it will be closed immediately.

Sets the HTTP status that is returned to the client when there is a network error to the authorization service. The default status is “403” (HTTP Forbidden).

If set, the client request body will be included in the authorization request sent to the authorization service.

REQUIRED. Specifies the service that the Zipkin API. The format is [<Namespace>/]<Hostname>. The specification of <Namespace> is required only when it is insufficient to unambiguously resolve a service in the service registry. The <Hostname> is a fully qualified host name of a service defined by the Kubernetes service or ServiceEntry.

Example: “zipkin.default.svc.cluster.local” or “bar/zipkin.example.com”.

REQUIRED. Specifies the port of the service.

Controls the overall path length allowed in a reported span. NOTE: currently only controls max length of the path tag.

A 128 bit trace id will be used in Istio. If true, will result in a 64 bit trace id being used.

Specifies the endpoint of Zipkin API. The default value is “/api/v2/spans”.

REQUIRED. Specifies the service for the Lightstep collector. The format is [<Namespace>/]<Hostname>. The specification of <Namespace> is required only when it is insufficient to unambiguously resolve a service in the service registry. The <Hostname> is a fully qualified host name of a service defined by the Kubernetes service or ServiceEntry.

Example: “lightstep.default.svc.cluster.local” or “bar/lightstep.example.com”.

REQUIRED. Specifies the port of the service.

The Lightstep access token.

Controls the overall path length allowed in a reported span. NOTE: currently only controls max length of the path tag.

REQUIRED. Specifies the service for the Datadog agent. The format is [<Namespace>/]<Hostname>. The specification of <Namespace> is required only when it is insufficient to unambiguously resolve a service in the service registry. The <Hostname> is a fully qualified host name of a service defined by the Kubernetes service or ServiceEntry.

Example: “datadog.default.svc.cluster.local” or “bar/datadog.example.com”.

REQUIRED. Specifies the port of the service.

Controls the overall path length allowed in a reported span. NOTE: currently only controls max length of the path tag.

REQUIRED. Specifies the service for the SkyWalking receiver. The format is [<Namespace>/]<Hostname>. The specification of <Namespace> is required only when it is insufficient to unambiguously resolve a service in the service registry. The <Hostname> is a fully qualified host name of a service defined by the Kubernetes service or ServiceEntry.

Example: “skywalking.default.svc.cluster.local” or “bar/skywalking.example.com”.

REQUIRED. Specifies the port of the service.

The SkyWalking OAP access token.

Controls the overall path length allowed in a reported span. NOTE: currently only controls max length of the path tag.

Controls Stackdriver logging behavior.

Collection of tag names and tag expressions to include in the log entry. Conflicts are resolved by the tag name by overriding previously supplied values.

Example: labels: path: request.url_path foo: request.headers[‘x-foo’]

REQUIRED. Specifies the service for the OpenCensusAgent. The format is [<Namespace>/]<Hostname>. The specification of <Namespace> is required only when it is insufficient to unambiguously resolve a service in the service registry. The <Hostname> is a fully qualified host name of a service defined by the Kubernetes service or ServiceEntry.

Example: “ocagent.default.svc.cluster.local” or “bar/ocagent.example.com”.

REQUIRED. Specifies the port of the service.

Specifies the set of context propagation headers used for distributed tracing. Default is ["W3C_TRACE_CONTEXT"]. If multiple values are specified, the proxy will attempt to read each header for each request and will write all headers.

Controls the overall path length allowed in a reported span. NOTE: currently only controls max length of the path tag.

Path to a local file to write the access log entries. This may be used to write to streams, via /dev/stderr and /dev/stdout If unspecified, defaults to /dev/stdout.

Allows overriding of the default access log format.

REQUIRED. Specifies the service that implements the Envoy ALS gRPC authorization service. The format is [<Namespace>/]<Hostname>. The specification of <Namespace> is required only when it is insufficient to unambiguously resolve a service in the service registry. The <Hostname> is a fully qualified host name of a service defined by the Kubernetes service or ServiceEntry.

Example: “envoy-als.foo.svc.cluster.local” or “bar/envoy-als.example.com”.

REQUIRED. Specifies the port of the service.

The friendly name of the access log. Defaults:

• “http_envoy_accesslog”
• “listener_envoy_accesslog”

Additional filter state objects to log.

Additional request headers to log.

Additional response headers to log.

Additional response trailers to log.

REQUIRED. Specifies the service that implements the Envoy ALS gRPC authorization service. The format is [<Namespace>/]<Hostname>. The specification of <Namespace> is required only when it is insufficient to unambiguously resolve a service in the service registry. The <Hostname> is a fully qualified host name of a service defined by the Kubernetes service or ServiceEntry.

Example: “envoy-als.foo.svc.cluster.local” or “bar/envoy-als.example.com”.

REQUIRED. Specifies the port of the service.

The friendly name of the access log. Defaults:

• “tcp_envoy_accesslog”
• “listener_envoy_accesslog”

Additional filter state objects to log.

REQUIRED. Specifies the service that implements the Envoy ALS gRPC authorization service. The format is [<Namespace>/]<Hostname>. The specification of <Namespace> is required only when it is insufficient to unambiguously resolve a service in the service registry. The <Hostname> is a fully qualified host name of a service defined by the Kubernetes service or ServiceEntry.

Example: “envoy-als.foo.svc.cluster.local” or “bar/envoy-als.example.com”.

REQUIRED. Specifies the port of the service.

The friendly name of the access log. Defaults:

• “otel_envoy_accesslog”

Format for the proxy access log Empty value results in proxy’s default access log format, following Envoy access logging formatting.

Textual format for the envoy access logs. Envoy command operators may be used in the format. The format string documentation provides more information. Alias to body field in Open Telemetry Example: text: "%LOCAL_REPLY_BODY%:%RESPONSE_CODE%:path=%REQ(:path)%"

Additional attributes that describe the specific event occurrence. Structured format for the envoy access logs. Envoy command operators can be used as values for fields within the Struct. Values are rendered as strings, numbers, or boolean values, as appropriate (see: format dictionaries). Nested JSON is supported for some command operators (e.g. FILTER_STATE or DYNAMIC_METADATA). Alias to attributes field in Open Telemetry

Example:

labels:
  status: "%RESPONSE_CODE%"
  message: "%LOCAL_REPLY_BODY%"

REQUIRED. Specifies the OpenTelemetry endpoint that will receive OTLP traces. The format is [<Namespace>/]<Hostname>. The specification of <Namespace> is required only when it is insufficient to unambiguously resolve a service in the service registry. The <Hostname> is a fully qualified host name of a service defined by the Kubernetes service or ServiceEntry.

Example: “otlp.default.svc.cluster.local” or “bar/otlp.example.com”.

REQUIRED. Specifies the port of the service.

Controls the overall path length allowed in a reported span. NOTE: currently only controls max length of the path tag.

Specifies the configuration for exporting OTLP traces via HTTP. When empty, traces will be exported via gRPC.

The following example shows how to configure the OpenTelemetry ExtensionProvider to export via HTTP:

1. Add/change the OpenTelemetry extension provider in MeshConfig

- name: otel-tracing
  opentelemetry:
    port: 443
    service: my.olly-backend.com
    http:
      path: "/api/otlp/traces"
      timeout: 10s
      headers:
      - name: "my-custom-header"
        value: "some value"

2. Deploy a ServiceEntry for the observability back-end

apiVersion: networking.istio.io/v1alpha3
kind: ServiceEntry
metadata:
  name: my-olly-backend
spec:
  hosts:
  - my.olly-backend.com
  ports:
  - number: 443
    name: https-port
    protocol: HTTPS
  resolution: DNS
  location: MESH_EXTERNAL
---
apiVersion: networking.istio.io/v1alpha3
kind: DestinationRule
metadata:
  name: my-olly-backend
spec:
  host: my.olly-backend.com
  trafficPolicy:
    portLevelSettings:
    - port:
        number: 443
      tls:
        mode: SIMPLE

Specifies the configuration for exporting OTLP traces via GRPC. When empty, traces will check whether HTTP is set. If not, traces will use default GRPC configurations.

The following example shows how to configure the OpenTelemetry ExtensionProvider to export via GRPC:

1. Add/change the OpenTelemetry extension provider in MeshConfig

- name: opentelemetry
  opentelemetry:
    port: 8090
    service: tracing.example.com
    grpc:
      timeout: 10s
      initialMetadata:
      - name: "Authentication"
        value: "token-xxxxx"

2. Deploy a ServiceEntry for the observability back-end

apiVersion: networking.istio.io/v1alpha3
kind: ServiceEntry
metadata:
  name: tracing-grpc
spec:
  hosts:
  - tracing.example.com
  ports:
  - number: 8090
    name: grpc-port
    protocol: GRPC
  resolution: DNS
  location: MESH_EXTERNAL

Specifies Resource Detectors to be used by the OpenTelemetry Tracer. When multiple resources are provided, they are merged according to the OpenTelemetry Resource specification.

The following example shows how to configure the Environment Resource Detector, that will read the attributes from the environment variable OTEL_RESOURCE_ATTRIBUTES:

- name: otel-tracing
  opentelemetry:
    port: 443
    service: my.olly-backend.com
    resourceDetectors:
      environment: {}

REQUIRED. The Dynatrace customer’s tenant identifier.

The value can be obtained from the Istio deployment page in Dynatrace.

REQUIRED. The identifier of the cluster in the Dynatrace platform. The cluster here is Dynatrace-specific concept and not related to the cluster concept in Istio/Envoy.

The value can be obtained from the Istio deployment page in Dynatrace.

Number of sampled spans per minute to be used when the adaptive value cannot be obtained from the Dynatrace API.

A default value of 1000 is used when:

• rootSpansPerMinute is unset
• rootSpansPerMinute is set to 0

Dynatrace HTTP API to obtain sampling configuration.

When not provided, the Dynatrace Sampler will re-use the configuration from the OpenTelemetryTracingProvider HTTP Exporter (service, port and http), including the access token.

REQUIRED. Specifies the Dynatrace environment to obtain the sampling configuration. The format is <Hostname>, where <Hostname> is the fully qualified Dynatrace environment host name defined in the ServiceEntry.

Example: “{your-environment-id}.live.dynatrace.com”.

REQUIRED. Specifies the port of the service.

REQUIRED. Specifies sampling configuration URI.

REQUIRED. Specifies the path on the service.

Specifies the timeout for the HTTP request. If not specified, the default is 3s.

Allows specifying custom HTTP headers that will be added to each HTTP request sent.

REQUIRED. The HTTP header name.

REQUIRED. The HTTP header value.

Specifies the timeout for the GRPC request.

Additional metadata to include in streams initiated to the GrpcService. This can be used for scenarios in which additional ad hoc authorization headers (e.g. "x-foo-bar: baz-key") are to be injected.

Name of the default provider(s) for tracing.

Name of the default provider(s) for metrics.

Name of the default provider(s) for access logging.

the minimum TLS protocol version. The default minimum TLS version will be TLS 1.2. As servers may not be Envoy and be set to TLS 1.2 (e.g., workloads using mTLS without sidecars), the minimum TLS version for clients may also be TLS 1.2. In the current Istio implementation, the maximum TLS protocol version is TLS 1.3.

Optional: If specified, the TLS connection will only support the specified ECDH curves for the DH key exchange. If not specified, the default curves enforced by Envoy will be used. For details about the default curves, refer to Ecdh Curves.

Optional: If specified, the TLS connection will only support the specified cipher list when negotiating TLS 1.0-1.2. If not specified, the following cipher suites will be used:

ECDHE-ECDSA-AES256-GCM-SHA384
ECDHE-RSA-AES256-GCM-SHA384
ECDHE-ECDSA-AES128-GCM-SHA256
ECDHE-RSA-AES128-GCM-SHA256
AES256-GCM-SHA384
AES128-GCM-SHA256

If true, specifies that the client and service endpoints must reside in the same cluster. By default, in multi-cluster deployments, the Istio control plane assumes all service endpoints to be reachable from any client in any of the clusters which are part of the mesh. This configuration option limits the set of service endpoints visible to a client to be cluster scoped.

There are some common scenarios when this can be useful:

• A service (or group of services) is inherently local to the cluster and has local storage for that cluster. For example, the kube-system namespace (e.g. the Kube API Server).
• A mesh administrator wants to slowly migrate services to Istio. They might start by first having services cluster-local and then slowly transition them to mesh-wide. They could do this service-by-service (e.g. mysvc.myns.svc.cluster.local) or as a group (e.g. *.myns.svc.cluster.local).

By default Istio will consider kubernetes.default.svc (i.e. the API Server) as well as all services in the kube-system namespace to be cluster-local, unless explicitly overridden here.

matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is “key”, the operator is “In”, and the values array contains only “value”. The requirements are ANDed.

matchExpressions is a list of label selector requirements. The requirements are ANDed.

key is the label key that the selector applies to.

operator represents a key’s relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.

values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.

Address of the server implementing the Istio Mesh Configuration protocol (MCP). Can be IP address or a fully qualified DNS name. Use xds:// to specify a grpc-based xds backend, k8s:// to specify a k8s controller or fs:/// to specify a file-based backend with absolute path to the directory.

Use the tlsSettings to specify the tls mode to use. If the MCP server uses Istio mutual TLS and shares the root CA with istiod, specify the TLS mode as ISTIO_MUTUAL.

Describes the source of configuration, if nothing is specified default is MCP

The percentage of requests (0.0 - 100.0) that will be randomly selected for trace generation, if not requested by the client or not forced. Default is 1.0.

Use the tlsSettings to specify the tls mode to use. If the remote tracing service uses Istio mutual TLS and shares the root CA with istiod, specify the TLS mode as ISTIO_MUTUAL.

Address of the Zipkin service (e.g. zipkin:9411).

Address of the Datadog Agent.

gRPC address for the OpenCensus agent (e.g. dns://authority/host:port or unix:path). See gRPC naming docs for details.

Specifies the set of context propagation headers used for distributed tracing. Default is ["W3C_TRACE_CONTEXT"]. If multiple values are specified, the proxy will attempt to read each header for each request and will write all headers.

Number of trusted proxies deployed in front of the Istio gateway proxy. When this option is set to value N greater than zero, the trusted client address is assumed to be the Nth address from the right end of the X-Forwarded-For (XFF) header from the incoming request. If the X-Forwarded-For (XFF) header is missing or has fewer than N addresses, the gateway proxy falls back to using the immediate downstream connection’s source address as the trusted client address. Note that the gateway proxy will append the downstream connection’s source address to the X-Forwarded-For (XFF) address and set the X-Envoy-External-Address header to the trusted client address before forwarding it to the upstream services in the cluster. The default value of numTrustedProxies is 0. See Envoy XFF header handling for more details.

Configures how the gateway proxy handles x-forwarded-client-cert (XFCC) header in the incoming request.

Enables PROXY protocol for downstream connections on a gateway.

How long to wait until the per-thread processing queue should be processed. If the processing queue gets full (eight sign or decrypt requests are received) it is processed immediately. However, if the queue is not filled before the delay has expired, the requests already in the queue are processed, even if the queue is not full. In effect, this value controls the balance between latency and throughput. The duration needs to be set to a value greater than or equal to 1 millisecond.

If the private key provider isn’t available (eg. the required hardware capability doesn’t existed) Envoy will fallback to the BoringSSL default implementation when the fallback is true. The default value is false.

How long to wait before polling the hardware accelerator after a request has been submitted there. Having a small value leads to quicker answers from the hardware but causes more polling loop spins, leading to potentially larger CPU usage. The duration needs to be set to a value greater than or equal to 1 millisecond.

If the private key provider isn’t available (eg. the required hardware capability doesn’t existed) Envoy will fallback to the BoringSSL default implementation when the fallback is true. The default value is false.

Path to the generated configuration file directory. Proxy agent generates the actual configuration and stores it in this directory.

Path to the proxy binary

The time in seconds that Envoy will drain connections during a hot restart. MUST be >=1s (e.g., 1s/1m/1h) Default drain duration is 45s.

Address of the discovery service exposing xDS with mTLS connection. The inject configuration may override this value.

IP Address and Port of a statsd UDP listener (e.g. 10.75.241.127:9125).

Port on which Envoy should listen for administrative commands. Default port is 15000.

AuthenticationPolicy defines how the proxy is authenticated when it connects to the control plane. Default is set to MUTUAL_TLS.

File path of custom proxy configuration, currently used by proxies in front of istiod.

Maximum length of name field in Envoy’s metrics. The length of the name field is determined by the length of a name field in a service and the set of labels that comprise a particular version of the service. The default value is set to 189 characters. Envoy’s internal metrics take up 67 characters, for a total of 256 character name per metric. Increase the value of this field if you find that the metrics from Envoys are truncated.

The number of worker threads to run. If unset, which is recommended, this will be automatically determined based on CPU requests/limits. If set to 0, all cores on the machine will be used, ignoring CPU requests or limits. This can lead to major performance issues if CPU limits are also set.

Path to the proxy bootstrap template file

The mode used to redirect inbound traffic to Envoy.

Tracing configuration to be used by the proxy.

Address of the service to which access logs from Envoys should be sent. (e.g. accesslog-service:15000). See Access Log Service for details about Envoy’s gRPC Access Log Service API.

Address of the Envoy Metrics Service implementation (e.g. metrics-service:15000). See Metric Service for details about Envoy’s Metrics Service API.

Additional environment variables for the proxy. Names starting with ISTIO_META_ will be included in the generated bootstrap and sent to the XDS server.

Envoy runtime configuration to set during bootstrapping. This enables setting experimental, unsafe, unsupported, and deprecated features that should be used with extreme caution.

Port on which the agent should listen for administrative commands such as readiness probe. Default is set to port 15020.

An additional list of tags to extract from the in-proxy Istio telemetry. These extra tags can be added by configuring the telemetry extension. Each additional tag needs to be present in this list. Extra tags emitted by the telemetry extensions must be listed here so that they can be processed and exposed as Prometheus metrics. Deprecated: istio.stats is a native filter now, this field is no longer needed.

Topology encapsulates the configuration which describes where the proxy is located i.e. behind a (or N) trusted proxy (proxies) or directly exposed to the internet. This configuration only effects gateways and is applied to all the gateways in the cluster unless overridden via annotations of the gateway workloads.

The amount of time allowed for connections to complete on proxy shutdown. On receiving SIGTERM or SIGINT, istio-agent tells the active Envoy to start gracefully draining, discouraging any new connections and allowing existing connections to complete. It then sleeps for the terminationDrainDuration and then kills any remaining active Envoy processes. If not set, a default of 5s will be applied.

The unique identifier for the service mesh All control planes running in the same service mesh should specify the same mesh ID. Mesh ID is used to label telemetry reports for cases where telemetry from multiple meshes is mixed together.

VM Health Checking readiness probe. This health check config exactly mirrors the kubernetes readiness probe configuration both in schema and logic. Only one health check method of 3 can be set at a time.

Proxy stats matcher defines configuration for reporting custom Envoy stats. To reduce memory and CPU overhead from Envoy stats system, Istio proxies by default create and expose only a subset of Envoy stats. This option is to control creation of additional Envoy stats with prefix, suffix, and regex expressions match on the name of the stats. This replaces the stats inclusion annotations (sidecar.istio.io/statsInclusionPrefixes, sidecar.istio.io/statsInclusionRegexps, and sidecar.istio.io/statsInclusionSuffixes). For example, to enable stats for circuit breakers, request retries, upstream connections, and request timeouts, you can specify stats matcher as follows:

proxyStatsMatcher:
  inclusionRegexps:
    - .*outlier_detection.*
    - .*upstream_rq_retry.*
    - .*upstream_cx_.*
  inclusionSuffixes:
    - upstream_rq_timeout

Note including more Envoy stats might increase number of time series collected by prometheus significantly. Care needs to be taken on Prometheus resource provision and configuration to reduce cardinality.

Boolean flag for enabling/disabling the holdApplicationUntilProxyStarts behavior. This feature adds hooks to delay application startup until the pod proxy is ready to accept traffic, mitigating some startup race conditions. Default value is ‘false’.

The PEM data of the extra root certificates for workload-to-workload communication. This includes the certificates defined in MeshConfig and any other certificates that Istiod uses as CA. The plugin certificates (the ‘cacerts’ secret), self-signed certificates (the ‘istio-ca-secret’ secret) are added automatically by Istiod.

Specifies the details of the proxy image.

Specifies the details of the Private Key Provider configuration for gateway and sidecar proxies.

Define the set of headers to add/modify for HTTP request/responses.

To enable an optional header, simply set the field. If no specific configuration is required, an empty object ({}) will enable it. Note: currently all headers are enabled by default.

Below shows an example of customizing the server header and disabling the X-Envoy-Attempt-Count header:

proxyHeaders:
  server:
    value: "my-custom-server"
  # Explicitly enable Request IDs.
  # As this is the default, this has no effect.
  requestId: {}
  attemptCount:
    disabled: true

Some headers are enabled by default, and require explicitly disabling. See below for an example of disabling all default-enabled headers:

proxyHeaders:
  forwardedClientCert: SANITIZE
  server:
    disabled: true
  requestId:
    disabled: true
  attemptCount:
    disabled: true
  envoyDebugHeaders:
    disabled: true
  metadataExchangeHeaders:
    mode: IN_MESH

Proxy stats name prefix matcher for inclusion.

Proxy stats name suffix matcher for inclusion.

Proxy stats name regexps matcher for inclusion.

Controls the X-Forwarded-Client-Cert header for inbound sidecar requests. To set this on gateways, use the Topology setting. To disable the header, configure either SANITIZE (to always remove the header, if present) or FORWARD_ONLY (to leave the header as-is). By default, APPEND_FORWARD will be used.

This field is valid only when forward_client_cert_details is APPEND_FORWARD or SANITIZE_SET and the client connection is mTLS. It specifies the fields in the client certificate to be forwarded. Note that Hash is always set, and By is always set when the client certificate presents the URI type Subject Alternative Name value.

Controls the X-Request-Id header. If enabled, a request ID is generated for each request if one is not already set. This applies to all types of traffic (inbound, outbound, and gateways). If disabled, no request ID will be generate for the request. If it is already present, it will be preserved. Warning: request IDs are a critical component to mesh tracing and logging, so disabling this is not recommended. This header is enabled by default if not configured.

Controls the server header. If enabled, the Server: istio-envoy header is set in response headers for inbound traffic (including gateways). If disabled, the Server header is not modified. If it is already present, it will be preserved.

Controls the X-Envoy-Attempt-Count header. If enabled, this header will be added on outbound request headers (including gateways) that have retries configured. If disabled, this header will not be set. If it is already present, it will be preserved. This header is enabled by default if not configured.

Controls various X-Envoy-* headers, such as X-Envoy-Overloaded and X-Envoy-Upstream-Service-Time. If enabled, these headers will be included. If disabled, these headers will not be set. If they are already present, they will be preserved. See the Envoy documentation for more details. These headers are enabled by default if not configured.

Controls Istio metadata exchange headers X-Envoy-Peer-Metadata and X-Envoy-Peer-Metadata-Id. By default, the behavior is unspecified. If IN_MESH, these headers will not be appended to outbound requests from sidecars to services not in-mesh.

If set, and the server header is enabled, this value will be set as the server header. By default, istio-envoy will be used.

Whether to forward the subject of the client cert. Defaults to true.

Whether to forward the entire client cert in URL encoded PEM format. This will appear in the XFCC header comma separated from other values with the value Cert=“PEM”. Defaults to false.

Whether to forward the entire client cert chain (including the leaf cert) in URL encoded PEM format. This will appear in the XFCC header comma separated from other values with the value Chain=“PEM”. Defaults to false.

Whether to forward the DNS type Subject Alternative Names of the client cert. Defaults to true.

Whether to forward the URI type Subject Alternative Name of the client cert. Defaults to true.

Address of a remove service used for various purposes (access log receiver, metrics receiver, etc.). Can be IP address or a fully qualified DNS name.

Use the tlsSettings to specify the tls mode to use. If the remote service uses Istio mutual TLS and shares the root CA with istiod, specify the TLS mode as ISTIO_MUTUAL.

If set then set SO_KEEPALIVE on the socket to enable TCP Keepalives.

The list of endpoints in the network (obtained through the constituent service registries or from CIDR ranges). All endpoints in the network are directly accessible to one another.

Set of gateways associated with the network.

The port associated with the gateway.

The locality associated with an explicitly specified gateway (i.e. ip)

The set of networks inside this mesh. Each network should have a unique name and information about how to infer the endpoints in the network as well as the gateways associated with the network.