Skip to content

Commit

Permalink
Mesh Gateway doc enhancements (#11354)
Browse files Browse the repository at this point in the history
* Mesh Gateway doc enhancements

1. I believe this line should be corrected to add mesh as one of the choices
2. I found that we are not setting this meta, and it is a required element for wan federation. I believe it would be helpful and potentially time saving to note that right here.
  • Loading branch information
assareh authored Dec 20, 2021
1 parent 649f1ab commit 20bbdba
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion website/content/docs/job-specification/gateway.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,11 @@ envoy_gateway_bind_addresses "<service>" {

### `mesh` Parameters

The `mesh` block currently does not have any configurable parameters.
The `mesh` block currently does not have any configurable parameters.

~> **Note:** If using the Mesh Gateway for [WAN Federation][connect_mesh_gw],
the additional piece of service metadata `{"consul-wan-federation":"1"}` must
be applied. This can be done with the service [`meta`][meta] parameter.

### Gateway with host networking

Expand Down Expand Up @@ -630,6 +634,7 @@ job "countdash-mesh-two" {
[address]: /docs/job-specification/gateway#address-parameters
[advanced configuration]: https://www.consul.io/docs/connect/proxies/envoy#advanced-configuration
[connect_timeout_ms]: https://www.consul.io/docs/agent/config-entries/service-resolver#connecttimeout
[connect_mesh_gw]: https://www.consul.io/docs/connect/gateways/mesh-gateway/wan-federation-via-mesh-gateways#mesh-gateways
[envoy docker]: https://hub.docker.com/r/envoyproxy/envoy/tags
[ingress]: /docs/job-specification/gateway#ingress-parameters
[proxy]: /docs/job-specification/gateway#proxy-parameters
Expand All @@ -641,3 +646,4 @@ job "countdash-mesh-two" {
[terminating]: /docs/job-specification/gateway#terminating-parameters
[tls]: /docs/job-specification/gateway#tls-parameters
[mesh]: /docs/job-specification/gateway#mesh-parameters
[meta]: /docs/job-specification/service#meta

0 comments on commit 20bbdba

Please sign in to comment.