helm-controller

command module

v1.2.0 Latest Latest Go to latest Published: Feb 19, 2025 License: Apache-2.0 Imports: 36 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

README ¶

helm-controller

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

Documentation ¶

There is no documentation for this package.

Source Files ¶

View all Source files

main.go

Directories ¶

Path	Synopsis
api module
internal
acl
action
cmp
controller
diff
digest
errors
features Package features sets the feature gates that helm-controller supports, and their default states.	Package features sets the feature gates that helm-controller supports, and their default states.
kube TODO: this file was taken from https://github.com/helm/helm/blob/main/pkg/cli/roundtripper.go We should be able to get rid of it once https://github.com/helm/helm/issues/13052 is addressed A PR (https://github.com/helm/helm/pull/13383) was open and merged but not yet picked into any release	TODO: this file was taken from https://github.com/helm/helm/blob/main/pkg/cli/roundtripper.go We should be able to get rid of it once https://github.com/helm/helm/issues/13052 is addressed A PR (https://github.com/helm/helm/pull/13383) was open and merged but not yet picked into any release
loader
oomwatch Package oomwatch provides a way to detect near OOM conditions.	Package oomwatch provides a way to detect near OOM conditions.
postrender
predicates
reconcile
release
storage
strings
testutil

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL