mirror of https://github.com/status-im/consul.git
Remove underscores from gateway URL paths (#7962)
This commit is contained in:
Chris Piraino
GitHub
parent
db6f876b59
commit
6c444ba24c
|
|
@ -30,6 +30,9 @@
|
|||
/segmentation /mesh 301!
|
||||
/configuration.html / 301!
|
||||
/configuration / 301!
|
||||
/docs/connect/mesh_gateway /docs/connect/mesh-gateway 301!
|
||||
/docs/connect/ingress_gateway /docs/connect/ingress-gateway 301!
|
||||
/docs/connect/terminating_gateway /docs/connect/terminating-gateway 301!
|
||||
|
||||
# CLI renames
|
||||
|
||||
|
|
|
|||
|
|
@ -156,10 +156,10 @@ export default [
|
|||
category: 'proxies',
|
||||
content: ['envoy', 'built-in', 'integrate'],
|
||||
},
|
||||
'mesh_gateway',
|
||||
'mesh-gateway',
|
||||
'wan-federation-via-mesh-gateways',
|
||||
'ingress_gateway',
|
||||
'terminating_gateway',
|
||||
'ingress-gateway',
|
||||
'terminating-gateway',
|
||||
{
|
||||
category: 'registration',
|
||||
content: ['service-registration', 'sidecar-service'],
|
||||
|
|
|
|||
|
|
@ -514,9 +514,9 @@ service definition keys for compatibility with the config file format.
|
|||
- `Kind` `(string: "")` - The kind of service. Defaults to "" which is a
|
||||
typical Consul service. This value may also be "connect-proxy" for
|
||||
[Connect](/docs/connect) proxies representing another service,
|
||||
"mesh-gateway" for instances of a [mesh gateway](/docs/connect/mesh_gateway),
|
||||
"terminating-gateway" for instances of a [terminating gateway](/docs/connect/terminating_gateway),
|
||||
or "ingress-gateway" for instances of a [ingress gateway](/docs/connect/ingress_gateway).
|
||||
"mesh-gateway" for instances of a [mesh gateway](/docs/connect/mesh-gateway),
|
||||
"terminating-gateway" for instances of a [terminating gateway](/docs/connect/terminating-gateway),
|
||||
or "ingress-gateway" for instances of a [ingress gateway](/docs/connect/ingress-gateway).
|
||||
|
||||
- `Proxy` `(Proxy: nil)` - From 1.2.3 on, specifies the configuration for a
|
||||
Connect service proxy instance. This is only valid if `Kind` defines a proxy or gateway.
|
||||
|
|
|
|||
|
|
@ -90,7 +90,7 @@ The table below shows this endpoint's support for
|
|||
parameter.
|
||||
|
||||
- `OverrideMeshGateway` `(MeshGatewayConfig: <optional>)` - Overrides the final
|
||||
[mesh gateway configuration](/docs/connect/mesh_gateway#connect-proxy-configuration)
|
||||
[mesh gateway configuration](/docs/connect/mesh-gateway#connect-proxy-configuration)
|
||||
for this any service resolved in the compiled chain.
|
||||
|
||||
This value comes from either the [proxy
|
||||
|
|
|
|||
|
|
@ -13,13 +13,13 @@ description: >-
|
|||
|
||||
The `ingress-gateway` config entry kind allows you to configure ingress gateways
|
||||
with listeners that expose a set of services outside the Consul service mesh.
|
||||
See [Ingress Gateway](/docs/connect/ingress_gateway) for more information.
|
||||
See [Ingress Gateway](/docs/connect/ingress-gateway) for more information.
|
||||
|
||||
~> [Configuration entries](/docs/agent/config-entries) are global in scope. A configuration entry for a gateway name applies
|
||||
across all federated Consul datacenters. If ingress gateways in different Consul datacenters need to route to different
|
||||
sets of services within their datacenter then the ingress gateways **must** be registered with different names.
|
||||
|
||||
See [Ingress Gateway](/docs/connect/ingress_gateway) for more information.
|
||||
See [Ingress Gateway](/docs/connect/ingress-gateway) for more information.
|
||||
|
||||
## Wildcard service specification
|
||||
|
||||
|
|
|
|||
|
|
@ -55,7 +55,7 @@ config {
|
|||
- [Consul's built-in proxy](/docs/connect/proxies/built-in)
|
||||
|
||||
- `MeshGateway` `(MeshGatewayConfig: <optional>)` - Controls the default
|
||||
[mesh gateway configuration](/docs/connect/mesh_gateway#connect-proxy-configuration)
|
||||
[mesh gateway configuration](/docs/connect/mesh-gateway#connect-proxy-configuration)
|
||||
for all proxies. Added in v1.6.0.
|
||||
|
||||
- `Mode` `(string: "")` - One of `none`, `local`, or `remote`.
|
||||
|
|
|
|||
|
|
@ -38,7 +38,7 @@ Protocol = "http"
|
|||
entries for a service.
|
||||
|
||||
- `MeshGateway` `(MeshGatewayConfig: <optional>)` - Controls the default
|
||||
[mesh gateway configuration](/docs/connect/mesh_gateway#connect-proxy-configuration)
|
||||
[mesh gateway configuration](/docs/connect/mesh-gateway#connect-proxy-configuration)
|
||||
for this service. Added in v1.6.0.
|
||||
|
||||
- `Mode` `(string: "")` - One of `none`, `local`, or `remote`.
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ description: >-
|
|||
across all federated Consul datacenters. If ingress gateways in different Consul datacenters need to route to different
|
||||
sets of services within their datacenter then the ingress gateways **must** be registered with different names.
|
||||
|
||||
See [Terminating Gateway](/docs/connect/terminating_gateway) for more information.
|
||||
See [Terminating Gateway](/docs/connect/terminating-gateway) for more information.
|
||||
|
||||
## TLS Origination
|
||||
By specifying a path to a [CA file](/docs/agent/config-entries/terminating-gateway#cafile) connections
|
||||
|
|
|
|||
|
|
@ -264,7 +264,7 @@ To find ingress-enabled services:
|
|||
<service>.ingress.<domain>
|
||||
```
|
||||
|
||||
This will find all [ingress gateway](/docs/connect/ingress_gateway)
|
||||
This will find all [ingress gateway](/docs/connect/ingress-gateway)
|
||||
endpoints for the given `service`.
|
||||
|
||||
This endpoint currently only finds services within the same datacenter
|
||||
|
|
|
|||
|
|
@ -191,9 +191,9 @@ for the available configuration options.
|
|||
The `kind` field is used to optionally identify the service as a [Connect
|
||||
proxy](/docs/connect/proxies) instance. This value may be "connect-proxy" for
|
||||
[Connect-capable](/docs/connect) proxies representing another service,
|
||||
"mesh-gateway" for instances of a [mesh gateway](/docs/connect/mesh_gateway),
|
||||
"terminating-gateway" for instances of a [terminating gateway](/docs/connect/terminating_gateway),
|
||||
or "ingress-gateway" for instances of a [ingress gateway](/docs/connect/ingress_gateway).
|
||||
"mesh-gateway" for instances of a [mesh gateway](/docs/connect/mesh-gateway),
|
||||
"terminating-gateway" for instances of a [terminating gateway](/docs/connect/terminating-gateway),
|
||||
or "ingress-gateway" for instances of a [ingress gateway](/docs/connect/ingress-gateway).
|
||||
For typical non-proxy instances the `kind` field must be omitted. The `proxy` field
|
||||
is also required for Connect proxy registrations and is only valid if `kind` is
|
||||
`connect-proxy`. The only required `proxy` field for a `connect-proxy` is `destination_service_name`.
|
||||
|
|
|
|||
|
|
@ -39,7 +39,7 @@ Mesh gateways also require that your Consul datacenters are configured correctly
|
|||
- Your datacenters must be [WAN joined](https://learn.hashicorp.com/consul/security-networking/datacenters).
|
||||
- The [primary datacenter](/docs/agent/options#primary_datacenter) must be set to the same value in both datacenters. This specifies which datacenter is the authority for Connect certificates and is required for services in all datacenters to establish mutual TLS with each other.
|
||||
- [gRPC](/docs/agent/options#grpc_port) must be enabled.
|
||||
- If you want to [enable gateways globally](/docs/connect/mesh_gateway#enabling-gateways-globally) you must enable [centralized configuration](/docs/agent/options#enable_central_service_config).
|
||||
- If you want to [enable gateways globally](/docs/connect/mesh-gateway#enabling-gateways-globally) you must enable [centralized configuration](/docs/agent/options#enable_central_service_config).
|
||||
|
||||
Currently, Envoy is the only proxy with mesh gateway capabilities in Consul.
|
||||
|
||||
|
|
@ -28,7 +28,7 @@ defined as a their address. The service address registered with Consul, that the
|
|||
|
||||
~> We recommend that terminating gateways are not exposed to the WAN or open internet. This is because terminating gateways
|
||||
hold certificates to decrypt Consul Connect traffic directed at them and may be configured with credentials to connect
|
||||
to linked services. Connections over the WAN or open internet should flow through [mesh gateways](/docs/connect/mesh_gateway)
|
||||
to linked services. Connections over the WAN or open internet should flow through [mesh gateways](/docs/connect/mesh-gateway)
|
||||
whenever possible since they are not capable of decrypting traffic or connecting directly to services.
|
||||
|
||||
By specifying a path to a [CA file](/docs/agent/config-entries/terminating-gateway#cafile) connections
|
||||
|
|
@ -10,7 +10,7 @@ description: |-
|
|||
|
||||
-> **1.8.0+:** This feature is available in Consul versions 1.8.0 and higher
|
||||
|
||||
~> This topic requires familiarity with [mesh gateways](/docs/connect/mesh_gateway).
|
||||
~> This topic requires familiarity with [mesh gateways](/docs/connect/mesh-gateway).
|
||||
|
||||
WAN federation via mesh gateways allows for Consul servers in different datacenters
|
||||
to be federated exclusively through mesh gateways.
|
||||
|
|
@ -37,7 +37,7 @@ Sometimes this prerequisite is difficult or undesirable to meet:
|
|||
|
||||
Operators looking to simplify their WAN deployment and minimize the exposed
|
||||
security surface area can elect to join these datacenters together using [mesh
|
||||
gateways](/docs/connect/mesh_gateways.html) to do so.
|
||||
gateways](/docs/connect/mesh-gateways.html) to do so.
|
||||
|
||||
## Architecture
|
||||
|
||||
|
|
|
|||
|
|
@ -434,4 +434,4 @@ Kubernetes documentation](/docs/platform/k8s/helm)
|
|||
|
||||
Visit the Consul documentation for a full list of configurations for [Consul
|
||||
Connect](/docs/connect), including [mesh gateway
|
||||
configuration options](/docs/connect/mesh_gateway).
|
||||
configuration options](/docs/connect/mesh-gateway).
|
||||
|
|
|
|||
|
|
@ -216,7 +216,7 @@ A single node in the compiled discovery chain.
|
|||
be considered healthy.
|
||||
|
||||
- `MeshGateway` `(MeshGatewayConfig)` - The [mesh gateway
|
||||
configuration](/docs/connect/mesh_gateway#connect-proxy-configuration)
|
||||
configuration](/docs/connect/mesh-gateway#connect-proxy-configuration)
|
||||
to use when connecting to this target's service instances.
|
||||
|
||||
- `Mode` `(string: "")` - One of `none`, `local`, or `remote`.
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ description: >-
|
|||
|
||||
-> **1.8.0+:** This feature is available in Consul versions 1.8.0 and higher
|
||||
|
||||
~> This topic requires familiarity with [Mesh Gateways](/docs/connect/mesh_gateway) and [WAN Federation Via Mesh Gateways](/docs/connect/wan-federation-via-mesh-gateways).
|
||||
~> This topic requires familiarity with [Mesh Gateways](/docs/connect/mesh-gateway) and [WAN Federation Via Mesh Gateways](/docs/connect/wan-federation-via-mesh-gateways).
|
||||
|
||||
-> Looking for a step-by-step guide? Please follow our Learn Guide: [Secure and Route Service Mesh Communication Across Kubernetes](https://learn.hashicorp.com/consul/kubernetes/mesh-gateways).
|
||||
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ description: >-
|
|||
|
||||
-> **1.8.0+:** This feature is available in Consul versions 1.8.0 and higher
|
||||
|
||||
~> This topic requires familiarity with [Mesh Gateways](/docs/connect/mesh_gateway) and [WAN Federation Via Mesh Gateways](/docs/connect/wan-federation-via-mesh-gateways).
|
||||
~> This topic requires familiarity with [Mesh Gateways](/docs/connect/mesh-gateway) and [WAN Federation Via Mesh Gateways](/docs/connect/wan-federation-via-mesh-gateways).
|
||||
|
||||
Consul datacenters running on non-kubernetes platforms like VMs or bare metal can
|
||||
be federated with Kubernetes datacenters. Just like with Kubernetes, one datacenter
|
||||
|
|
|
|||
Loading…
Reference in New Issue