traefik/docs/content/providers/kubernetes-crd.md

Traefik & Kubernetes

The Kubernetes Ingress Controller, The Custom Resource Way. {: .subtitle }

Traefik used to support Kubernetes only through the Kubernetes Ingress provider, which is a Kubernetes Ingress controller in the strict sense of the term.

However, as the community expressed the need to benefit from Traefik features without resorting to (lots of) annotations, we ended up writing a Custom Resource Definition (alias CRD in the following) for an IngressRoute type, defined below, in order to provide a better way to configure access to a Kubernetes cluster.

Resource Configuration

See the dedicated section in routing.

Provider Configuration

endpoint

Optional, Default=empty

[providers.kubernetesCRD]
  endpoint = "http://localhost:8080"
  # ...

providers:
  kubernetesCRD:
    endpoint = "http://localhost:8080"
    # ...

--providers.kubernetescrd.endpoint="http://localhost:8080"

The Kubernetes server endpoint as URL.

When deployed into Kubernetes, Traefik will read the environment variables KUBERNETES_SERVICE_HOST and KUBERNETES_SERVICE_PORT or KUBECONFIG 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.

token

Optional, Default=empty

[providers.kubernetesCRD]
  token = "mytoken"
  # ...

providers:
  kubernetesCRD:
    token = "mytoken"
    # ...

--providers.kubernetescrd.token="mytoken"

Bearer token used for the Kubernetes client configuration.

certAuthFilePath

Optional, Default=empty

[providers.kubernetesCRD]
  certAuthFilePath = "/my/ca.crt"
  # ...

providers:
  kubernetesCRD:
    certAuthFilePath: "/my/ca.crt"
    # ...

--providers.kubernetescrd.certauthfilepath="/my/ca.crt"

Path to the certificate authority file. Used for the Kubernetes client configuration.

namespaces

Optional, Default: all namespaces (empty array)

[providers.kubernetesCRD]
  namespaces = ["default", "production"]
  # ...

providers:
  kubernetesCRD:
    namespaces:
    - "default"
    - "production"
    # ...

--providers.kubernetescrd.namespaces="default,production"

Array of namespaces to watch.

labelselector

Optional,Default: empty (process all Ingresses)

[providers.kubernetesCRD]
  labelselector = "A and not B"
  # ...

providers:
  kubernetesCRD:
    labelselector: "A and not B"
    # ...

--providers.kubernetescrd.labelselector="A and not B"

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.

ingressClass

Optional, Default: empty

[providers.kubernetesCRD]
  ingressClass = "traefik-internal"
  # ...

providers:
  kubernetesCRD:
    ingressClass: "traefik-internal"
    # ...

--providers.kubernetescrd.ingressclass="traefik-internal"

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.

throttleDuration

Optional, Default: 0 (no throttling)

[providers.kubernetesCRD]
  throttleDuration = "10s"
  # ...

providers:
  kubernetesCRD:
    throttleDuration: "10s"
    # ...

--providers.kubernetescrd.throttleDuration="10s"

Further

Also see the full example with Let's Encrypt.