The GitOps Toolkit Helm reconciler, for declarative Helming
Go to file
Matheus Pimenta cf5702068b
Merge pull request #1286 from cappyzawa/feat/object-level-config-validation
Add object-level configuration validation
2025-08-17 17:17:35 +01:00
.github Update dependabot config 2025-07-15 09:01:42 +03:00
api Record the last Helm release action duration in status 2025-08-13 13:36:05 +03:00
config Record the last Helm release action duration in status 2025-08-13 13:36:05 +03:00
docs Record the last Helm release action duration in status 2025-08-13 13:36:05 +03:00
hack Update copyright year (GA API) 2024-05-03 17:35:01 +03:00
internal Record the last Helm release action duration in status 2025-08-13 13:36:05 +03:00
tests/fuzz Update to Kubernetes 1.33.0 and Go 1.24.0 2025-04-29 15:51:11 +03:00
.gitignore Refactor fuzzing 2022-01-17 20:45:16 +00:00
.goreleaser.yaml Adapt config to GoRelease v2 2024-06-11 09:41:08 +03:00
CHANGELOG.md Release v1.3.0 2025-05-28 14:14:08 +01:00
CODE_OF_CONDUCT.md Add DCO and code of conduct 2020-07-10 09:18:34 +03:00
DCO Add DCO and code of conduct 2020-07-10 09:18:34 +03:00
DEVELOPMENT.md Update to Kubernetes 1.33.0 and Go 1.24.0 2025-04-29 15:51:11 +03:00
Dockerfile Update to Kubernetes 1.33.0 and Go 1.24.0 2025-04-29 15:51:11 +03:00
LICENSE Support Helm install action 2020-07-08 16:23:38 +02:00
MAINTAINERS Update MAINTAINERS info 2022-08-31 16:55:05 +02:00
Makefile Update dependencies to Kubernetes 1.32.0 and Go 1.23.0 2024-12-12 19:13:31 +02:00
PROJECT Promote `HelmRelease` API to v2 (GA) 2024-05-03 16:25:14 +03:00
README.md Update controller to OCIRepository v1 (GA) 2025-05-28 14:37:02 +03:00
go.mod Add object-level configuration validation 2025-08-18 00:51:48 +09:00
go.sum Add object-level configuration validation 2025-08-18 00:51:48 +09:00
main.go Add object-level configuration validation 2025-08-18 00:51:48 +09:00

README.md

helm-controller

CII Best Practices e2e report license release

The helm-controller is a Kubernetes operator, allowing one to declaratively manage Helm chart releases. It is part of a composable GitOps toolkit and depends on source-controller to acquire the Helm charts from Helm repositories.

The desired state of a Helm release is described through a Kubernetes Custom Resource named HelmRelease. Based on the creation, mutation or removal of a HelmRelease resource in the cluster, Helm actions are performed by the operator.

overview

Features

  • Watches for HelmRelease objects and generates HelmChart objects
  • Supports HelmChart artifacts produced from HelmRepository, GitRepository and Bucket sources
  • Fetches artifacts produced by source-controller from HelmChart and OCIRepository objects
  • Watches HelmChart objects for revision changes (including semver ranges for charts from HelmRepository sources)
  • Performs automated Helm actions, including Helm tests, rollbacks and uninstalls
  • Offers extensive configuration options for automated remediation (rollback, uninstall, retry) on failed Helm install, upgrade or test actions
  • Runs Helm install/upgrade in a specific order, taking into account the depends-on relationship defined in a set of HelmRelease objects
  • Reports Helm release statuses (alerting provided by notification-controller)
  • Built-in Kustomize compatible Helm post renderer, providing support for strategic merge, JSON 6902 and images patches
  • Supports detecting and correcting in-cluster changes compared to the desired state of the Helm release

Guides

Specifications