Ingress Gateways

1.8.0+: This feature is available in Consul versions 1.8.0 and newer.

Ingress gateways enable connectivity within your organizational network from services outside the Consul service mesh to services in the mesh. An ingress gateway is a type of proxy and must be registered as a service in Consul, with the kind set to “ingress-gateway”. They are an entrypoint for outside traffic and allow you to define what services should be exposed and on what port. You configure an ingress gateway by defining a set of listeners that each map to a set of backing services.

To enable easier service discovery, a new Consul DNS subdomain is provided, on <service>.ingress.<domain>.

For listeners with a protocol other than tcp, multiple services can be specified for a single listener. In this case, the ingress gateway relies on host/authority headers to decide the service that should receive the traffic. The host used to match traffic defaults to the Consul DNS ingress subdomain, but can be changed using the hosts field.

Ingress Gateway Architecture

Prerequisites

Ingress gateways also require that your Consul datacenters are configured correctly:

  • You’ll need to use Consul version 1.8.0 or newer.
  • Consul Connect must be enabled on the datacenter’s Consul servers.
  • gRPC must be enabled on all client agents.

Currently, Envoy is the only proxy with ingress gateway capabilities in Consul.

Running and Using an Ingress Gateway

For a complete example of how to allow external traffic inside your Consul service mesh, review the ingress gateway tutorial.

Ingress Gateway Configuration

Ingress gateways are configured in service definitions and registered with Consul like other services, with two exceptions. The first is that the kind must be “ingress-gateway”. Second, the ingress gateway service definition may contain a Proxy.Config entry just like a Connect proxy service, to define opaque configuration parameters useful for the actual proxy software. For Envoy there are some supported gateway options as well as escape-hatch overrides.

Note: If ACLs are enabled, ingress gateways must be registered with a token granting service:write for the ingress gateway’s service name, service:read for all services in the ingress gateway’s configuration entry, and node:read for all nodes of the services in the ingress gateway’s configuration entry. These privileges authorize the token to route communications to other Connect services. If the Consul client agent on the gateway’s node is not configured to use the default gRPC port, 8502, then the gateway’s token must also provide agent:read for its node’s name in order to discover the agent’s gRPC port. gRPC is used to expose Envoy’s xDS API to Envoy proxies.

Configuration 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.

Custom TLS Certificates via Secret Discovery Service (SDS)

Advanced Topic: This topic describes a low-level feature designed for developers building integrations with custom TLS management solutions.

Consul 1.11 added support for ingress gateways to serve TLS certificates to inbound traffic that are sourced from an external service. The external service must implement Envoy’s gRPC Secret Discovery Service (or SDS) API.

The following procedure describes how to configure an ingress gateway with TLS certificates from an SDS source. The instructions assume that you are familiar with Envoy configuration and the SDS protocol.

Configure Static SDS Cluster(s)

Each Envoy proxy that makes up this Ingress Gateway must define one or more additional static clusters when registering. These additional clusters define how Envoy should connect to the required SDS service(s). Defining extra clusters in Envoy’s bootstrap configuration requires a manual registration of the Ingress Gateway with Consul proxy. It’s not possible to use the -register flag with consul connect envoy -gateway=ingress to automatically register the proxy in this case.

The cluster(s) must provide connection information and any necessary authentication information such as mTLS credentials.

