status-im
/
consul
mirror of https://github.com/status-im/consul.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: minor clarifiation to mesh gateway (#15373) 

* doc: minor clarifiation to mesh gateway

* update h1 title of mgw for wan fed control plan traffic
This commit is contained in:
cskh 2022-11-15 11:00:58 -05:00 committed by GitHub
parent f4c3e54b11
commit e0487281a8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
website/content/docs/connect/gateways/mesh-gateway/index.mdx
View File

@ -25,7 +25,7 @@ Mesh gateways can be used with any of the following Consul configrations for man
### Consul ### 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 ### Network
@ -209,6 +209,7 @@ service {
upstreams = [ upstreams = [
{ {
destination_name = "api" destination_name = "api"
destination_peer = "cluster-01"
local_bind_port = 10000 local_bind_port = 10000
mesh_gateway { mesh_gateway {
mode = "remote" mode = "remote"
@ -216,6 +217,7 @@ service {
}, },
{ {
destination_name = "db" destination_name = "db"
datacenter = "secondary"
local_bind_port = 10001 local_bind_port = 10001
mesh_gateway { mesh_gateway {
mode = "local" mode = "local"
@ -223,6 +225,7 @@ service {
}, },
{ {
destination_name = "logging" destination_name = "logging"
datacenter = "secondary"
local_bind_port = 10002 local_bind_port = 10002
mesh_gateway { mesh_gateway {
mode = "none" mode = "none"

2
website/content/docs/connect/gateways/mesh-gateway/peering-via-mesh-gateways.mdx
View File

@ -63,7 +63,7 @@ Peeering:
</CodeTabs> </CodeTabs>
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. 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. 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.

2
website/content/docs/connect/gateways/mesh-gateway/service-to-service-traffic-peers.mdx
View File

@ -7,7 +7,7 @@ description: >-
# Mesh Gateways between Peered Clusters # 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. 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). For Enterprise, this mesh gateway must also be registered in the same partition as the exported service(s).

2
website/content/docs/connect/gateways/mesh-gateway/wan-federation-via-mesh-gateways.mdx
View File

@ -1,6 +1,6 @@
--- ---
layout: docs layout: docs
page_title: Mesh Gateways for WAN Federation page_title: Mesh Gateways for WAN Federation Control Plane Traffic
description: >- 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. 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.
--- ---

4
website/data/docs-nav-data.json
View File

@ -471,7 +471,7 @@
"path": "connect/gateways/mesh-gateway" "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" "path": "connect/gateways/mesh-gateway/wan-federation-via-mesh-gateways"
}, },
{ {
@ -483,7 +483,7 @@
"path": "connect/gateways/mesh-gateway/service-to-service-traffic-partitions" "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" "path": "connect/gateways/mesh-gateway/peering-via-mesh-gateways"
}, },
{ {