Kubernetes Ingress Provider

Traefik can be configured to use Kubernetes Ingress as a provider.

See also Kubernetes user guide.

Configuration

################################################################
# Kubernetes Ingress Provider
################################################################
# Enable Kubernetes Ingress Provider.
[kubernetes]
# Kubernetes server endpoint.
#
# Optional for in-cluster configuration, required otherwise.
# Default: empty
#
# endpoint = "http://localhost:8080"
# Bearer token used for the Kubernetes client configuration.
#
# Optional
# Default: empty
#
# token = "my token"
# Path to the certificate authority file.
# Used for the Kubernetes client configuration.
#
# Optional
# Default: empty
#
# certAuthFilePath = "/my/ca.crt"
# Array of namespaces to watch.
#
# Optional
# Default: all namespaces (empty array).
#
# namespaces = ["default", "production"]
# Ingress label selector to filter Ingress objects that should be processed.
#
# Optional
# Default: empty (process all Ingresses)
#
# labelselector = "A and not B"
# Value of `kubernetes.io/ingress.class` annotation that identifies Ingress objects to be processed.
# If the parameter is non-empty, only Ingresses containing an annotation with the same value are processed.
# Otherwise, Ingresses missing the annotation, having an empty value, or the value `traefik` are processed.
#
# Optional
# Default: empty
#
# ingressClass = "traefik-internal"
# Disable PassHost Headers.
#
# Optional
# Default: false
#
# disablePassHostHeaders = true
# Enable PassTLSCert Headers.
#
# Optional
# Default: false
#
# enablePassTLSCert = true
# Throttle how frequently we refresh our configuration from Ingresses when there
# are frequent changes.
#
# Optional
# Default: 0 (no throttling)
#
# throttleDuration = 10s
# Override default configuration template.
#
# Optional
# Default: <built-in template>
#
# filename = "kubernetes.tmpl"
# Enable IngressEndpoint configuration.
# This will allow Traefik to update the status section of ingress objects, if desired.
#
# Optional
#
# [kubernetes.ingressEndpoint]
#
# At least one must be configured.
# `publishedservice` will override the `hostname` and `ip` settings if configured.
#
# hostname = "localhost"
# ip = "127.0.0.1"
# publishedService = "namespace/servicename"

endpoint

The Kubernetes server endpoint as URL.

When deployed into Kubernetes, Traefik will read the environment variables KUBERNETES_SERVICE_HOST and KUBERNETES_SERVICE_PORT to construct the endpoint.

The access token will be looked up in /var/run/secrets/kubernetes.io/serviceaccount/token and the SSL CA certificate in /var/run/secrets/kubernetes.io/serviceaccount/ca.crt. Both are provided mounted automatically when deployed inside Kubernetes.

The endpoint may be specified to override the environment variable values inside a cluster.

When the environment variables are not found, Traefik will try to connect to the Kubernetes API server with an external-cluster client. In this case, the endpoint is required. Specifically, it may be set to the URL used by kubectl proxy to connect to a Kubernetes cluster using the granted authentication and authorization of the associated kubeconfig.

labelselector

By default, Traefik processes all Ingress objects in the configured namespaces. A label selector can be defined to filter on specific Ingress objects only.

See label-selectors for details.

ingressEndpoint

You can configure a static hostname or IP address that Traefik will add to the status section of Ingress objects that it manages. If you prefer, you can provide a service, which traefik will copy the status spec from. This will give more flexibility in cloud/dynamic environments.

TLS communication between Traefik and backend pods

Traefik automatically requests endpoint information based on the service provided in the ingress spec. Although traefik will connect directly to the endpoints (pods), it still checks the service port to see if TLS communication is required.

There are 3 ways to configure Traefik to use https to communicate with backend pods:

• If the service port defined in the ingress spec is 443 (note that you can still use targetPort to use a different port on your pod).
• If the service port defined in the ingress spec has a name that starts with https (such as https-api, https-web or just https).
• If the ingress spec includes the annotation ingress.kubernetes.io/protocol: https.

If either of those configuration options exist, then the backend communication protocol is assumed to be TLS, and will connect via TLS automatically.

Note

Please note that by enabling TLS communication between traefik and your pods, you will have to have trusted certificates that have the proper trust chain and IP subject name. If this is not an option, you may need to skip TLS certificate verification. See the insecureSkipVerify setting for more details.

Annotations

General annotations

The following general annotations are applicable on the Ingress object:

<1> traefik.ingress.kubernetes.io/app-root: Non-root paths will not be affected by this annotation and handled normally. This annotation may not be combined with other redirect annotations. Trying to do so will result in the other redirects being ignored. This annotation can be used in combination with traefik.ingress.kubernetes.io/redirect-permanent to configure whether the app-root redirect is a 301 or a 302.

<2> traefik.ingress.kubernetes.io/error-pages example:

foo:
  status:
  - "404"
  backend: bar
  query: /bar
