Install Traefik

You can install Traefik with the following flavors:

Use the Official Docker Image

Choose one of the official Docker images and run it with one sample configuration file:

docker run -d -p 8080:8080 -p 80:80 \
    -v $PWD/traefik.toml:/etc/traefik/traefik.toml traefik:v2.3

For more details, go to the Docker provider documentation

Tip

  • Prefer a fixed version than the latest that could be an unexpected version. ex: traefik:v2.1.4
  • Docker images are based from the Alpine Linux Official image.
  • Any orchestrator using docker images can fetch the official Traefik docker image.

Use the Helm Chart

Warning

The Traefik Chart from Helm's default charts repository is still using Traefik v1.7.

Traefik can be installed in Kubernetes using the Helm chart from https://github.com/traefik/traefik-helm-chart.

Ensure that the following requirements are met:

  • Kubernetes 1.14+
  • Helm version 3.x is installed

Add Traefik's chart repository to Helm:

helm repo add traefik https://helm.traefik.io/traefik

You can update the chart repository by running:

helm repo update

And install it with the helm command line:

helm install traefik traefik/traefik

Helm Features

All Helm features are supported. For instance, installing the chart in a dedicated namespace:

kubectl create ns traefik-v2
# Install in the namespace "traefik-v2"
helm install --namespace=traefik-v2 \
    traefik traefik/traefik
Installing with Custom Values

You can customize the installation by specifying custom values, as with any helm chart.

The values are not (yet) documented, but are self-explanatory: you can look at the default values.yaml file to explore possibilities.

You can also set Traefik command line flags using additionalArguments. Example of installation with logging set to DEBUG:

helm install --namespace=traefik-v2 \
    --set="additionalArguments={--log.level=DEBUG}" \
    traefik traefik/traefik
# File custom-values.yml
## Install with "helm install --values=./custom-values.yml traefik traefik/traefik
additionalArguments:
  - "--log.level=DEBUG"

Exposing the Traefik dashboard

This HelmChart does not expose the Traefik dashboard by default, for security concerns. Thus, there are multiple ways to expose the dashboard. For instance, the dashboard access could be achieved through a port-forward :

kubectl port-forward $(kubectl get pods --selector "app.kubernetes.io/name=traefik" --output=name) 9000:9000

Accessible with the url: http://127.0.0.1:9000/dashboard/

Another way would be to apply your own configuration, for instance, by defining and applying an IngressRoute CRD (kubectl apply -f dashboard.yaml):

# dashboard.yaml
apiVersion: traefik.containo.us/v1alpha1
kind: IngressRoute
metadata:
  name: dashboard
spec:
  entryPoints:
    - web
  routes:
    - match: Host(`traefik.localhost`) && (PathPrefix(`/dashboard`) || PathPrefix(`/api`))
      kind: Rule
      services:
        - name: api@internal
          kind: TraefikService

Use the Binary Distribution

Grab the latest binary from the releases page.

Check the integrity of the downloaded file
# Compare this value to the one found in traefik-${traefik_version}_checksums.txt
sha256sum ./traefik_${traefik_version}_linux_${arch}.tar.gz
# Compare this value to the one found in traefik-${traefik_version}_checksums.txt
shasum -a256 ./traefik_${traefik_version}_darwin_amd64.tar.gz
# Compare this value to the one found in traefik-${traefik_version}_checksums.txt
Get-FileHash ./traefik_${traefik_version}_windows_${arch}.zip -Algorithm SHA256
Extract the downloaded archive
tar -zxvf traefik_${traefik_version}_linux_${arch}.tar.gz
tar -zxvf ./traefik_${traefik_version}_darwin_amd64.tar.gz
Expand-Archive traefik_${traefik_version}_windows_${arch}.zip

And run it:

./traefik --help

Compile your Binary from the Sources

All the details are available in the Contributing Guide