https://github.com/k3s-io/helm-controller
https://github.com/k3s-io/helm-controller
Last synced: 8 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/k3s-io/helm-controller
- Owner: k3s-io
- License: apache-2.0
- Created: 2019-04-16T21:15:59.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2026-02-17T20:10:28.000Z (about 2 months ago)
- Last Synced: 2026-02-18T00:53:37.082Z (about 2 months ago)
- Language: Go
- Size: 9.15 MB
- Stars: 485
- Watchers: 31
- Forks: 95
- Open Issues: 44
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- stars - k3s-io/helm-controller
- awesome-devops - helm-controller - A simple way to manage helm charts (v2 and v3) with a Custom Resource Definitions in k8s. (Kubernetes)
README
helm-controller
========
A simple way to manage helm charts with Custom Resource Definitions in k8s.
## Manifests and Deploying
The `./manifests` folder contains useful YAML manifests to use for deploying and developing the Helm Controller. However, we recommend using the `deploy-cluster-scoped.yaml` or `deploy-namespaced.yaml` manifests included in the releases. The YAML might need some modifications for your environment so read below for Namespaced vs Cluster deployments and how to use them properly.
#### Namespaced Deploys
Use the `deploy-namespaced.yaml` to create a namespace and add the Helm Controller and CRD to that namespace locking down the Helm Controller to only see changes to CRDs within that namespace. This is defaulted to `helm-controller` so update the YAML to your needs before running `kubectl create`
#### Cluster Scoped Deploys
If you'd like your helm controller to watch the entire cluster for HelmChart CRD changes use the `deploy-cluster-scoped.yaml` deploy manifest. By default it will add the helm-controller to the `kube-system` so update `metadata.namespace` for your needs.
## API Documentation
Autogenerated API docs for `helm.cattle.io/v1 HelmChart` and `HelmChartConfig` are available at [doc/helmchart.md](doc/helmchart.md#HelmChart)
## Uninstalling
To remove the Helm Controller run `kubectl delete` and pass the deployment YAML used using to create the Deployment `-f` parameter.
## Developing and Building
The Helm Controller is easy to get running locally, follow the instructions for your needs and requires a running k8s server + CRDs etc. When you have a working k8s cluster, you can apply the manifests inside `./pkg/crds/yaml/generated/` to create the CRD and `./manifests/example-helmchart.yaml` which runs the `stable/traefik` helm chart.
### Build
Run `make build` to build the binary and, optionally, generate new CRDs if the API changed. We recommend just running `make` as the default target will also perform validation and testing.
#### Running it locally
Building and running natively will start a daemon which will watch a local k8s API. See Manifests section above about how to create the CRD and Objects using the provided manifests.
```
go build -o ./bin/helm-controller
./bin/helm-controller --kubeconfig $HOME/.kube/config
```
#### Running it on k8s
Use the `deploy-cluster-scoped.yaml` or `deploy-namespaced.yaml` manifests in the assets of each release to run the helm-controller in Kubernetes.
#### Options and Usage
Use `./bin/helm-controller help` to get full usage details. The outside of a k8s Pod the most important options are `--kubeconfig` or `--masterurl` or it will not run. All options have corresponding ENV variables you could use.
## Testing/Validating
`make test`
`make validate`
## License
Copyright (c) 2019 [Rancher Labs, Inc.](http://rancher.com)
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
[http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.