The following example will demonstrate how to use:

  • A DNS name to discover the SDS service addresses
  • Local certificate files for TLS client authentication with the SDS server. The certificates are assumed to be created and managed by some other process.

  1. Register the proxy service.

    The following Proxy Service Definition defines the additional cluster configuration that will be provided to Envoy when it starts. With this TLS configuration, Envoy will detect changes to the certificate and key files on disk so an external process may maintain and rotate them without needing an Envoy restart.

    1. // public-ingress.hcl
    2. Services {
    3.   Name = "public-ingress"
    4.   Kind = "ingress-gateway"
    6.   Proxy {
    7.     Config {
    8.       envoy_extra_static_clusters_json = <<EOF
    9. {
    10.   "name": "sds-cluster",
    11.   "connect_timeout": "5s",
    12.   "http2_protocol_options": {},
    13.   "type": "LOGICAL_DNS",
    14.   "transport_socket": {
    15.     "name":"tls",
    16.     "typed_config": {
    17.       "@type":"type.googleapis.com/envoy.extensions.transport_sockets.tls.v3.UpstreamTlsContext",
    18.       "common_tls_context":{
    19.         "tls_certificate_sds_secret_configs": [
    20.           {
    21.             "name":"tls_sds",
    22.             "sds_config":{
    23.               "path":"/certs/sds-auth-cert.json"
    24.             }
    25.           }
    26.         ],
    27.         "validation_context_sds_secret_config": {
    28.           "name":"validation_context_sds",
    29.           "sds_config":{
    30.               "path":"/certs/sds-validation.json"
    31.           }
    32.         }
    33.       }
    34.     }
    35.   },
    36.   "load_assignment": {
    37.     "cluster_name": "sds-cluster",
    38.     "endpoints": [
    39.       {
    40.         "lb_endpoints": [
    41.           {
    42.             "endpoint": {
    43.               "address": {
    44.                 "socket_address": {
    45.                   "address": "sds-server.svc.cluster.local",
    46.                   "port_value": 8080,
    47.                 }
    48.               }
    49.             }
    50.           }
    51.         ]
    52.       }
    53.     ]
    54.   }
    55. }
    56. EOF
    57.     }
    58.   }
    59. }
    1. // public-ingress.hcl
    2. Services {
    3.   Name = "public-ingress"
    4.   Kind = "ingress-gateway"
    6.   Proxy {
    7.     Config {
    8.       envoy_extra_static_clusters_json = <<EOF
    9. {
    10.   "name": "sds-cluster",
    11.   "connect_timeout": "5s",
    12.   "http2_protocol_options": {},
    13.   "type": "LOGICAL_DNS",
    14.   "transport_socket": {
    15.     "name":"tls",
    16.     "typed_config": {
    17.       "@type":"type.googleapis.com/envoy.extensions.transport_sockets.tls.v3.UpstreamTlsContext",
    18.       "common_tls_context":{
    19.         "tls_certificate_sds_secret_configs": [
    20.           {
    21.             "name":"tls_sds",
    22.             "sds_config":{
    23.               "path":"/certs/sds-auth-cert.json"
    24.             }
    25.           }
    26.         ],
    27.         "validation_context_sds_secret_config": {
    28.           "name":"validation_context_sds",
    29.           "sds_config":{
    30.               "path":"/certs/sds-validation.json"
    31.           }
    32.         }
    33.       }
    34.     }
    35.   },
    36.   "load_assignment": {
    37.     "cluster_name": "sds-cluster",
    38.     "endpoints": [
    39.       {
    40.         "lb_endpoints": [
    41.           {
    42.             "endpoint": {
    43.               "address": {
    44.                 "socket_address": {
    45.                   "address": "sds-server.svc.cluster.local",
    46.                   "port_value": 8080,
    47.                 }
    48.               }
    49.             }
    50.           }
    51.         ]
    52.       }
    53.     ]
    54.   }
    55. }
    56. EOF
    57.     }
    58.   }
    59. }

  2. Issue the following command to create the registration.

    1. consul services register public-ingress.hcl
    1. consul services register public-ingress.hcl

    The command must be executed against the Consul agent on the Envoy proxy’s node.

Setup TLS Client Authentication for SDS

