Traefik & Kubernetes¶

The Kubernetes Ingress Controller, The Custom Resource Way.

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.

Configuration Requirements¶

All Steps for a Successful Deployment

Add/update all the Traefik resources definitions
Add/update the RBAC for the Traefik custom resources
Use Helm Chart or use a custom Traefik Deployment
- Enable the kubernetesCRD provider
- Apply the needed kubernetesCRD provider configuration
Add all needed traefik custom resources

Initializing Resource Definition and RBAC

Traefik Resource Definition

# All resources definition must be declared
apiVersion: apiextensions.k8s.io/v1beta1
kind: CustomResourceDefinition
metadata:
  name: ingressroutes.traefik.containo.us

spec:
  group: traefik.containo.us
  version: v1alpha1
  names:
    kind: IngressRoute
    plural: ingressroutes
    singular: ingressroute
  scope: Namespaced

---
apiVersion: apiextensions.k8s.io/v1beta1
kind: CustomResourceDefinition
metadata:
  name: middlewares.traefik.containo.us

spec:
  group: traefik.containo.us
  version: v1alpha1
  names:
    kind: Middleware
    plural: middlewares
    singular: middleware
  scope: Namespaced

---
apiVersion: apiextensions.k8s.io/v1beta1
kind: CustomResourceDefinition
metadata:
  name: ingressroutetcps.traefik.containo.us

spec:
  group: traefik.containo.us
  version: v1alpha1
  names:
    kind: IngressRouteTCP
    plural: ingressroutetcps
    singular: ingressroutetcp
  scope: Namespaced

---
apiVersion: apiextensions.k8s.io/v1beta1
kind: CustomResourceDefinition
metadata:
  name: ingressrouteudps.traefik.containo.us

spec:
  group: traefik.containo.us
  version: v1alpha1
  names:
    kind: IngressRouteUDP
    plural: ingressrouteudps
    singular: ingressrouteudp
  scope: Namespaced

---
apiVersion: apiextensions.k8s.io/v1beta1
kind: CustomResourceDefinition
metadata:
  name: tlsoptions.traefik.containo.us

spec:
  group: traefik.containo.us
  version: v1alpha1
  names:
    kind: TLSOption
    plural: tlsoptions
    singular: tlsoption
  scope: Namespaced

---
apiVersion: apiextensions.k8s.io/v1beta1
kind: CustomResourceDefinition
metadata:
  name: tlsstores.traefik.containo.us

spec:
  group: traefik.containo.us
  version: v1alpha1
  names:
    kind: TLSStore
    plural: tlsstores
    singular: tlsstore
  scope: Namespaced

---
apiVersion: apiextensions.k8s.io/v1beta1
kind: CustomResourceDefinition
metadata:
  name: traefikservices.traefik.containo.us

spec:
  group: traefik.containo.us
  version: v1alpha1
  names:
    kind: TraefikService
    plural: traefikservices
    singular: traefikservice
  scope: Namespaced

RBAC for Traefik CRD

kind: ClusterRole
apiVersion: rbac.authorization.k8s.io/v1beta1
metadata:
  name: traefik-ingress-controller

rules:
  - apiGroups:
      - ""
    resources:
      - services
      - endpoints
      - secrets
    verbs:
      - get
      - list
      - watch
  - apiGroups:
      - extensions
      - networking.k8s.io
    resources:
      - ingresses
      - ingressclasses
    verbs:
      - get
      - list
      - watch
  - apiGroups:
      - extensions
    resources:
      - ingresses/status
    verbs:
      - update
  - apiGroups:
      - traefik.containo.us
    resources:
      - middlewares
      - ingressroutes
      - traefikservices
      - ingressroutetcps
      - ingressrouteudps
      - tlsoptions
      - tlsstores
    verbs:
      - get
      - list
      - watch

---
kind: ClusterRoleBinding
apiVersion: rbac.authorization.k8s.io/v1beta1
metadata:
  name: traefik-ingress-controller

roleRef:
  apiGroup: rbac.authorization.k8s.io
  kind: ClusterRole
  name: traefik-ingress-controller
subjects:
  - kind: ServiceAccount
    name: traefik-ingress-controller
    namespace: default

Resource Configuration¶

When using KubernetesCRD as a provider, Traefik uses Custom Resource Definition to retrieve its routing configuration. Traefik Custom Resource Definitions are a Kubernetes implementation of the Traefik concepts. The main particularities are:

The usage of name and namespace to refer to another Kubernetes resource.
The usage of secret for sensible data like:
- TLS certificate.
- Authentication data.
The structure of the configuration.
The obligation to declare all the definitions.

