The GitOps Toolkit Helm reconciler, for declarative Helming
Go to file
dependabot[bot] c3a8dbcbe9
Bump the ci group across 1 directory with 3 updates
Bumps the ci group with 3 updates in the / directory: [korthout/backport-action](https://github.com/korthout/backport-action), [anchore/sbom-action](https://github.com/anchore/sbom-action) and [github/codeql-action](https://github.com/github/codeql-action).


Updates `korthout/backport-action` from 3.0.2 to 3.1.0
- [Release notes](https://github.com/korthout/backport-action/releases)
- [Commits](bd410d37cd...be567af183)

Updates `anchore/sbom-action` from 0.17.1 to 0.17.2
- [Release notes](https://github.com/anchore/sbom-action/releases)
- [Commits](ab9d16d4b4...61119d458a)

Updates `github/codeql-action` from 3.26.2 to 3.26.4
- [Release notes](https://github.com/github/codeql-action/releases)
- [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md)
- [Commits](429e197704...f0f3afee80)

---
updated-dependencies:
- dependency-name: korthout/backport-action
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: ci
- dependency-name: anchore/sbom-action
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: ci
- dependency-name: github/codeql-action
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: ci
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-08-22 03:55:04 +00:00
.github Bump the ci group across 1 directory with 3 updates 2024-08-22 03:55:04 +00:00
api Update dependencies to Kubernetes v1.31.0 2024-08-15 11:15:19 +03:00
config Fix: Allow upgrading from v2beta1 to v2 (GA) 2024-05-10 16:27:15 +03:00
docs doc: fix helmrelease default value for .spec.upgrade.crds 2024-05-10 19:21:50 +02:00
hack Update copyright year (GA API) 2024-05-03 17:35:01 +03:00
internal Update dependencies to Kubernetes v1.31.0 2024-08-15 11:15:19 +03:00
tests/fuzz Build with Go 1.23 2024-08-15 12:10:30 +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 Add changelog entry for v1.0.1 2024-05-10 18:13:10 +03: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 Build with Go 1.23 2024-08-15 12:10:30 +03:00
Dockerfile Build with Go 1.23 2024-08-15 12:10:30 +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 Promote `HelmRelease` API to v2 (GA) 2024-05-03 16:25:14 +03:00
PROJECT Promote `HelmRelease` API to v2 (GA) 2024-05-03 16:25:14 +03:00
README.md Add API docs for `HelmRelease` v2 2024-05-03 16:30:58 +03:00
go.mod Update dependencies to Kubernetes v1.31.0 2024-08-15 11:15:19 +03:00
go.sum Update dependencies to Kubernetes v1.31.0 2024-08-15 11:15:19 +03:00
main.go Update samples to GA APIs 2024-05-03 17:12:22 +03: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