Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/traefik/traefik-hub-helm-chart
Traefik Hub is a Kubernetes-native API Management solution for publishing, securing, and managing APIs. Configuration is driven by Kubernetes CRDs, labels, and selectors for effective GitOps.
https://github.com/traefik/traefik-hub-helm-chart
api api-gateway api-management ingress kubernetes openapi openapi3 swagger traefik-hub
Last synced: 2 months ago
JSON representation
Traefik Hub is a Kubernetes-native API Management solution for publishing, securing, and managing APIs. Configuration is driven by Kubernetes CRDs, labels, and selectors for effective GitOps.
- Host: GitHub
- URL: https://github.com/traefik/traefik-hub-helm-chart
- Owner: traefik
- License: apache-2.0
- Created: 2023-07-04T15:34:00.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-04T19:15:54.000Z (7 months ago)
- Last Synced: 2024-06-04T21:24:11.054Z (7 months ago)
- Topics: api, api-gateway, api-management, ingress, kubernetes, openapi, openapi3, swagger, traefik-hub
- Language: Makefile
- Homepage: https://doc.traefik.io/traefik-hub
- Size: 268 KB
- Stars: 3
- Watchers: 10
- Forks: 9
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> Since the end of May 2024, Traefik Hub and Traefik Proxy have been using the same [Traefik Helm Chart](https://github.com/traefik/traefik-helm-chart) for installation.
Traefik Hub Helm Chart
## Introduction
This chart installs the Traefik Hub agent in *Ingress Controller* mode on a Kubernetes cluster.
## Installation
### Prerequisites
1. [x] Helm **v3** [installed](https://helm.sh/docs/using_helm/#installing-helm): `helm version`
2. [x] Traefik Labs chart repository: `helm repo add traefik https://traefik.github.io/charts`
### Deploying Hub Ingres Controller for Kubernetes
```shell
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](./traefik-hub/values.yaml).
## Upgrading Hub Agent for Kubernetes
One can check what has changed in the [release](https://github.com/traefik/traefik-hub-helm-chart/releases) overview page.
Update the repository:
```shell
helm repo update
```
Check the current Chart & Traefik Hub version:
```shell
helm search repo traefik/traefik-hub
```
Upgrade Traefik Hub:
```shell
helm upgrade traefik-hub traefik/traefik-hub
```
## Upgrading CRDs
With Helm v3, CRDs created by this chart can not be updated, consult the [Helm Documentation on CRDs](https://helm.sh/docs/chart_best_practices/custom_resource_definitions) for more information.
> Please read carefully the [release notes](https://github.com/traefik/traefik-hub-helm-chart/releases) of this chart before upgrading CRDs!
```shell
kubectl apply --server-side --force-conflicts -k https://github.com/traefik/traefik-hub-helm-chart/traefik-hub/crds/
```
## Upgrading from v1.x.x
To upgrade from v1.x.x, a secret needs to be manually removed first:
```shell
kubectl delete secret hub-agent-cert -n traefik-hub
```
## Uninstall
```shell
helm uninstall traefik-hub
```
If Traefik Hub was installed in a specific namespace:
```shell
helm uninstall traefik-hub --namespace my-namespace
```
## Contributing
### Versioning
We use [Semantic Versioning](https://semver.org/).
Pull requests must bump the `version` of the chart specified in the [Chart.yaml](./traefik-hub/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
```shell
make test
```
## License
Distributed under the Apache v2 License.
See [LICENSE](./LICENSE) for more information.