The Traefik CRD are building blocks which you can assemble according to your needs. See the list of CRDs in the dedicated routing section.

LetsEncrypt Support with the Custom Resource Definition Provider¶

By design, Traefik is a stateless application, meaning that it only derives its configuration from the environment it runs in, without additional configuration. For this reason, users can run multiple instances of Traefik at the same time to achieve HA, as is a common pattern in the kubernetes ecosystem.

When using a single instance of Traefik with LetsEncrypt, no issues should be encountered, however this could be a single point of failure. Unfortunately, it is not possible to run multiple instances of Traefik 2.0 with LetsEncrypt enabled, because there is no way to ensure that the correct instance of Traefik will receive the challenge request, and subsequent responses. Previous versions of Traefik used a KV store to attempt to achieve this, but due to sub-optimal performance was dropped as a feature in 2.0.

If you require LetsEncrypt with HA in a kubernetes environment, we recommend using Traefik Enterprise where distributed LetsEncrypt is a supported feature.

If you are wanting to continue to run Traefik Community Edition, LetsEncrypt HA can be achieved by using a Certificate Controller such as Cert-Manager. When using Cert-Manager to manage certificates, it will create secrets in your namespaces that can be referenced as TLS secrets in your ingress objects. When using the Traefik Kubernetes CRD Provider, unfortunately Cert-Manager cannot interface directly with the CRDs yet, but this is being worked on by our team. A workaround is to enable the Kubernetes Ingress provider to allow Cert-Manager to create ingress objects to complete the challenges. Please note that this still requires manual intervention to create the certificates through Cert-Manager, but once created, Cert-Manager will keep the certificate renewed.

Provider Configuration¶

`endpoint`¶

Optional, Default=empty

File (TOML)

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

File (YAML)

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

CLI

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

File (TOML)

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

File (YAML)

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

CLI

--providers.kubernetescrd.token=mytoken

Bearer token used for the Kubernetes client configuration.

`certAuthFilePath`¶

Optional, Default=empty

File (TOML)

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

File (YAML)

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

CLI

--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)

File (TOML)

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

File (YAML)

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

CLI

--providers.kubernetescrd.namespaces=default,production

Array of namespaces to watch.

`labelselector`¶

Optional,Default: empty (process all resources)

File (TOML)

[providers.kubernetesCRD]
  labelselector = "app=traefik"
  # ...

File (YAML)

providers:
  kubernetesCRD:
    labelselector: "app=traefik"
    # ...

CLI

--providers.kubernetescrd.labelselector="app=traefik"

By default, Traefik processes all resource objects in the configured namespaces. A label selector can be defined to filter on specific resource objects only, this will apply only on Traefik Custom Resources and has no effect on Kubernetes Secrets, Endpoints and Services.

See label-selectors for details.

Warning

As the LabelSelector is applied to all Traefik Custom Resources, they all must match the filter.

`ingressClass`¶

Optional, Default: empty

File (TOML)

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

File (YAML)

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

CLI

--providers.kubernetescrd.ingressclass=traefik-internal

Value of kubernetes.io/ingress.class annotation that identifies resource objects to be processed.

If the parameter is non-empty, only resources containing an annotation with the same value are processed. Otherwise, resources missing the annotation, having an empty value, or the value traefik are processed.

`throttleDuration`¶

Optional, Default: 0 (no throttling)

File (TOML)

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

File (YAML)

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

CLI

--providers.kubernetescrd.throttleDuration=10s

`allowCrossNamespace`¶

Optional, Default: true

File (TOML)

[providers.kubernetesCRD]
  allowCrossNamespace = false
  # ...

File (YAML)

providers:
  kubernetesCRD:
    allowCrossNamespace: false
    # ...

CLI

--providers.kubernetescrd.allowCrossNamespace=false

If the parameter is set to false, an IngressRoute will not be able to reference any resources in another namespace than the IngressRoute namespace.

Deprecation

Please notice that the default value for this option will be set to false in a future version.

Further¶

Also see the full example with Let's Encrypt.

Traefik & Kubernetes¶

Configuration Requirements¶

Resource Configuration¶

LetsEncrypt Support with the Custom Resource Definition Provider¶

Provider Configuration¶

endpoint¶

token¶

certAuthFilePath¶

namespaces¶

labelselector¶

ingressClass¶

throttleDuration¶

allowCrossNamespace¶

Further¶

`endpoint`¶

`token`¶

`certAuthFilePath`¶

`namespaces`¶

`labelselector`¶

`ingressClass`¶

`throttleDuration`¶

`allowCrossNamespace`¶