Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/unleash/helm-charts
Contains helm-charts for Unleash
https://github.com/unleash/helm-charts
Last synced: 7 days ago
JSON representation
Contains helm-charts for Unleash
- Host: GitHub
- URL: https://github.com/unleash/helm-charts
- Owner: Unleash
- License: apache-2.0
- Created: 2020-03-23T22:03:14.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-25T08:49:31.000Z (19 days ago)
- Last Synced: 2024-10-25T21:30:21.435Z (18 days ago)
- Language: Smarty
- Size: 296 KB
- Stars: 44
- Watchers: 4
- Forks: 58
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Unleash Kubernetes Helm Chart
[](https://opensource.org/licenses/Apache-2.0)
[](https://github.com/Unleash/helm-charts/actions/workflows/release.yaml)
## Usage
[Helm](https://helm.sh) must be installed to use the charts.
Please refer to Helm's [documentation](https://helm.sh/docs/) to get started.
Once Helm is set up properly, add the repository as follows:
```console
helm repo add unleash https://docs.getunleash.io/helm-charts
```
You can then run `helm search repo unleash` to see the charts.
## Versions
- 1.x includes Unleash v3.x
- 2.x includes Unleash v4.x
## Kubernetes support strategy
We'll build this repository on all k8s versions that have not reached End of Life according to the [Kubernetes support period](https://kubernetes.io/releases/patch-releases/#support-period).
## Contributing
The source code of all [unleash](https://unleash.github.io/) [Helm](https://helm.sh) charts can be found on Github:
We'd love to have you contribute! Please refer to our [contribution guidelines](https://github.com/unleash/helm-charts/blob/main/CONTRIBUTING.md) for details.
## License
[Apache 2.0 License](https://github.com/unleash/helm-charts/blob/main/LICENSE).
## Helm charts build status
[](https://github.com/Unleash/helm-charts/actions/workflows/release.yaml)
## Releasing the charts
To release new versions of the charts, you must update the chart version in the Chart.yaml file and then merge these modifications into the main branch. Following this, the workflow will detect these changes and automatically release a new version of the modified Helm chart.
## Helm repository
This repository employs a process that converts it into a Helm repository, specifically using the Helm Chart Releaser Action version 1.5.0. It leverages GitHub Pages for hosting the artifacts. Furthermore, the [Unleash documentation on Helm charts](https://docs.getunleash.io/helm-charts) utilizes a CNAME to direct to the GitHub Pages.
The specific workflow is outlined in the file located at .github/workflows/release.yml. This workflow activates whenever there's an update to the chart version, which consequently prompts an update to the repository with the new chart version.
## Testing the helm chart locally
To test the helm chart locally, first you should set up a local k8s environment. An easy way to do this is to set up kind, you can see instructions for setting it up [here](https://github.com/bricks-software/unleash-infra-docs/blob/main/commands/k8s.md).
Once you have your local k8s environment set up, you can run the following command to install the helm chart locally:
```bash
helm install --debug --generate-name . # this will install the chart using the local files provided you are in the folder that contains the chart
# To see the output of the helm chart without running it locally, you can run the following command:
helm install --debug --dry-run --generate-name .
```