--- title: Global Mesh Options description: Configuration affecting the service mesh as a whole. location: https://istio.io/docs/reference/config/istio.mesh.v1alpha1.html layout: protoc-gen-docs generator: protoc-gen-docs weight: 20 number_of_entries: 44 ---
Configuration affecting the service mesh as a whole.
MeshConfig defines mesh-wide settings for the Istio service mesh.
ConfigSource describes information about a configuration store inside a mesh. A single control plane instance can interact with one or more data sources.
Certificate configures the provision of a certificate and its key. Example 1: key and cert stored in a secret
{ secretName: galley-cert
secretNamespace: istio-system
dnsNames:
- galley.istio-system.svc
- galley.mydomain.com
}
Example 2: key and cert stored in a directory
{ dnsNames:
- pilot.istio-system
- pilot.istio-system.svc
- pilot.mydomain.com
}
Holds the name references to the providers that will be used by default in other Istio configuration resources if the provider is not specified.
Settings for the selected services.
Defines configuration for a Zipkin tracer.
Defines configuration for a Lightstep tracer.
Defines configuration for a Datadog tracer.
Defines configuration for Stackdriver.
Defines configuration for an OpenCensus tracer writing to an OpenCensus backend.
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.
Tracing defines configuration for the tracing performed by Envoy instances.
SDS defines secret discovery service(SDS) configuration to be used by the proxy. For workload, its values are set in sidecar injector(passed as arguments to istio-proxy container). For pilot/mixer, it’s passed as arguments to istio-proxy container in pilot/mixer deployment yaml files directly.
ProxyConfig defines variables for individual Envoy instances.
Zipkin defines configuration for a Zipkin tracer.
Defines configuration for a Lightstep tracer.
Datadog defines configuration for a Datadog tracer.
Stackdriver defines configuration for a Stackdriver tracer. See Envoy’s OpenCensus trace configuration and OpenCensus trace config for details.
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.
Proxy stats name matchers for stats creation. Note this is in addition to the minimum Envoy stats that Istio generates by default.
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 (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
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.
The gateway associated with this network. Traffic from remote networks will arrive at the specified gateway:port. All incoming traffic must use mTLS.
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 |
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 |
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 |
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). |
Name | Description |
---|---|
TEXT |
text encoding for the proxy access log |
JSON |
json encoding for the proxy access log |
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 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 |
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 |
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 |
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. |