Mesh Beta

v1.10.0+: This config entry is supported in Consul versions 1.10.0+.

The mesh config entry kind allows for globally defining default configuration that applies to all service mesh proxies. Settings in this config entry apply across all namespaces and federated datacenters.

Sample Config Entries

Mesh Destinations Only

Only allow transparent proxies to dial addresses in the mesh.

Kind = "mesh"
TransparentProxy {
  MeshDestinationsOnly = true
}

Note: The mesh config entry can only be created in the default namespace and it will apply to proxies across all namespaces.

Kind      = "mesh"
Namespace = "default" # Can only be set to "default".

TransparentProxy {
  MeshDestinationsOnly = true
}

Available Fields

Kind - Must be set to mesh
Namespace (string: "default")Enterprise - Must be set to default. Config will apply to all namespaces.
Meta (map<string|string>: nil) - Specifies arbitrary KV metadata pairs. Added in Consul 1.8.4.
TransparentProxy (TransparentProxyConfig: <optional>) - Controls configuration specific to proxies in transparent mode. Added in v1.10.0.
- MeshDestinationsOnly (bool: false) - Determines whether sidecar proxies operating in transparent mode can proxy traffic to IP addresses not registered in Consul's mesh. If enabled, traffic will only be proxied to upstream proxies or Connect-native services. If disabled, requests will be proxied as-is to the original destination IP address. Consul will not encrypt the connection.

apiVersion - Must be set to consul.hashicorp.com/v1alpha1
kind - Must be set to Mesh
metadata
- name - Must be set to mesh
- namespace - If running Consul Open Source, the namespace is ignored (see Kubernetes Namespaces in Consul OSS). If running Consul Enterprise see Kubernetes Namespaces in Consul Enterprise for more details.
spec
- transparentProxy (TransparentProxyConfig: <optional>) - Controls configuration specific to proxies in transparent mode. Added in v1.10.0.
  - meshDestinationsOnly (bool: false) - Determines whether sidecar proxies operating in transparent mode can proxy traffic to IP addresses not registered in Consul's mesh. If enabled, traffic will only be proxied to upstream proxies or Connect-native services. If disabled, requests will be proxied as-is to the original destination IP address. Consul will not encrypt the connection.

ACLs

Configuration entries may be protected by ACLs.

Reading a mesh config entry requires no specific privileges.

Creating, updating, or deleting a mesh config entry requires operator:write.