Traefik
Traefik is a modern HTTP reverse proxy and load balancer made to deploy microservices with ease.
DISCLAIMER: While this chart has been well-tested, testers have encountered occasional issues with the Traefik software itself. Be advised that your mileage may vary.
Introduction
This chart bootstraps Traefik as a Kubernetes ingress controller with optional support for SSL and Let's Encrypt.
NOTE: Operators will typically wish to install this component into the kube-system namespace
where that namespace's default service account will ensure adequate privileges to watch Ingress
resources cluster-wide.
Prerequisites
- Kubernetes 1.4+ with Beta APIs enabled
- You are deploying the chart to a cluster with a cloud provider capable of provisioning an external load balancer (e.g. AWS or GKE)
- You control DNS for the domain(s) you intend to route through Traefik
- Suggested: PV provisioner support in the underlying infrastructure
Installing the Chart
To install the chart with the release name my-release:
$ helm install stable/traefik --name my-release --namespace kube-system
After installing the chart, create DNS records for applicable domains to direct inbound traffic to the load balancer. You can use the commands below to find the load balancer's IP/hostname:
NOTE: It may take a few minutes for this to become available.
You can watch the status by running:
$ kubectl get svc my-release-traefik --namespace kube-system -w
Once EXTERNAL-IP is no longer <pending>:
$ kubectl describe service my-release-traefik -n kube-system | grep Ingress | awk '{print $3}'
NOTE: If ACME support is enabled, it is only after this step is complete that Traefik will be able to successfully use the ACME protocol to obtain certificates from Let's Encrypt.
Uninstalling the Chart
To uninstall/delete the my-release deployment:
$ helm delete my-release
The command removes all the Kubernetes components associated with the chart and deletes the release.
Configuration
The following tables lists the configurable parameters of the Traefik chart and their default values.
| Parameter | Description | Default |
|---|---|---|
imageTag |
The version of the official Traefik image to use | v1.1.2 |
serviceType |
A valid Kubernetes service type | LoadBalancer |
cpuRequest |
Initial share of CPU requested per Traefik pod | 100m |
memoryRequest |
Initial share of memory requested per Traefik pod | 20Mi |
cpuLimit |
CPU limit per Traefik pod | 200m |
memoryLimit |
Memory limit per Traefik pod | 30Mi |
ssl.enabled |
Whether to enable HTTPS | false |
ssl.enforced |
Whether to redirect HTTP requests to HTTPS | false |
ssl.defaultCert |
Base64 encoded default certficate | A self-signed certificate |
ssl.defaultKey |
Base64 encoded private key for the certificate above | The private key for the certificate above |
acme.enabled |
Whether to use Let's Encrypt to obtain certificates | false |
acme.email |
Email address to be used in certificates obtained from Let's Encrypt | admin@example.com |
acme.staging |
Whether to get certs from Let's Encrypt's staging environment | true |
acme.persistence.enabled |
Create a volume to store ACME certs (if ACME is enabled) | true |
acme.persistence.storageClass |
Type of StorageClass to request-- will be cluster-specific |
generic |
acme.persistence.accessMode |
ReadWriteOnce or ReadOnly |
ReadWriteOnce |
acme.persistence.size |
Minimum size of the volume requested | 1Gi |
dashboard.enabled |
Whether to enable the Traefik dashboard | false |
dashboard.domain |
Domain for the Traefik dashboard | traefik.example.com |
gzip.enabled |
Whether to use gzip compression | true |
Specify each parameter using the --set key=value[,key=value] argument to helm install. For example:
$ helm install --name my-release --namespace kube-system --set dashboard.enabled=true,dashboard.domain=traefik.example.com stable/traefik
The above command enables the Traefik dashboard on the domain traefik.example.com.
Alternatively, a YAML file that specifies the values for the parameters can be provided while installing the chart. For example:
$ helm install --name my-release --namespace kube-system --values values.yaml stable/traefik