From 2727f4b92d820bb39812c0ea91e95974d6bea3b2 Mon Sep 17 00:00:00 2001 From: Hidde Beydals Date: Thu, 3 Sep 2020 10:44:04 +0200 Subject: [PATCH] docs: update helm-controller doc --- docs/components/helm/controller.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/components/helm/controller.md b/docs/components/helm/controller.md index fbaa5969..ff85b676 100644 --- a/docs/components/helm/controller.md +++ b/docs/components/helm/controller.md @@ -6,18 +6,20 @@ releases with Kubernetes manifests. ![](../../_files/helm-controller.png) 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, +Based on the creation, mutation or removal of a `HelmRelease` resource in the cluster, Helm actions are performed by the controller. Features: - Watches for `HelmRelease` objects and generates `HelmChart` objects +- Supports `HelmChart` artifacts produced from `HelmRepository` and `GitRepository` sources - Fetches artifacts produced by [source-controller](../source/controller.md) from `HelmChart` objects -- Watches `HelmChart` objects for revision changes (semver ranges) -- Performs Helm v3 actions including Helm tests as configured in the `HelmRelease` objects -- Runs Helm install/upgrade in a specific order, taking into account the depends-on relationship +- 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 - Prunes Helm releases removed from cluster (garbage collection) -- Reports Helm releases status (alerting provided by [notification-controller](../notification/controller.md)) +- Reports Helm releases statuses (alerting provided by [notification-controller](../notification/controller.md)) Links: