https://github.com/traefik/hub-helm-chart
Traefik Hub helm chart
https://github.com/traefik/hub-helm-chart
helm-charts infra traefik-hub
Last synced: about 1 year ago
JSON representation
Traefik Hub helm chart
- Host: GitHub
- URL: https://github.com/traefik/hub-helm-chart
- Owner: traefik
- License: apache-2.0
- Created: 2021-03-15T09:10:18.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-04-27T13:34:54.000Z (about 3 years ago)
- Last Synced: 2023-04-27T14:41:14.852Z (about 3 years ago)
- Topics: helm-charts, infra, traefik-hub
- Language: Smarty
- Homepage:
- Size: 154 KB
- Stars: 8
- Watchers: 12
- Forks: 14
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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
1. [x] Helm **v3** [installed](https://helm.sh/docs/using_helm/#installing-helm): `helm version`
2. [x] Traefik's chart repository: `helm repo add traefik https://traefik.github.io/charts`
### Deploying Hub Agent for Kubernetes
```bash
helm install hub-agent traefik/hub-agent
```
You can customize the install with a `values` file. There are some [EXAMPLES](./EXAMPLES.md) provided.
Complete documentation on all parameters is in the [default file](./hub-agent/values.yaml)
## Upgrading Hub Agent for Kubernetes
One can check what has changed in the [Releases](https://github.com/traefik/hub-helm-chart/releases).
```bash
# 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](https://helm.sh/docs/chart_best_practices/custom_resource_definitions). Please read carefully release notes of this chart before upgrading CRDs.
```bash
kubectl apply --server-side --force-conflicts -k https://github.com/traefik/hub-helm-chart/hub-agent/crds/
```
## Uninstall
```bash
helm uninstall hub-agent
```
If hub-agent was installed in a specific namespace
```bash
helm uninstall hub-agent --namespace hub-namespace
```
## Contributing
### Versioning
We use [Semantic Versioning](https://semver.org/).
Pull requests must bump the `version` of the chart specified in [Chart.yaml](./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
```bash
make test
```