A new platform for documentation and tutorials is launching soon.
We are migrating Consul documentation into HashiCorp Developer, our new developer experience.
»Mesh Gateways between Peered Clusters
Cluster peering is currently in beta: Functionality associated with cluster peering is subject to change. You should never use the beta release in secure environments or production scenarios. Features in beta may have performance issues, scaling issues, and limited support.
Mesh gateways are required for you to route service mesh traffic between different Consul clusters. Clusters can reside in different clouds or runtime environments where general interconnectivity between all services in all clusters is not feasible.
Unlike mesh gateways for datacenters and partitions, mesh gateways for cluster peering decrypt data to HTTP services within the mTLS session. Data must be decrypted in order to evaluate and apply dynamic routing rules at the destination cluster, which reduces coupling between peers.
To configure mesh gateways for cluster peering, make sure your Consul environment meets the following requirements:
- Consul version 1.13.0 or newer.
- A local Consul agent is required to manage mesh gateway configuration.
- Enable Consul service mesh in all clusters.
peeringon all Consul servers.
- Use Envoy proxies. Envoy is the only proxy with mesh gateway capabilities in Consul.
Configure the following settings to register and use the mesh gateway as a service in Consul.
kindfield to register the gateway with Consul.
- Define the
Proxy.Configsettings using opaque parameters compatible with your proxy. For Envoy, refer to the Gateway Options and Escape-hatch Overrides documentation for additional configuration information.
Alternatively, you can also use the CLI to spin up and register a gateway in Consul. For additional information, refer to the
consul connect envoy command.
- Configure the
proxy.upstreamsparameters to route traffic to the correct service, namespace, and peer. Refer to the
upstreamsdocumentation for details.
- The service
proxy.upstreams.destination_nameis always required.
proxy.upstreams.destination_peermust be configured to enable cross-cluster traffic.
proxy.upstream/destination_namespaceconfiguration is only necessary if the destination service is in a non-default namespace.
- Include the
exported-servicesconfiguration entry to enable Consul to export services contained in a cluster to one or more additional clusters. For additional information, refer to the Exported Services documentation.
- If ACLs are enabled, you must add a token granting
service:writefor the gateway's service name and
service:readfor all services in the Enterprise admin partition or OSS datacenter to the gateway's service definition. These permissions authorize the token to route communications for other Consul service mesh services.
Modes are not configurable for mesh gateways that connect peered clusters. By default, all proxies connecting to peered clusters use mesh gateways in remote mode.