fii:
  status:
  - "503"
  - "500"
  backend: bar
  query: /bir

<3> traefik.ingress.kubernetes.io/pass-client-tls-cert example:

# add escaped pem in the `X-Forwarded-Tls-Client-Cert` header
pem: true
# add escaped certificate following infos in the `X-Forwarded-Tls-Client-Cert-Infos` header
infos:
  notafter: true
  notbefore: true
  sans: true
  subject:
    country: true
    province: true
    locality: true
    organization: true
    commonname: true
    serialnumber: true

If pem is set, it will add a X-Forwarded-Tls-Client-Cert header that contains the escaped pem as value. If at least one flag of the infos part is set, it will add a X-Forwarded-Tls-Client-Cert-Infos header that contains an escaped string composed of the client certificate data selected by the infos flags. This infos part is composed like the following example (not escaped):

Subject="C=FR,ST=SomeState,L=Lyon,O=Cheese,CN=*.cheese.org",NB=1531900816,NA=1563436816,SAN=*.cheese.org,*.cheese.net,cheese.in,[email protected],[email protected],10.0.1.0,10.0.1.2

Note these options work only with certificates issued by CAs included in the applicable EntryPoint ClientCA section; certificates from other CAs are not parsed or passed through as-is.

<4> traefik.ingress.kubernetes.io/rate-limit example:

extractorfunc: client.ip
rateset:
  bar:
    period: 3s
    average: 6
    burst: 9
  foo:
    period: 6s
    average: 12
    burst: 18

<5> traefik.ingress.kubernetes.io/rule-type Note: ReplacePath is deprecated in this annotation, use the traefik.ingress.kubernetes.io/request-modifier annotation instead. Default: PathPrefix.

<6> traefik.ingress.kubernetes.io/service-weights: Service weights enable to split traffic across multiple backing services in a fine-grained manner.

Example:

service_backend1: 12.50%
service_backend2: 12.50%
service_backend3: 75 # Same as 75%, the percentage sign is optional

A single service backend definition may be omitted; in this case, Traefik auto-completes that service backend to 100% automatically. Conveniently, users need not bother to compute the percentage remainder for a main service backend. For instance, in the example above service_backend3 does not need to be specified to be assigned 75%.

Note

For each service weight given, the Ingress specification must include a backend item with the corresponding serviceName and (if given) matching path.

Currently, 3 decimal places for the weight are supported. An attempt to exceed the precision should be avoided as it may lead to percentage computation flaws and, in consequence, Ingress parsing errors.

For each path definition, this annotation will fail if:

• the sum of backend weights exceeds 100% or
• the sum of backend weights is less than 100% without one or more omitted backends

See also the user guide section traffic splitting.

<7> traefik.ingress.kubernetes.io/whitelist-source-range: All source IPs are permitted if the list is empty or a single range is ill-formatted. Please note, you may have to set service.spec.externalTrafficPolicy to the value Local to preserve the source IP of the request for filtering. Please see this link for more information.

Note

Please note that traefik.ingress.kubernetes.io/redirect-regex and traefik.ingress.kubernetes.io/redirect-replacement do not have to be set if traefik.ingress.kubernetes.io/redirect-entry-point is defined for the redirection (they will not be used in this case).

The following annotations are applicable on the Service object associated with a particular Ingress object:

<1> traefik.ingress.kubernetes.io/buffering example:

maxrequestbodybytes: 10485760
memrequestbodybytes: 2097153
maxresponsebodybytes: 10485761
memresponsebodybytes: 2097152
retryexpression: IsNetworkError() && Attempts() <= 2

Note

traefik.ingress.kubernetes.io/ and ingress.kubernetes.io/ are supported prefixes.

Custom Headers Annotations

Security Headers Annotations

The following security annotations are applicable on the Ingress object:

Authentication

Additional authentication annotations can be added to the Ingress object. The source of the authentication is a Secret object that contains the credentials.

The secret must be created in the same namespace as the Ingress object.

The following limitations hold for basic/digest auth:

• The realm is not configurable; the only supported (and default) value is traefik.
• The Secret must contain a single file only.

TLS certificates management

TLS certificates can be managed in Secrets objects. More information are available in the User Guide.

Note

Only TLS certificates provided by users can be stored in Kubernetes Secrets. Let's Encrypt certificates cannot be managed in Kubernets Secrets yet.

Global Default Backend Ingresses

Ingresses can be created that look like the following:

apiVersion: extensions/v1beta1
kind: Ingress
metadata:
  name: cheese
spec:
  backend:
    serviceName: stilton
    servicePort: 80

This ingress follows the Global Default Backend property of ingresses. This will allow users to create a "default backend" that will match all unmatched requests.

Note

Due to Traefik's use of priorities, you may have to set this ingress priority lower than other ingresses in your environment, to avoid this global ingress from satisfying requests that could match other ingresses. To do this, use the traefik.ingress.kubernetes.io/priority annotation (as seen in General Annotations) on your ingresses accordingly.