Traefik Hub Helm Chart

Introduction

This chart installs the Hub agent in a Kubernetes cluster. The agent consists of two deployments: a controller and multiple authentication servers.

Installation

Prerequisites

Helm v3 installed: helm version
Traefik's chart repository: helm repo add traefik https://traefik.github.io/charts

Deploying Hub Agent for Kubernetes

helm install hub-agent traefik/hub-agent

You can customize the install with a values file. There are some EXAMPLES provided. Complete documentation on all parameters is in the default file

Upgrading Hub Agent for Kubernetes

One can check what has changed in the Releases.

# Update repository
helm repo update
# See current Chart & Hub Agent version
helm search repo traefik/hub-agent
# Upgrade Hub Agent
helm upgrade hub-agent traefik/hub-agent

Upgrading CRDs

With Helm v3, CRDs created by this chart can not be updated, cf the Helm Documentation on CRDs. Please read carefully release notes of this chart before upgrading CRDs.

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

Uninstall

helm uninstall hub-agent

If hub-agent was installed in a specific namespace

helm uninstall hub-agent --namespace hub-namespace

Contributing

Versioning

We use Semantic Versioning.

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

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 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 are 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

mmatur / hub-helm-chart