mmatur / traefik-hub-helm-chart

Traefik Hub Helm chart

Website | Log In | Documentation

Traefik Hub Helm Chart

Introduction

This chart installs the Traefik Hub agent in Ingress Controller mode on a Kubernetes cluster.

Installation

Prerequisites

1. Helm v3 installed: helm version

Deploying Hub Ingres Controller for Kubernetes

kubectl create secret generic hub-agent-token --from-literal=token=XXXX

helm upgrade --install traefik-hub traefik/traefik-hub

You can customize the installation with a values file.
Find the complete documentation on all parameters in the default value file.

(back to top)

Upgrading Hub Agent for Kubernetes

One can check what has changed in the release overview page.

Update the repository:

helm repo update

Check the current Chart & Traefik Hub version:

helm search repo traefik/traefik-hub

Upgrade Traefik Hub:

helm upgrade traefik-hub traefik/traefik-hub

(back to top)

Upgrading CRDs

With Helm v3, CRDs created by this chart can not be updated, consult the Helm Documentation on CRDs for more information.

Please read carefully the release notes of this chart before upgrading CRDs!

kubectl apply --server-side --force-conflicts -k https://github.com/traefik/traefik-hub-helm-chart/traefik-hub/crds/

(back to top)

Upgrading from v1.x.x

To upgrade from v1.x.x, a secret needs to be manually removed first:

kubectl delete secret hub-agent-cert -n traefik-hub

(back to top)

Uninstall

helm uninstall traefik-hub

If Traefik Hub was installed in a specific namespace:

helm uninstall traefik-hub --namespace my-namespace

(back to top)

Contributing

Versioning

We use Semantic Versioning.

Pull requests must bump the version of the chart specified in the Chart.yaml file:

• The new version must be an alpha pre-release (e.g. 1.6.0-alpha.1)
• The new version must reflect the nature of the change, according to the SemVer specification

A chart can be made available publicly by removing the pre-release suffix, this must be done on a separate PR by a maintainer.

Every version bump is published on the Helm Chart Registry.

The latest pre-release version of the Chart can be used by specifying --devel on the install and upgrade commands.

Launch unit tests

make test

(back to top)

License

Distributed under the Apache v2 License. See LICENSE for more information.

(back to top)