github
/
consul
mirror of https://github.com/hashicorp/consul
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

updated internal links

pull/17259/head
trujillo-adam 2023-05-08 16:28:22 -07:00
parent 1995a5f37d
commit 1f39bdf3f4
4 changed files with 24 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
website/content/api-docs/agent/service.mdx
View File

@ -630,12 +630,12 @@ The `/agent/service/register` endpoint supports camel case and _snake case_ for
- `Port` `(int: 0)` - Specifies the port of the service.
- `Kind` `(string: "")` - The kind of service. Defaults to "" which is a
typical Consul service. This value may also be "connect-proxy" for
[service mesh](/consul/docs/connect) proxies representing another service,
"mesh-gateway" for instances of a [mesh gateway](/consul/docs/connect/gateways/mesh-gateway#service-mesh-proxy-configuration),
"terminating-gateway" for instances of a [terminating gateway](/consul/docs/connect/gateways/terminating-gateway),
or "ingress-gateway" for instances of a [ingress gateway](/consul/docs/connect/gateways/ingress-gateway).
- `Kind` `(string: "")` - The kind of service. Defaults to `""`, which is a
typical Consul service. You can specify the following values:
- `"connect-proxy"` for [service mesh](/consul/docs/connect) proxies representing another service
- `"mesh-gateway"` for instances of a [mesh gateway](/consul/docs/connect/gateways/mesh-gateway#service-mesh-proxy-configuration)
- `"terminating-gateway"` for instances of a [terminating gateway](/consul/docs/connect/gateways/terminating-gateway)
- `"ingress-gateway"` for instances of a [ingress gateway](/consul/docs/connect/gateways/ingress-gateway)
- `Proxy` `(Proxy: nil)` - From 1.2.3 on, specifies the configuration for a
service mesh proxy instance. This is only valid if `Kind` defines a proxy or gateway.

8
website/content/commands/connect/envoy.mdx
View File

@ -169,11 +169,9 @@ compatibility with Envoy and prevent potential issues. Default is `false`.
If Envoy is configured as a terminating or mesh gateway, traffic from services
within the mesh will be received at the specified IP and port.
If Envoy is configured as an ingress gateway, a `/ready` HTTP endpoint will be
instantiated at the specified IP and port. Consul uses `/ready` HTTP endpoints
to check gateway health. The specified IP will also be used by the ingress
gateway when instantiating user-defined listeners configured in the
[ingress gateway](/consul/docs/connect/gateways/ingress-gateway) configuration entry.
If Envoy is configured as an ingress gateway, Consul instantiates a `/ready` HTTP endpoint at the specified IP and port. Consul uses `/ready` HTTP endpoints
to check gateway health. Ingress gateways also use the specified IP when instantiating user-defined listeners configured in the
[ingress gateway configuration entry](/consul/docs/connect/config-entries/ingress-gateway).
~> **Note**: Ensure that user-defined ingress gateway listeners use a
different port than the port specified in `-address` so that they do not

20
website/content/docs/connect/config-entries/ingress-gateway.mdx
View File

@ -549,7 +549,7 @@ Specifies a list of cipher suites that gateway listeners support when negotiatin
### `TSL.SDS`
Specifies parameters for loading the TLS certificates from an external SDS service. Refer to [Serve custom TLS certificates from an external service]() for additional information.
Specifies parameters for loading the TLS certificates from an external SDS service. Refer to [Serve custom TLS certificates from an external service](/consul/docs/connect/gateways/ingress-gateway/ingress-gateways-tls-external-service) for additional information.
Consul applies the SDS configuration specified in this field as defaults for all listeners defined in the gateway. You can override the SDS settings for per listener or per service defined in the listener. Refer to the following configurations for additional information:
@ -792,7 +792,7 @@ Specifies a TLS configuration for a specific service. The settings in this confi
### `Listeners[].Services[].TLS.SDS`
Specifies parameters that configure the listener to load TLS certificates from an external SDS. Refer to [Serve custom TLS certificates from an external service]() for additional information.
Specifies parameters that configure the listener to load TLS certificates from an external SDS. Refer to [Serve custom TLS certificates from an external service](/consul/docs/connect/gateways/ingress-gateway/ingress-gateways-tls-external-service) for additional information.
This configuration overrides the main [`TLS.SDS`](#tls-sds) settings for configuration entry. If unspecified, Consul applies the top-level [`TLS.SDS`](#tls-sds) settings.
@ -804,7 +804,7 @@ This configuration overrides the main [`TLS.SDS`](#tls-sds) settings for configu
- `ClusterName`
- `CertResource`
The following table describes how to configure SDS parameters. Refer to [Configure static SDS clusters]() for usage information:
The following table describes how to configure SDS parameters. Refer to [Configure static SDS clusters](/consul/docs/connect/gateways/ingress-gateway/ingress-gateways-tls-external-service#configure-static-sds-clusters) for usage information:
| Parameter | Description | Data type |
| `ClusterName` | Specifies the name of the SDS cluster where Consul should retrieve certificates. The cluster must be specified in the gateway's bootstrap configuration. | String |
@ -926,7 +926,7 @@ Specifies a list of cipher suites that the listener supports when negotiating co
### `Listeners[].TLS.SDS`
Specifies parameters for loading the TLS certificates from an external SDS service. Refer to [Serve custom TLS certificates from an external service]() for additional information.
Specifies parameters for loading the TLS certificates from an external SDS service. Refer to [Serve custom TLS certificates from an external service](/consul/docs/connect/gateways/ingress-gateway/ingress-gateways-tls-external-service) for additional information.
Consul applies the SDS configuration specified in this field to all services in the listener. You can override the `Listeners.TLS.SDS` configuration per service by configuring the [`Listeners.Services.TLS.SDS`](#listeners-services-tls-sds) settings for each service.
@ -935,7 +935,7 @@ Consul applies the SDS configuration specified in this field to all services in
- Default: None
- The data type is a map containing `ClusterName` and `CertResource` fields.
The following table describes how to configure SDS parameters. Refer to [Configure static SDS clusters]() for usage information:
The following table describes how to configure SDS parameters. Refer to [Configure static SDS clusters](/consul/docs/connect/gateways/ingress-gateway/ingress-gateways-tls-external-service#configure-static-sds-clusters) for usage information:
| Parameter | Description | Data type |
| --- | --- | --- |
@ -1068,7 +1068,7 @@ Specifies a list of cipher suites that gateway listeners support when negotiatin
### `spec.tls.sds`
Specifies parameters for loading the TLS certificates from an external SDS service. Refer to [Serve custom TLS certificates from an external service]() for additional information.
Specifies parameters for loading the TLS certificates from an external SDS service. Refer to [Serve custom TLS certificates from an external service](/consul/docs/connect/gateways/ingress-gateway/ingress-gateways-tls-external-service) for additional information.
Consul applies the SDS configuration specified in this field as defaults for all listeners defined in the gateway. You can override the SDS settings for per listener or per service defined in the listener. Refer to the following configurations for additional information:
@ -1317,7 +1317,7 @@ Specifies a TLS configuration for a specific service. The settings in this confi
### `spec.listeners[].services[].tls.sds`
Specifies parameters that configure the listener to load TLS certificates from an external SDS. Refer to [Serve custom TLS certificates from an external service]() for additional information.
Specifies parameters that configure the listener to load TLS certificates from an external SDS. Refer to [Serve custom TLS certificates from an external service](/consul/docs/connect/gateways/ingress-gateway/ingress-gateways-tls-external-service) for additional information.
If unspecified, Consul applies the [`sds`](#spec-tls-sds) settings configured for the ingress gateway. If both are specified, this configuration overrides the settings for configuration entry.
@ -1329,7 +1329,7 @@ If unspecified, Consul applies the [`sds`](#spec-tls-sds) settings configured fo
- `clusterName`
- `certResource`
The following table describes how to configure SDS parameters. Refer to [Serve custom TLS certificates from an external service]() for usage information:
The following table describes how to configure SDS parameters. Refer to [Serve custom TLS certificates from an external service](/consul/docs/connect/gateways/ingress-gateway/ingress-gateways-tls-external-service) for usage information:
| Parameter | Description | Data type |
| --- | --- | --- |
@ -1452,7 +1452,7 @@ Specifies a list of cipher suites that the listener supports when negotiating co
### `spec.listeners[].tls.sds`
Specifies parameters for loading the TLS certificates from an external SDS service. Refer to [Serve custom TLS certificates from an external service]() for additional information.
Specifies parameters for loading the TLS certificates from an external SDS service. Refer to [Serve custom TLS certificates from an external service](/consul/docs/connect/gateways/ingress-gateway/ingress-gateways-tls-external-service) for additional information.
Consul applies the SDS configuration specified in this field to all services in the listener. You can override the `spec.listeners[].tls.sds` configuration per service by configuring the [`spec.listeners.services.tls.sds`](#spec-listeners-services-tls-sds) settings for each service.
@ -1463,7 +1463,7 @@ Consul applies the SDS configuration specified in this field to all services in
- `clusterName`
- `certResource`
The following table describes how to configure SDS parameters. Refer to [Configure static SDS clusters]() for usage information:
The following table describes how to configure SDS parameters. Refer to [Configure static SDS clusters](/consul/docs/connect/gateways/ingress-gateway/ingress-gateways-tls-external-service#configure-static-sds-clusters) for usage information:
| Parameter | Description | Data type |
| --- | --- | --- |

7
website/content/docs/connect/gateways/ingress-gateway/ingress-gateways-usage.mdx
View File

@ -62,7 +62,7 @@ $ consul config write public-ingress.hcl
To deploy an ingress gateway service, create a service definition and register it with Consul.
You can also define an ingress gateway service and register it with Consul while starting an Envoy proxy from the command line. Refer to [ Register an ingress service on Envoy startup](#register-an-ingress-service-on-envoy-startup) for details.
You can also define an ingress gateway service and register it with Consul while starting an Envoy proxy from the command line. Refer to [Register an ingress service on Envoy startup](#register-an-ingress-service-on-envoy-startup) for details.
### Create a service definition for the ingress gateway
Consul applies the settings defined in the ingress gateway configuration entry to ingress gateway services that match the configuration entry name. Refer to [Define services](/consul/docs/services/usage/define-services) for additional information about defining services in Consul.
@ -92,6 +92,7 @@ The following example starts Envoy for the `ingress-service` gateway service:
```shell-session
$ consul connect envoy -gateway=ingress ingress-service'
```
### Register an ingress service on Envoy startup
You can also automatically register the ingress gateway service when starting the Envoy proxy. Specify the following flags with the `consul connect envoy` command:
@ -106,8 +107,10 @@ The following example starts Envoy and registers an ingress gateway service name
$ consul connect envoy -gateway=ingress -register -service ingress-service
-address '{{ GetInterfaceIP "eth0" }}:8888'
```
You cannot register the ingress gateway service and start the proxy at the same time if you configure the gateway to retrieve and serve TLS certificates from their external downstreams. Refer to [Serve custom TLS certificates from an external service]() for more information.
You cannot register the ingress gateway service and start the proxy at the same time if you configure the gateway to retrieve and serve TLS certificates from their external downstreams. Refer to [Serve custom TLS certificates from an external service](/consul/docs/connect/gateways/ingress-gateway/ingress-gateways-tls-external-service) for more information.
## Additional Envoy configurations
Ingress gateways support additional Envoy gateway options and escape-hatch overrides. Specify gateway options in the ingress gateway service definition to use them. To use escape-hatch overrides, you must add them to your global proxy defaults configuration entry. Refer to the following documentation for additional information:
- [Gateway options](/consul/docs/connect/proxies/envoy#gateway-options)