77
88The helm-controller is a Kubernetes operator, allowing one to declaratively
99manage Helm chart releases. It is part of a composable [ GitOps toolkit] ( https://toolkit.fluxcd.io )
10- and depends on [ source-controller] ( https://github.com/fluxcd/source-controller )
11- to acquire the Helm charts from Helm repositories.
10+ and depends on [ source-controller] [ ] to acquire the Helm charts from Helm
11+ repositories.
1212
1313The desired state of a Helm release is described through a Kubernetes Custom
1414Resource named ` HelmRelease ` . Based on the creation, mutation or removal of a
@@ -17,16 +17,35 @@ operator.
1717
1818![ overview] ( docs/diagrams/helm-controller-overview.png )
1919
20- Features:
21-
22- * watches for ` HelmRelease ` objects
23- * fetches artifacts produced by [ source-controller] ( https://github.com/fluxcd/source-controller )
24- from ` Source ` objects
25- * watches ` Source ` objects for revision changes
26- * performs Helm actions as configured in the ` HelmRelease `
27- * runs ` HelmReleases ` in a specific order, taking into account the depends-on relationship
28-
29- Specifications:
20+ ## Features
21+
22+ * Watches for ` HelmRelease ` objects and generates ` HelmChart ` objects
23+ * Supports ` HelmChart ` artifacts produced from ` HelmRepository ` and
24+ ` GitRepository ` sources
25+ * Fetches artifacts produced by [ source-controller] [ ] from ` HelmChart `
26+ objects
27+ * Watches ` HelmChart ` objects for revision changes (including semver
28+ ranges for charts from ` HelmRepository ` sources)
29+ * Performs automated Helm actions, including Helm tests, rollbacks and
30+ uninstalls
31+ * Offers extensive configuration options for automated remediation
32+ (rollback, uninstall, retry) on failed Helm install, upgrade or test
33+ actions.
34+ * Runs Helm install/upgrade in a specific order, taking into account the
35+ depends-on relationship defined in a set of ` HelmRelease ` objects
36+ * Reports Helm release statuses (alerting provided by
37+ [ notification-controller] [ ] )
38+
39+ ## Guides
40+
41+ * [ Get started with GitOps Toolkit] ( https://toolkit.fluxcd.io/get-started/ )
42+ * [ Manage Helm Releases] ( https://toolkit.fluxcd.io/guides/helmreleases/ )
43+ * [ Setup Notifications] ( https://toolkit.fluxcd.io/guides/notifications/ )
44+
45+ ## Specifications
3046
3147* [ API] ( docs/spec/v2alpha1/README.md )
3248* [ Controller] ( docs/spec/README.md )
49+
50+ [ source-controller ] : https://github.com/fluxcd/source-controller
51+ [ notification-controller ] : https://github.com/fluxcd/notification-controller
0 commit comments