Global Mesh Options
Configuration affecting the service mesh as a whole.
MeshConfig
MeshConfig defines mesh-wide settings for the Istio service mesh.
ConfigSource
ConfigSource describes information about a configuration store inside a mesh. A single control plane instance can interact with one or more data sources.
MeshConfig.OutboundTrafficPolicy
MeshConfig.CertificateData
MeshConfig.CA
MeshConfig.ExtensionProvider
MeshConfig.DefaultProviders
Holds the name references to the providers that will be used by default in other Istio configuration resources if the provider is not specified.
These names must match a provider defined in extension_providers
that is
one of the supported tracing providers.
MeshConfig.ProxyPathNormalization
MeshConfig.TLSConfig
MeshConfig.ServiceSettings.Settings
Settings for the selected services.
MeshConfig.ExtensionProvider.EnvoyExternalAuthorizationRequestBody
MeshConfig.ExtensionProvider.EnvoyExternalAuthorizationHttpProvider
MeshConfig.ExtensionProvider.EnvoyExternalAuthorizationGrpcProvider
MeshConfig.ExtensionProvider.ZipkinTracingProvider
Defines configuration for a Zipkin tracer.
MeshConfig.ExtensionProvider.LightstepTracingProvider
Defines configuration for a Lightstep tracer. Note: Lightstep has moved to OpenTelemetry-based integrations. Istio 1.15+ will generate OpenTelemetry-compatible configuration when using this option.
MeshConfig.ExtensionProvider.DatadogTracingProvider
Defines configuration for a Datadog tracer.
MeshConfig.ExtensionProvider.SkyWalkingTracingProvider
Defines configuration for a SkyWalking tracer.
MeshConfig.ExtensionProvider.StackdriverProvider
Defines configuration for Stackdriver.
WARNING: Stackdriver tracing uses OpenCensus configuration under the hood and, as a result, cannot be used alongside any OpenCensus provider configuration. This is due to a limitation in the implementation of OpenCensus driver in Envoy.
MeshConfig.ExtensionProvider.OpenCensusAgentTracingProvider
Defines configuration for an OpenCensus tracer writing to an OpenCensus backend.
WARNING: OpenCensusAgentTracingProviders should be used with extreme care. Configuration of OpenCensus providers CANNOT be changed during the course of proxy’s lifetime due to a limitation in the implementation of OpenCensus driver in Envoy. This means only a single provider configuration may be used for OpenCensus at any given time for a proxy or group of proxies AND that any change to the provider configuration MUST be accompanied by a restart of all proxies that will use that configuration.
NOTE: Stackdriver tracing uses OpenCensus configuration under the hood and, as a result, cannot be used alongside OpenCensus provider configuration.
MeshConfig.ExtensionProvider.PrometheusMetricsProvider
MeshConfig.ExtensionProvider.EnvoyFileAccessLogProvider
Defines configuration for Envoy-based access logging that writes to local files (and/or standard streams).
MeshConfig.ExtensionProvider.EnvoyHttpGrpcV3LogProvider
Defines configuration for an Envoy Access Logging Service integration for HTTP traffic.
MeshConfig.ExtensionProvider.EnvoyTcpGrpcV3LogProvider
Defines configuration for an Envoy Access Logging Service integration for TCP traffic.
MeshConfig.ExtensionProvider.EnvoyOpenTelemetryLogProvider
Defines configuration for an Envoy OpenTelemetry (gRPC) Access Log
MeshConfig.ExtensionProvider.OpenTelemetryTracingProvider
Defines configuration for an OpenTelemetry tracing backend. Istio 1.16.1 or higher is needed.
MeshConfig.ExtensionProvider.StackdriverProvider.Logging
MeshConfig.ExtensionProvider.EnvoyFileAccessLogProvider.LogFormat
MeshConfig.ExtensionProvider.EnvoyOpenTelemetryLogProvider.LogFormat
k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector
A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects. +structType=atomic
Tracing
Tracing defines configuration for the tracing performed by Envoy instances.
Topology
Topology describes the configuration for relative location of a proxy with respect to intermediate trusted proxies and the client. These settings control how the client attributes are retrieved from the incoming traffic by the gateway proxy and propagated to the upstream services in the cluster.
PrivateKeyProvider
PrivateKeyProvider defines private key configuration for gateways and sidecars. This can be configured mesh wide or individual per-workload basis.
ProxyConfig
ProxyConfig defines variables for individual Envoy instances. This can be configured on a per-workload basis
as well as by the mesh-wide defaults.
To set the mesh wide defaults, configure the defaultConfig
section of meshConfig
. For example:
meshConfig:
defaultConfig:
discoveryAddress: istiod:15012
This can also be configured on a per-workload basis by configuring the proxy.istio.io/config
annotation on the pod. For example:
annotations:
proxy.istio.io/config: |
discoveryAddress: istiod:15012
If both are configured, the two are merged with per field semantics; the field set in annotation will fully replace the field from mesh config defaults.
This is different than a deep merge provided by protobuf.
For example, "tracing": { "sampling": 5 }
would completely override a setting configuring a tracing provider
such as "tracing": { "zipkin": { "address": "..." } }
.
Note: fields in ProxyConfig are not dynamically configured; changes will require restart of workloads to take effect.
RemoteService
Tracing.Zipkin
Zipkin defines configuration for a Zipkin tracer.
Tracing.Datadog
Datadog defines configuration for a Datadog tracer.
Tracing.Stackdriver
Stackdriver defines configuration for a Stackdriver tracer. See Envoy’s OpenCensus trace configuration and OpenCensus trace config for details.
Tracing.OpenCensusAgent
OpenCensusAgent defines configuration for an OpenCensus tracer writing to an OpenCensus agent backend. See Envoy’s OpenCensus trace configuration and OpenCensus trace config for details.
Topology.ProxyProtocolConfiguration
PROXY protocol configuration.
PrivateKeyProvider.CryptoMb
CryptoMb PrivateKeyProvider configuration
PrivateKeyProvider.QAT
QAT (QuickAssist Technology) PrivateKeyProvider configuration
ProxyConfig.ProxyStatsMatcher
Proxy stats name matchers for stats creation. Note this is in addition to the minimum Envoy stats that Istio generates by default.
ProxyConfig.ProxyHeaders
ProxyConfig.ProxyHeaders.Server
ProxyConfig.ProxyHeaders.RequestId
ProxyConfig.ProxyHeaders.AttemptCount
ProxyConfig.ProxyHeaders.EnvoyDebugHeaders
ProxyConfig.ProxyHeaders.MetadataExchangeHeaders
Network
Network provides information about the endpoints in a routable L3 network. A single routable L3 network can have one or more service registries. Note that the network has no relation to the locality of the endpoint. The endpoint locality will be obtained from the service registry.
MeshNetworks
MeshNetworks (config map) provides information about the set of networks inside a mesh and how to route to endpoints in each network. For example
MeshNetworks(file/config map):
networks:
network1:
endpoints:
- fromRegistry: registry1 #must match kubeconfig name in Kubernetes secret
- fromCidr: 192.168.100.0/22 #a VM network for example
gateways:
- registryServiceName: istio-ingressgateway.istio-system.svc.cluster.local
port: 15443
locality: us-east-1a
- address: 192.168.100.1
port: 15443
locality: us-east-1a
Network.NetworkEndpoints
NetworkEndpoints describes how the network associated with an endpoint should be inferred. An endpoint will be assigned to a network based on the following rules:
Implicitly: If the registry explicitly provides information about the network to which the endpoint belongs to. In some cases, its possible to indicate the network associated with the endpoint by adding the
ISTIO_META_NETWORK
environment variable to the sidecar.Explicitly:
a. By matching the registry name with one of the “fromRegistry” in the mesh config. A “from_registry” can only be assigned to a single network.
b. By matching the IP against one of the CIDR ranges in a mesh config network. The CIDR ranges must not overlap and be assigned to a single network.
(2) will override (1) if both are present.
Network.IstioNetworkGateway
The gateway associated with this network. Traffic from remote networks will arrive at the specified gateway:port. All incoming traffic must use mTLS.
MeshConfig.OutboundTrafficPolicy.Mode
Name | Description |
---|---|
REGISTRY_ONLY | outbound traffic will be restricted to services defined in the service registry as well as those defined through ServiceEntries |
ALLOW_ANY | outbound traffic to unknown destinations will be allowed, in case there are no services or ServiceEntries for the destination port |
MeshConfig.ExtensionProvider.OpenCensusAgentTracingProvider.TraceContext
TraceContext selects the context propagation headers used for distributed tracing.
Name | Description |
---|---|
W3C_TRACE_CONTEXT | Use W3C Trace Context propagation using the |
GRPC_BIN | Use gRPC binary context propagation using the |
CLOUD_TRACE_CONTEXT | Use Cloud Trace context propagation using the
|
B3 | Use multi-header B3 context propagation using the |
MeshConfig.ProxyPathNormalization.NormalizationType
Name | Description |
---|---|
DEFAULT | Apply default normalizations. Currently, this is BASE. |
NONE | No normalization, paths are used as is. |
BASE | Normalize according to RFC 3986.
For Envoy proxies, this is the |
MERGE_SLASHES | In addition to the |
DECODE_AND_MERGE_SLASHES | In addition to normalization in |
MeshConfig.TLSConfig.TLSProtocol
TLS protocol versions.
Name | Description |
---|---|
TLS_AUTO | Automatically choose the optimal TLS version. |
TLSV1_2 | TLS version 1.2 |
TLSV1_3 | TLS version 1.3 |
MeshConfig.IngressControllerMode
Name | Description |
---|---|
UNSPECIFIED | Unspecified Istio ingress controller. |
OFF | Disables Istio ingress controller. |
DEFAULT | Istio ingress controller will act on ingress resources that do not contain any annotation or whose annotations match the value specified in the ingress_class parameter described earlier. Use this mode if Istio ingress controller will be the default ingress controller for the entire Kubernetes cluster. |
STRICT | Istio ingress controller will only act on ingress resources whose annotations match the value specified in the ingress_class parameter described earlier. Use this mode if Istio ingress controller will be a secondary ingress controller (e.g., in addition to a cloud-provided ingress controller). |
MeshConfig.AccessLogEncoding
Name | Description |
---|---|
TEXT | text encoding for the proxy access log |
JSON | json encoding for the proxy access log |
MeshConfig.H2UpgradePolicy
Default Policy for upgrading http1.1 connections to http2.
Name | Description |
---|---|
DO_NOT_UPGRADE | Do not upgrade connections to http2. |
UPGRADE | Upgrade the connections to http2. |
Resource
Resource describes the source of configuration
Name | Description |
---|---|
SERVICE_REGISTRY | Set to only receive service entries that are generated by the platform. These auto generated service entries are combination of services and endpoints that are generated by a specific platform e.g. k8 |
Tracing.OpenCensusAgent.TraceContext
TraceContext selects the context propagation headers used for distributed tracing.
Name | Description |
---|---|
W3C_TRACE_CONTEXT | Use W3C Trace Context propagation using the |
GRPC_BIN | Use gRPC binary context propagation using the |
CLOUD_TRACE_CONTEXT | Use Cloud Trace context propagation using the
|
B3 | Use multi-header B3 context propagation using the |
ProxyConfig.ProxyHeaders.MetadataExchangeMode
Name | Description |
---|---|
UNDEFINED | Existing Istio behavior for the metadata exchange headers is unchanged. |
IN_MESH | Only append the istio metadata exchange headers for services considered in-mesh.
Traffic is considered in-mesh if it is secured with Istio mutual TLS. This means that |
ProxyConfig.TracingServiceName
Allows specification of various Istio-supported naming schemes for the
Envoy service_cluster
value. The servce_cluster
value is primarily used
by Envoys to provide service names for tracing spans.
Name | Description |
---|---|
APP_LABEL_AND_NAMESPACE | Default scheme. Uses the |
CANONICAL_NAME_ONLY | Uses the canonical name for a workload (excluding namespace). |
CANONICAL_NAME_AND_NAMESPACE | Uses the canonical name and namespace for a workload. |
ProxyConfig.InboundInterceptionMode
The mode used to redirect inbound traffic to Envoy.
This setting has no effect on outbound traffic: iptables REDIRECT
is always used for
outbound connections.
Name | Description |
---|---|
REDIRECT | The |
TPROXY | The |
NONE | The |
AuthenticationPolicy
AuthenticationPolicy defines how the proxy is authenticated when it connects to the control plane. It can be set for two different scopes, mesh-wide or set on a per-pod basis using the ProxyConfig annotation. Mesh policy cannot be INHERIT.
Name | Description |
---|---|
NONE | Do not encrypt proxy to control plane traffic. |
MUTUAL_TLS | Proxy to control plane traffic is wrapped into mutual TLS connections. |
INHERIT | Use the policy defined by the parent scope. Should not be used for mesh policy. |
ForwardClientCertDetails
ForwardClientCertDetails controls how the x-forwarded-client-cert (XFCC) header is handled by the gateway proxy. See Envoy XFCC header handling for more details.
Name | Description |
---|---|
UNDEFINED | Field is not set |
SANITIZE | Do not send the XFCC header to the next hop. This is the default value. |
FORWARD_ONLY | When the client connection is mTLS (Mutual TLS), forward the XFCC header in the request. |
APPEND_FORWARD | When the client connection is mTLS, append the client certificate information to the request’s XFCC header and forward it. |
SANITIZE_SET | When the client connection is mTLS, reset the XFCC header with the client certificate information and send it to the next hop. |
ALWAYS_FORWARD_ONLY | Always forward the XFCC header in the request, regardless of whether the client connection is mTLS. |