From 97294df84fd25ee84a601dd87ebe1603c1f6098c Mon Sep 17 00:00:00 2001 From: Michael Date: Wed, 29 Apr 2020 17:32:05 +0200 Subject: [PATCH] Update the documentation for helm chart --- .../getting-started/install-traefik.md | 39 +++++++++++++++++-- 1 file changed, 36 insertions(+), 3 deletions(-) diff --git a/docs/content/getting-started/install-traefik.md b/docs/content/getting-started/install-traefik.md index 27ad69246..fa24837ac 100644 --- a/docs/content/getting-started/install-traefik.md +++ b/docs/content/getting-started/install-traefik.md @@ -78,20 +78,53 @@ helm install traefik traefik/traefik 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/traefik/values.yaml) file to explore possibilities. + You can also set Traefik command line flags using `additionalArguments`. Example of installation with logging set to `DEBUG`: ```bash tab="Using Helm CLI" helm install --namespace=traefik-v2 \ - --set="logs.loglevel=DEBUG" \ + --set="additionalArguments={--logs.level=DEBUG}" \ traefik traefik/traefik ``` ```yml tab="With a custom values file" # File custom-values.yml ## Install with "helm install --values=./custom-values.yml traefik traefik/traefik - logs: - loglevel: DEBUG + 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 : + +```shell +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`): + +```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