Configuration files similar to the following examples must be available on the disk where the Envoy proxy will run. The actual certificates and keys referenced in the configuration files must also be present.

  1. Configure TLS client authentication for SDS.

    The certificates and keys must be saved to the same disk where the Envoy proxy will run. The following example files reference the PEM-encoded certificate and key files to be used for TLS Client Authentication with the SDS service (sds-client-auth.{crt,key}) and the certificate authority certificate used to validate the SDS server’s TLS credentials (sds-ca.crt).

    Refer to [Envoy’s documentation] https://www.envoyproxy.io/docs/envoy/latest/api-v3/bootstrap/bootstrap) for more details on this configuration and other possible authentication options.

    1. // /certs/sds-auth-cert.json
    2. {
    3.   "resources": [
    4.     {
    5.       "@type": "type.googleapis.com/envoy.extensions.transport_sockets.tls.v3.Secret",
    6.       "name": "tls_sds",
    7.       "tls_certificate": {
    8.         "certificate_chain": {
    9.           "filename": "/certs/sds-client-auth.crt"
    10.         },
    11.         "private_key": {
    12.           "filename": "/certs/sds-client-auth.key"
    13.         }
    14.       }
    15.     }
    16.   ]
    17. }
    1. // /certs/sds-auth-cert.json
    2. {
    3.   "resources": [
    4.     {
    5.       "@type": "type.googleapis.com/envoy.extensions.transport_sockets.tls.v3.Secret",
    6.       "name": "tls_sds",
    7.       "tls_certificate": {
    8.         "certificate_chain": {
    9.           "filename": "/certs/sds-client-auth.crt"
    10.         },
    11.         "private_key": {
    12.           "filename": "/certs/sds-client-auth.key"
    13.         }
    14.       }
    15.     }
    16.   ]
    17. }
    1. // /certs/sds-validation.json
    2. {
    3.   "resources": [
    4.     {
    5.       "@type": "type.googleapis.com/envoy.extensions.transport_sockets.tls.v3.Secret",
    6.       "name": "validation_context_sds",
    7.       "validation_context": {
    8.         "trusted_ca": {
    9.           "filename": "/certs/sds-ca.crt"
    10.         }
    11.       }
    12.     }
    13.   ]
    14. }
    1. // /certs/sds-validation.json
    2. {
    3.   "resources": [
    4.     {
    5.       "@type": "type.googleapis.com/envoy.extensions.transport_sockets.tls.v3.Secret",
    6.       "name": "validation_context_sds",
    7.       "validation_context": {
    8.         "trusted_ca": {
    9.           "filename": "/certs/sds-ca.crt"
    10.         }
    11.       }
    12.     }
    13.   ]
    14. }

  2. Issue the following command to start Envoy.

    1. $ consul connect envoy -gateway=ingress -service public-ingress
    1. $ consul connect envoy -gateway=ingress -service public-ingress

Configure the Ingress Gateway to Use Certificates from SDS

SDS certificates may now be configured in the ingress-gateway Config Entry.

The following example shows a single default certificate and key being used for all listeners.

  1. // public-ingress-cfg.hcl
  2. Kind = "ingress-gateway"
  3. Name = "public-ingress"
  5. TLS {
  6.   SDS {
  7.     # This must match the name of the static cluster from step #1
  8.     ClusterName = "sds-cluster"
  9.     # This is the name of the certificate resource to load.
  10.     CertResource = "example.com-public-cert"
  11.   }
  12. }
  14. Listeners = [
  15.   {
  16.     Port = 8443
  17.     Protocol = "http"
  18.     Services = ["*"]
  19.   }
  20. ]
  1. // public-ingress-cfg.hcl
  2. Kind = "ingress-gateway"
  3. Name = "public-ingress"
  5. TLS {
  6.   SDS {
  7.     # This must match the name of the static cluster from step #1
  8.     ClusterName = "sds-cluster"
  9.     # This is the name of the certificate resource to load.
  10.     CertResource = "example.com-public-cert"
  11.   }
  12. }
  14. Listeners = [
  15.   {
  16.     Port = 8443
  17.     Protocol = "http"
  18.     Services = ["*"]
  19.   }
  20. ]

  1. Run consul config write public-ingress-cfg.hcl to write this configuration.

    The Envoy instance will now start a listener on port 8443 and attempt to fetch the TLS certificate named from the SDS server.

Separate certificates may be loaded per listener or per-service with hostname (SNI) switching. See the Config Entry reference for more details.