From ba490124478010027b752382e74f49fd1e1d3607 Mon Sep 17 00:00:00 2001 From: Damien Duportal Date: Wed, 27 Nov 2019 16:02:05 +0100 Subject: [PATCH] Mention the experimental Helm Chart in the installation section of documentation --- .../getting-started/install-traefik.md | 65 +++++++++++++++++++ 1 file changed, 65 insertions(+) diff --git a/docs/content/getting-started/install-traefik.md b/docs/content/getting-started/install-traefik.md index 96cf721b1..2cda421f0 100644 --- a/docs/content/getting-started/install-traefik.md +++ b/docs/content/getting-started/install-traefik.md @@ -3,6 +3,7 @@ You can install Traefik with the following flavors: * [Use the official Docker image](./#use-the-official-docker-image) +* [(Experimental) Use the Helm Chart](./#use-the-helm-chart) * [Use the binary distribution](./#use-the-binary-distribution) * [Compile your binary from the sources](./#compile-your-binary-from-the-sources) @@ -24,6 +25,70 @@ For more details, go to the [Docker provider documentation](../providers/docker. * Docker images are based from the [Alpine Linux Official image](https://hub.docker.com/_/alpine). * All the orchestrator using docker images could fetch the official Traefik docker image. +## Use the Helm Chart + +!!! warning "Experimental Helm Chart" + + Please note that the Helm Chart for Traefik v2 is still experimental. + + The Traefik Stable Chart from + [Helm's default charts repository](https://github.com/helm/charts/tree/master/stable/traefik) is still using [Traefik v1.7](https://docs.traefik.io/v1.7). + +Traefik can be installed in Kubernetes using the v2.0 Helm chart from . + +Ensure that the following requirements are met: + +* Kubernetes 1.14+ +* Helm version 2.x is [installed](https://v2.helm.sh/docs/using_helm/) and initialized with Tiller + +Retrieve the latest chart version from the repository: + +```bash +# Retrieve Chart from the repository +git clone https://github.com/containous/traefik-helm-chart +``` + +And install it with the `helm` command line: + +```bash +helm install ./traefik-helm-chart +``` + +!!! tip "Helm Features" + + All [Helm features](https://v2.helm.sh/docs/using_helm/#using-helm) are supported. + For instance, installing the chart in a dedicated namespace: + + ```bash tab="Install in a Dedicated Namespace" + # Install in the namespace "traefik-v2" + helm install --namespace=traefik-v2 \ + ./traefik-helm-chart + ``` + +??? example "Installing with Custom Values" + + You can customize the installation by specifying custom values, + as with [any helm chart](https://v2.helm.sh/docs/using_helm/#customizing-the-chart-before-installing). + {: #helm-custom-values } + + The values are not (yet) documented, but are self-explanatory: + you can look at the [default `values.yaml`](https://github.com/containous/traefik-helm-chart/blob/master/values.yaml) file to explore possibilities. + + Example of installation with logging set to `DEBUG`: + + ```bash tab="Using Helm CLI" + helm install --namespace=traefik-v2 \ + --set="logs.loglevel=DEBUG" \ + ./traefik-helm-chart + ``` + + ```yml tab="With a custom values file" + # File custom-values.yml + ## Install with "helm install --values=./custom-values.yml ./traefik-helm-chart + logs: + loglevel: DEBUG + ``` + ## Use the Binary Distribution Grab the latest binary from the [releases](https://github.com/containous/traefik/releases) page.