Connect Service Mesh on Kubernetes

    The Connect sidecar running Envoy can be automatically injected into pods in your cluster, making configuration for Kubernetes automatic. This functionality is provided by the consul-k8s project and can be automatically installed and configured using the .

    When the Connect injector is installed, the Connect sidecar can be automatically added to all pods. This sidecar can both accept and establish connections using Connect, enabling the pod to communicate to clients and dependencies exclusively over authorized and encrypted connections.

    Note: The examples in this section are valid and use publicly available images. If you’ve installed the Connect injector, feel free to run the examples in this section to try Connect with Kubernetes. Please note the documentation below this section on how to properly install and configure the Connect injector.

    An example Deployment is shown below with Connect enabled to accept inbound connections. Notice that the Deployment would still be fully functional without Connect. Minimal to zero modifications are required to enable Connect in Kubernetes. Notice also that even though we’re using a Deployment here, the same configuration would work on a Pod, a StatefulSet, or a DaemonSet.

    This Deployment specification starts a server that responds to any HTTP request with the static text “hello world”.

    Note: As of consul-k8s and Consul Helm v0.32.0-beta1, having a Kubernetes service is required to run services on the Consul Service Mesh.

    The only change for Connect is the addition of the consul.hashicorp.com/connect-inject annotation. This enables injection for the Pod in this Deployment. The injector can also be to automatically inject unless explicitly disabled, but the default installation requires opt-in using the annotation shown above.

    A common mistake is to set the annotation on the Deployment or other resource. Ensure that the injector annotations are specified on the pod specification template as shown above.

    This will start a sidecar proxy that listens on port 20000 registered with Consul and proxies valid inbound connections to port 8080 in the pod. To establish a connection to the pod using Connect, a client must use another Connect proxy. The client Connect proxy will use Consul service discovery to find all available upstream proxies and their public ports.

    In the example above, the server is listening on :8080. By default, the Consul Service Mesh runs in transparent proxy mode. This means that even though the server binds to all interfaces, the inbound and outbound connections will automatically go through to the sidecar proxy. It also allows you to use Kubernetes DNS like you normally would without the Consul Service Mesh.

    Note: As of consul v1.10.0, consul-k8s v0.26.0 and Consul Helm v0.32.0, all Consul Service Mesh services will run with transparent proxy enabled by default. Running with transparent proxy will enforce all inbound and outbound traffic to go through the Envoy proxy.

    The service name registered in Consul will be set to the name of the Kubernetes service associated with the Pod. This can be customized with the consul.hashicorp.com/connect-service annotation. If using ACLs, this name must be the same as the Pod’s ServiceAccount name.

    Connecting to Connect-Enabled Services

    The example Deployment specification below configures a Deployment that is capable of establishing connections to our previous example “static-server” service. The connection to this static text service happens over an authorized and encrypted connection via Connect.

    Note: As of consul-k8s v0.26.0 and Consul Helm v0.32.0, having a Kubernetes Service is required to run services on the Consul Service Mesh.

    1. apiVersion: v1
    2. kind: Service
    3. metadata:
    4.   # This name will be the service name in Consul.
    5.   name: static-client
    6. spec:
    7.   selector:
    8.     app: static-client
    9.   ports:
    10.     - port: 80
    11. ---
    12. apiVersion: v1
    13. kind: ServiceAccount
    14. metadata:
    15.   name: static-client
    16. ---
    17. apiVersion: apps/v1
    18. kind: Deployment
    19. metadata:
    20.   name: static-client
    21. spec:
    22.   replicas: 1
    23.   selector:
    24.     matchLabels:
    25.       app: static-client
    26.   template:
    27.     metadata:
    28.       name: static-client
    29.       labels:
    30.         app: static-client
    31.       annotations:
    32.         'consul.hashicorp.com/connect-inject': 'true'
    33.     spec:
    34.       containers:
    35.         - name: static-client
    36.           # Just spin & wait forever, we'll use `kubectl exec` to demo
    38.           args: ['while true; do sleep 30; done;']
    39.       # If ACLs are enabled, the serviceAccountName must match the Consul service name.
    40.       serviceAccountName: static-client

    By default when ACLs are enabled or when ACLs default policy is allow, Consul will automatically configure proxies with all upstreams from the same datacenter. When ACLs are enabled with default deny policy, you must supply an intention to tell Consul which upstream you need to talk to.

    When upstreams are specified explicitly with the , the injector will also set environment variables <NAME>_CONNECT_SERVICE_HOST and <NAME>_CONNECT_SERVICE_PORT in every container in the Pod for every defined upstream. This is analogous to the standard Kubernetes service environment variables, but point instead to the correct local proxy port to establish connections via Connect.

    We can verify access to the static text server using kubectl exec. Because transparent proxy is enabled by default, we use Kubernetes DNS to connect to our desired upstream.

    1. $ kubectl exec deploy/static-client -- curl -s http://static-server/
    2. "hello world"

    We can control access to the server using intentions. If you use the Consul UI or to create a deny intention between “static-client” and “static-server”, connections are immediately rejected without updating either of the running pods. You can then remove this intention to allow connections again.

    1. $ kubectl exec deploy/static-client -- curl -s http://static-server/
    2. command terminated with exit code 52

    Available Annotations

    Pod annotations can be used to configure the injection behavior.

    • consul.hashicorp.com/connect-inject - If this is “true” then injection is enabled. If this is “false” then injection is explicitly disabled. The default injector behavior requires pods to opt-in to injection by specifying this value as “true”. This default can be changed in the injector’s configuration if desired.

    • - If this is “true”, this Pod will run with transparent proxy enabled. This means you can use Kubernetes DNS to access upstream services and all inbound and outbound traffic within the pod is redirected to go through the proxy.

    • consul.hashicorp.com/transparent-proxy-overwrite-probes - If this is “true” and transparent proxy is enabled, the Connect injector will overwrite Kubernetes HTTP probes to point to the Envoy proxy.

    • - A comma-separated list of inbound ports to exclude from traffic redirection when running in transparent proxy mode.

    • consul.hashicorp.com/transparent-proxy-exclude-outbound-cidrs - A comma-separated list of outbound CIDRs to exclude from traffic redirection when running in transparent proxy mode.

    • - A comma-separated list of outbound ports to exclude from traffic redirection when running in transparent proxy mode.

    • consul.hashicorp.com/connect-service - For pods that accept inbound connections, this specifies the name of the service that is being served. This defaults to the name of the Kubernetes service associated with the pod.

      If using ACLs, this must be the same name as the Pod’s ServiceAccount.

    • - For pods that accept inbound connections, this specifies the port to route inbound connections to. This is the port that the service is listening on. The service port defaults to the first exposed port on any container in the pod. If specified, the value can be the name of a configured port, such as “http” or it can be a direct port value such as “8080”. This is the port of the service, the proxy public listener will listen on a dynamic port.

    • consul.hashicorp.com/connect-service-upstreams - The list of upstream services that this pod needs to connect to via Connect along with a static local port to listen for those connections. When transparent proxy is enabled, this annotation is optional.

      • Services

        The name of the service is the name of the service registered with Consul. You can optionally specify datacenters with this annotation.

        1. annotations:
        2.   "consul.hashicorp.com/connect-service-upstreams":"[service-name]:[port]:[optional datacenter]"

      • Consul Enterprise Namespaces

        If running Consul Enterprise 1.7+, your upstream services may be running in different namespaces. The upstream namespace can be specified after the service name as [service-name].[namespace]. See below for more details on configuring the injector.

        1. annotations:
        2.   "consul.hashicorp.com/connect-service-upstreams":"[service-name].[service-namespace]:[port]:[optional datacenter]"

        NOTE: If the namespace is not specified it will default to the namespace of the source service.

        WARNING: Setting a namespace when not using Consul Enterprise or using a version < 1.7 is not supported. It will be treated as part of the service name.

      • Prepared Query

        1. annotations:
        2.   'consul.hashicorp.com/connect-service-upstreams': 'prepared_query:[query name]:[port]'

      • Multiple Upstreams

        If you would like to specify multiple services or upstreams, delimit them with commas

        1. annotations:
        2.   "consul.hashicorp.com/connect-service-upstreams":"[service-name]:[port]:[optional datacenter],prepared_query:[query name]:[port]"

    • - A space-separated list of arguments to be passed to the injected envoy binary.

      1. annotations:
      2.   consul.hashicorp.com/envoy-extra-args: '--log-level debug --disable-hot-restart'

    • - A comma separated list of tags that will be applied to the Consul service and its sidecar.

      1. annotations:
      2.   consul.hashicorp.com/service-tags: foo,bar,baz

    • consul.hashicorp.com/service-meta- - Set Consul meta key/value pairs that will be applied to the Consul service and its sidecar. The key will be what comes after consul.hashicorp.com/service-meta-, e.g. consul.hashicorp.com/service-meta-foo: bar will result in foo: bar.

      1. annotations:
      2.   consul.hashicorp.com/service-meta-foo: baz
      3.   consul.hashicorp.com/service-meta-bar: baz

    • - Override default resource settings for the sidecar proxy container. The defaults are set in Helm config via the connectInject.sidecarProxy.resources key.

    • - Override the default Helm value connectInject.metrics.defaultEnableMerging.

    • - Override the default Helm value connectInject.metrics.defaultMergedMetricsPort.

    • - Override the default Helm value connectInject.metrics.defaultPrometheusScrapePort.

    • - Override the default Helm value connectInject.metrics.defaultPrometheusScrapePath.

    • - Set the port where the Connect service exposes metrics.

    • consul.hashicorp.com/service-metrics-path - Set the path where the Connect service exposes metrics.

    Installation and Configuration

    The Connect sidecar proxy is injected via a mutating admission webhook provided by the . This enables the automatic pod mutation shown in the usage section above. Installation of the mutating admission webhook is automated using the Helm chart.

    1. connectInject:
    2.   enabled: true
    4. controller:
    5.   enabled: true

    This will configure the injector to inject when the is set to true. Other values in the Helm chart can be used to limit the namespaces the injector runs in, enable injection by default, and more.

    By default, the injector will inject only when the injection annotation on the pod (not the deployment) is set to true:

    1. annotations:
    2.   'consul.hashicorp.com/connect-inject': 'true'

    Injection Defaults

    If you wish for the injector to always inject, you can set the default to true in the Helm chart:

    You can then exclude specific pods via annotation:

    1. annotations:
    2.   'consul.hashicorp.com/connect-inject': 'false'

    Controlling Injection Via Namespace

    You can control which Kubernetes namespaces are allowed to be injected via the k8sAllowNamespaces and k8sDenyNamespaces keys:

    2.   enabled: true
    3.   k8sAllowNamespaces: ['*']
    4.   k8sDenyNamespaces: []

    In the default configuration (shown above), services from all namespaces are allowed to be injected. Whether or not they’re injected depends on the value of connectInject.default and the consul.hashicorp.com/connect-inject annotation.

    If you wish to only enable injection in specific namespaces, you can list only those namespaces in the k8sAllowNamespaces key. In the configuration below only the my-ns-1 and my-ns-2 namespaces will be enabled for injection. All other namespaces will be ignored, even if the connect inject is set.

    1. connectInject:
    2.   enabled: true
    3.   k8sAllowNamespaces: ['my-ns-1', 'my-ns-2']
    4.   k8sDenyNamespaces: []

    If you wish to enable injection in every namespace except specific namespaces, you can use * in the allow list to allow all namespaces and then specify the namespaces to exclude in the deny list:

    1. connectInject:
    2.   enabled: true
    3.   k8sAllowNamespaces: ['*']
    4.   k8sDenyNamespaces: ['no-inject-ns-1', 'no-inject-ns-2']

    NOTE: The deny list takes precedence over the allow list. If a namespace is listed in both lists, it will not be synced.

    NOTE: The kube-system and kube-public namespaces will never be injected.

    Consul Enterprise 1.7+ supports Consul namespaces. When Kubernetes pods are registered into Consul, you can control which Consul namespace they are registered into.

    There are three options available:

    1. Single Destination Namespace – Register all Kubernetes pods, regardless of namespace, into the same Consul namespace.

      This can be configured with:

      1. global:
      2.   enableConsulNamespaces: true
      4. connectInject:
      5.   enabled: true
      6.   consulNamespaces:
      7.     consulDestinationNamespace: 'my-consul-ns'

      NOTE: If the destination namespace does not exist we will create it.

    2. Mirror Namespaces - Register each Kubernetes pod into a Consul namespace with the same name as its Kubernetes namespace. For example, pod foo in Kubernetes namespace ns-1 will be synced to the Consul namespace ns-1. If a mirrored namespace does not exist in Consul, it will be created.

      This can be configured with:

      1. global:
      2.   enableConsulNamespaces: true
      4. connectInject:
      5.   enabled: true
      6.   consulNamespaces:
      7.     mirroringK8S: true

    3. Mirror Namespaces With Prefix - Register each Kubernetes pod into a Consul namespace with the same name as its Kubernetes namespace with a prefix. For example, given a prefix k8s-, pod foo in Kubernetes namespace ns-1 will be synced to the Consul namespace k8s-ns-1.

      This can be configured with:

    Consul Enterprise Namespace Upstreams

    When is enabled and ACLs are disabled, the upstreams will be configured automatically across Consul namespaces. When ACLs are enabled, you must configure it by specifying an intention, allowing services across Consul namespaces to talk to each other.

    If you wish to specify an upstream explicitly via the consul.hashicorp.com/connect-service-upstreams annotation, use the format [service-name].[namespace]:[port]:[optional datacenter]:

    1. annotations:
    2.   'consul.hashicorp.com/connect-inject': 'true'

    See for more details.

    Note: When you specify upstreams via an upstreams annotation, you will need to use localhost:<port> with the port from the upstreams annotation instead of KubeDNS to connect to your upstream application.

    Verifying the Installation

    To verify the installation, run the example from the “Usage” section above. After running this example, run kubectl get pod static-server -o yaml. In the raw YAML output, you should see injected Connect containers and an annotation consul.hashicorp.com/connect-inject-status set to . This confirms that injection is working properly.

    If you do not see this, then use kubectl logs against the injector pod and note any errors.