From bbe14724c6a78d4ee7889995314e3bec6e0a6ae7 Mon Sep 17 00:00:00 2001 From: hc-github-team-consul-core Date: Tue, 15 Nov 2022 11:01:31 -0500 Subject: [PATCH] Backport of docs: minor clarifiation to mesh gateway into release/1.14.x (#15377) This pull request was automerged via backport-assistant --- website/content/docs/connect/gateways/mesh-gateway/index.mdx | 5 ++++- .../gateways/mesh-gateway/peering-via-mesh-gateways.mdx | 2 +- .../mesh-gateway/service-to-service-traffic-peers.mdx | 2 +- .../mesh-gateway/wan-federation-via-mesh-gateways.mdx | 2 +- website/data/docs-nav-data.json | 4 ++-- 5 files changed, 9 insertions(+), 6 deletions(-) diff --git a/website/content/docs/connect/gateways/mesh-gateway/index.mdx b/website/content/docs/connect/gateways/mesh-gateway/index.mdx index 27cb9ab031..206f724e8e 100644 --- a/website/content/docs/connect/gateways/mesh-gateway/index.mdx +++ b/website/content/docs/connect/gateways/mesh-gateway/index.mdx @@ -25,7 +25,7 @@ Mesh gateways can be used with any of the following Consul configrations for man ### Consul -Review the [specific guide](#prerequisites) for your use case to determined the required version of Consul. +Review the [specific guide](#prerequisites) for your use case to determine the required version of Consul. ### Network @@ -209,6 +209,7 @@ service { upstreams = [ { destination_name = "api" + destination_peer = "cluster-01" local_bind_port = 10000 mesh_gateway { mode = "remote" @@ -216,6 +217,7 @@ service { }, { destination_name = "db" + datacenter = "secondary" local_bind_port = 10001 mesh_gateway { mode = "local" @@ -223,6 +225,7 @@ service { }, { destination_name = "logging" + datacenter = "secondary" local_bind_port = 10002 mesh_gateway { mode = "none" diff --git a/website/content/docs/connect/gateways/mesh-gateway/peering-via-mesh-gateways.mdx b/website/content/docs/connect/gateways/mesh-gateway/peering-via-mesh-gateways.mdx index 40374c980c..4b6f05d870 100644 --- a/website/content/docs/connect/gateways/mesh-gateway/peering-via-mesh-gateways.mdx +++ b/website/content/docs/connect/gateways/mesh-gateway/peering-via-mesh-gateways.mdx @@ -63,7 +63,7 @@ Peeering: By setting this mesh config on a cluster before [creating a peering token](/docs/connect/cluster-peering/create-manage-peering#create-a-peering-token), inbound control plane traffic will be sent through the mesh gateway registered this cluster, also known the accepting cluster. -As mesh gateway instances register and leave the accepting cluster, their addresses will be exposed to the dialing cluster over the bi-directional peering stream. +As mesh gateway instances are registered at the accepting cluster, their addresses will be exposed to the dialing cluster over the bi-directional peering stream. Setting this mesh config on a cluster before [establishing a connection](/docs/connect/cluster-peering/create-manage-peering#establish-a-connection-between-clusters) will cause the outbound control plane traffic to flow through the mesh gateway. diff --git a/website/content/docs/connect/gateways/mesh-gateway/service-to-service-traffic-peers.mdx b/website/content/docs/connect/gateways/mesh-gateway/service-to-service-traffic-peers.mdx index 15baabafd6..207c8c0e72 100644 --- a/website/content/docs/connect/gateways/mesh-gateway/service-to-service-traffic-peers.mdx +++ b/website/content/docs/connect/gateways/mesh-gateway/service-to-service-traffic-peers.mdx @@ -7,7 +7,7 @@ description: >- # Mesh Gateways between Peered Clusters -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. +Mesh gateways are required for you to route service mesh traffic between peered Consul clusters. Clusters can reside in different clouds or runtime environments where general interconnectivity between all services in all clusters is not feasible. At a minimum, a peered cluster exporting a service must have a mesh gateway registered. For Enterprise, this mesh gateway must also be registered in the same partition as the exported service(s). diff --git a/website/content/docs/connect/gateways/mesh-gateway/wan-federation-via-mesh-gateways.mdx b/website/content/docs/connect/gateways/mesh-gateway/wan-federation-via-mesh-gateways.mdx index 24316c6e50..1fd4b0cba2 100644 --- a/website/content/docs/connect/gateways/mesh-gateway/wan-federation-via-mesh-gateways.mdx +++ b/website/content/docs/connect/gateways/mesh-gateway/wan-federation-via-mesh-gateways.mdx @@ -1,6 +1,6 @@ --- layout: docs -page_title: Mesh Gateways for WAN Federation +page_title: Mesh Gateways for WAN Federation Control Plane Traffic description: >- You can use mesh gateways to simplify the networking requirements for WAN federated Consul datacenters. Mesh gateways reduce cross-datacenter connection paths, ports, and communication protocols. --- diff --git a/website/data/docs-nav-data.json b/website/data/docs-nav-data.json index df8ff722ea..0f8cd54493 100644 --- a/website/data/docs-nav-data.json +++ b/website/data/docs-nav-data.json @@ -471,7 +471,7 @@ "path": "connect/gateways/mesh-gateway" }, { - "title": "WAN Federation", + "title": "Enabling WAN Federation Control Plane Traffic", "path": "connect/gateways/mesh-gateway/wan-federation-via-mesh-gateways" }, { @@ -483,7 +483,7 @@ "path": "connect/gateways/mesh-gateway/service-to-service-traffic-partitions" }, { - "title": "Cluster Peering", + "title": "Enabling Peering Control Plane Traffic", "path": "connect/gateways/mesh-gateway/peering-via-mesh-gateways" }, {