README
¶
Helm Operator
The Helm Operator provides an extension to Flux that automates Helm Chart releases in a GitOps manner. A Chart release is described through a Kubernetes custom resource named HelmRelease. The Flux daemon synchronizes these resources from git to the cluster, and the Helm Operator makes sure Helm charts are released as specified in the resources.
Helm Operator features
- declarative helm install/upgrade/delete of charts
- pulls charts from public or private Helm repositories over HTTPS
- pulls charts from public or private Git repositories over SSH
- chart release values can be specified inline in the HelmRelease object or via secrets, configmaps or URLs
- automated chart upgrades based on container image tag policies (requires Flux)
- automatic purging on chart install failures
- automatic rollback on chart upgrade failures
Get started with the Helm Operator
Get started installing the Helm operator or just browse through the documentation.
Integrations
As Flux Helm Operator is Open Source, integrations are very straight-forward. Here are a few popular ones you might want to check out:
Community & Developer information
We welcome all kinds of contributions to Helm Operator, be it code, issues you found, documentation, external tools, help and support or anything else really.
The FluxCD projects adheres to the CNCF Code of Conduct.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting a Flux project maintainer, or the CNCF mediator, Mishi Choudhary mishi@linux.com.
To familiarise yourself with the project and how things work, you might be interested in the following:
Getting Help
If you have any questions about Helm Operator and continuous delivery:
- Read the Helm Operator docs.
- Invite yourself to the CNCF community slack and ask a question on the #flux channel.
- To be part of the conversation about Helm Operator's development, join the flux-dev mailing list.
- File an issue.
Your feedback is always welcome!
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
hack
|
|
|
tools
Module
|
|
|
apis/helm.fluxcd.io/v1
+k8s:deepcopy-gen=package,register +groupName=helm.fluxcd.io Package v1 is the v1 version of the API.
|
+k8s:deepcopy-gen=package,register +groupName=helm.fluxcd.io Package v1 is the v1 version of the API. |
|
chartsync
This package has the algorithm for making sure the Helm releases in the cluster match what are defined in the HelmRelease resources.
|
This package has the algorithm for making sure the Helm releases in the cluster match what are defined in the HelmRelease resources. |
|
client/clientset/versioned
This package has the automatically generated clientset.
|
This package has the automatically generated clientset. |
|
client/clientset/versioned/fake
This package has the automatically generated fake clientset.
|
This package has the automatically generated fake clientset. |
|
client/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
|
This package contains the scheme of the automatically generated clientset. |
|
client/clientset/versioned/typed/helm.fluxcd.io/v1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
|
client/clientset/versioned/typed/helm.fluxcd.io/v1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
|
status
This package is for maintaining the link between `HelmRelease` resources and the Helm releases to which they correspond.
|
This package is for maintaining the link between `HelmRelease` resources and the Helm releases to which they correspond. |