Add helm-controller docs

2026-02-06 10:55:56 +00:00 · 2020-07-13 18:45:14 +03:00
parent 02521b6964
commit 24418370f1
37 changed files with 76 additions and 34 deletions
--- a/docs/_files/helm-controller.png
+++ b/docs/_files/helm-controller.png
--- a/docs/cmd/tk.md
+++ b/docs/cmd/tk.md
@@ -67,7 +67,7 @@ Command line utility for assembling Kubernetes CD pipelines the GitOps way.
 ### Options

 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
  -h, --help                 help for tk
      --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
      --namespace string     the namespace scope for this operation (default "gitops-system")
--- a/docs/cmd/tk_bootstrap.md
+++ b/docs/cmd/tk_bootstrap.md
@@ -16,7 +16,7 @@ The bootstrap sub-commands bootstrap the toolkit components on the targeted Git
 ### Options inherited from parent commands

 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
      --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
      --namespace string     the namespace scope for this operation (default "gitops-system")
      --timeout duration     timeout for this operation (default 5m0s)
--- a/docs/cmd/tk_bootstrap_github.md
+++ b/docs/cmd/tk_bootstrap_github.md
@@ -54,7 +54,7 @@ tk bootstrap github [flags]
 ### Options inherited from parent commands

 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
      --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
      --namespace string     the namespace scope for this operation (default "gitops-system")
      --timeout duration     timeout for this operation (default 5m0s)
--- a/docs/cmd/tk_bootstrap_gitlab.md
+++ b/docs/cmd/tk_bootstrap_gitlab.md
@@ -50,7 +50,7 @@ tk bootstrap gitlab [flags]
 ### Options inherited from parent commands

 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
      --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
      --namespace string     the namespace scope for this operation (default "gitops-system")
      --timeout duration     timeout for this operation (default 5m0s)
--- a/docs/cmd/tk_check.md
+++ b/docs/cmd/tk_check.md
@@ -32,7 +32,7 @@ tk check [flags]
 ### Options inherited from parent commands

 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
      --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
      --namespace string     the namespace scope for this operation (default "gitops-system")
      --timeout duration     timeout for this operation (default 5m0s)
--- a/docs/cmd/tk_completion.md
+++ b/docs/cmd/tk_completion.md
@@ -33,7 +33,7 @@ To configure your bash shell to load completions for each session add to your ba
 ### Options inherited from parent commands

 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
      --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
      --namespace string     the namespace scope for this operation (default "gitops-system")
      --timeout duration     timeout for this operation (default 5m0s)
--- a/docs/cmd/tk_create.md
+++ b/docs/cmd/tk_create.md
@@ -17,7 +17,7 @@ The create sub-commands generate sources and resources.
 ### Options inherited from parent commands

 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
      --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
      --namespace string     the namespace scope for this operation (default "gitops-system")
      --timeout duration     timeout for this operation (default 5m0s)
--- a/docs/cmd/tk_create_kustomization.md
+++ b/docs/cmd/tk_create_kustomization.md
@@ -63,7 +63,7 @@ tk create kustomization [name] [flags]
 ### Options inherited from parent commands

 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
      --export               export in YAML format to stdout
      --interval duration    source sync interval (default 1m0s)
      --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
--- a/docs/cmd/tk_create_source.md
+++ b/docs/cmd/tk_create_source.md
@@ -15,7 +15,7 @@ The create source sub-commands generate sources.
 ### Options inherited from parent commands

 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
      --export               export in YAML format to stdout
      --interval duration    source sync interval (default 1m0s)
      --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
--- a/docs/cmd/tk_create_source_git.md
+++ b/docs/cmd/tk_create_source_git.md
@@ -70,7 +70,7 @@ tk create source git [name] [flags]
 ### Options inherited from parent commands

 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
      --export               export in YAML format to stdout
      --interval duration    source sync interval (default 1m0s)
      --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
--- a/docs/cmd/tk_delete.md
+++ b/docs/cmd/tk_delete.md
@@ -16,7 +16,7 @@ The delete sub-commands delete sources and resources.
 ### Options inherited from parent commands

 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
      --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
      --namespace string     the namespace scope for this operation (default "gitops-system")
      --timeout duration     timeout for this operation (default 5m0s)
--- a/docs/cmd/tk_delete_kustomization.md
+++ b/docs/cmd/tk_delete_kustomization.md
@@ -19,7 +19,7 @@ tk delete kustomization [name] [flags]
 ### Options inherited from parent commands

 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
      --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
      --namespace string     the namespace scope for this operation (default "gitops-system")
  -s, --silent               delete resource without asking for confirmation
--- a/docs/cmd/tk_delete_source.md
+++ b/docs/cmd/tk_delete_source.md
@@ -15,7 +15,7 @@ The delete source sub-commands delete sources.
 ### Options inherited from parent commands

 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
      --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
      --namespace string     the namespace scope for this operation (default "gitops-system")
  -s, --silent               delete resource without asking for confirmation
--- a/docs/cmd/tk_delete_source_git.md
+++ b/docs/cmd/tk_delete_source_git.md
@@ -19,7 +19,7 @@ tk delete source git [name] [flags]
 ### Options inherited from parent commands

 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
      --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
      --namespace string     the namespace scope for this operation (default "gitops-system")
  -s, --silent               delete resource without asking for confirmation
--- a/docs/cmd/tk_export.md
+++ b/docs/cmd/tk_export.md
@@ -16,7 +16,7 @@ The export sub-commands export resources in YAML format.
 ### Options inherited from parent commands

 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
      --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
      --namespace string     the namespace scope for this operation (default "gitops-system")
      --timeout duration     timeout for this operation (default 5m0s)
--- a/docs/cmd/tk_export_kustomization.md
+++ b/docs/cmd/tk_export_kustomization.md
@@ -31,7 +31,7 @@ tk export kustomization [name] [flags]

 ```
      --all                  select all resources
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
      --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
      --namespace string     the namespace scope for this operation (default "gitops-system")
      --timeout duration     timeout for this operation (default 5m0s)
--- a/docs/cmd/tk_export_source.md
+++ b/docs/cmd/tk_export_source.md
@@ -17,7 +17,7 @@ The export source sub-commands export sources in YAML format.

 ```
      --all                  select all resources
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
      --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
      --namespace string     the namespace scope for this operation (default "gitops-system")
      --timeout duration     timeout for this operation (default 5m0s)
--- a/docs/cmd/tk_export_source_git.md
+++ b/docs/cmd/tk_export_source_git.md
@@ -31,7 +31,7 @@ tk export source git [name] [flags]

 ```
      --all                  select all resources
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
      --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
      --namespace string     the namespace scope for this operation (default "gitops-system")
      --timeout duration     timeout for this operation (default 5m0s)
--- a/docs/cmd/tk_get.md
+++ b/docs/cmd/tk_get.md
@@ -15,7 +15,7 @@ The get sub-commands print the statuses of sources and resources.
 ### Options inherited from parent commands

 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
      --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
      --namespace string     the namespace scope for this operation (default "gitops-system")
      --timeout duration     timeout for this operation (default 5m0s)
--- a/docs/cmd/tk_get_kustomizations.md
+++ b/docs/cmd/tk_get_kustomizations.md
@@ -19,7 +19,7 @@ tk get kustomizations [flags]
 ### Options inherited from parent commands

 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
      --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
      --namespace string     the namespace scope for this operation (default "gitops-system")
      --timeout duration     timeout for this operation (default 5m0s)
--- a/docs/cmd/tk_get_sources.md
+++ b/docs/cmd/tk_get_sources.md
@@ -15,7 +15,7 @@ The get source sub-commands print the statuses of the sources.
 ### Options inherited from parent commands

 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
      --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
      --namespace string     the namespace scope for this operation (default "gitops-system")
      --timeout duration     timeout for this operation (default 5m0s)
--- a/docs/cmd/tk_get_sources_git.md
+++ b/docs/cmd/tk_get_sources_git.md
@@ -19,7 +19,7 @@ tk get sources git [flags]
 ### Options inherited from parent commands

 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
      --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
      --namespace string     the namespace scope for this operation (default "gitops-system")
      --timeout duration     timeout for this operation (default 5m0s)
--- a/docs/cmd/tk_install.md
+++ b/docs/cmd/tk_install.md
@@ -37,7 +37,7 @@ tk install [flags]
 ### Options inherited from parent commands

 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
      --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
      --namespace string     the namespace scope for this operation (default "gitops-system")
      --timeout duration     timeout for this operation (default 5m0s)
--- a/docs/cmd/tk_resume.md
+++ b/docs/cmd/tk_resume.md
@@ -15,7 +15,7 @@ The resume sub-commands resume a suspended resource.
 ### Options inherited from parent commands

 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
      --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
      --namespace string     the namespace scope for this operation (default "gitops-system")
      --timeout duration     timeout for this operation (default 5m0s)
--- a/docs/cmd/tk_resume_kustomization.md
+++ b/docs/cmd/tk_resume_kustomization.md
@@ -20,7 +20,7 @@ tk resume kustomization [name] [flags]
 ### Options inherited from parent commands

 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
      --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
      --namespace string     the namespace scope for this operation (default "gitops-system")
      --timeout duration     timeout for this operation (default 5m0s)
--- a/docs/cmd/tk_suspend.md
+++ b/docs/cmd/tk_suspend.md
@@ -15,7 +15,7 @@ The suspend sub-commands suspend the reconciliation of a resource.
 ### Options inherited from parent commands

 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
      --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
      --namespace string     the namespace scope for this operation (default "gitops-system")
      --timeout duration     timeout for this operation (default 5m0s)
--- a/docs/cmd/tk_suspend_kustomization.md
+++ b/docs/cmd/tk_suspend_kustomization.md
@@ -19,7 +19,7 @@ tk suspend kustomization [name] [flags]
 ### Options inherited from parent commands

 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
      --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
      --namespace string     the namespace scope for this operation (default "gitops-system")
      --timeout duration     timeout for this operation (default 5m0s)
--- a/docs/cmd/tk_sync.md
+++ b/docs/cmd/tk_sync.md
@@ -15,7 +15,7 @@ The sync sub-commands trigger a reconciliation of sources and resources.
 ### Options inherited from parent commands

 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
      --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
      --namespace string     the namespace scope for this operation (default "gitops-system")
      --timeout duration     timeout for this operation (default 5m0s)
--- a/docs/cmd/tk_sync_kustomization.md
+++ b/docs/cmd/tk_sync_kustomization.md
@@ -32,7 +32,7 @@ tk sync kustomization [name] [flags]
 ### Options inherited from parent commands

 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
      --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
      --namespace string     the namespace scope for this operation (default "gitops-system")
      --timeout duration     timeout for this operation (default 5m0s)
--- a/docs/cmd/tk_sync_source.md
+++ b/docs/cmd/tk_sync_source.md
@@ -15,7 +15,7 @@ The sync source sub-commands trigger a reconciliation of sources.
 ### Options inherited from parent commands

 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
      --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
      --namespace string     the namespace scope for this operation (default "gitops-system")
      --timeout duration     timeout for this operation (default 5m0s)
--- a/docs/cmd/tk_sync_source_git.md
+++ b/docs/cmd/tk_sync_source_git.md
@@ -27,7 +27,7 @@ tk sync source git [name] [flags]
 ### Options inherited from parent commands

 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
      --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
      --namespace string     the namespace scope for this operation (default "gitops-system")
      --timeout duration     timeout for this operation (default 5m0s)
--- a/docs/cmd/tk_uninstall.md
+++ b/docs/cmd/tk_uninstall.md
@@ -34,7 +34,7 @@ tk uninstall [flags]
 ### Options inherited from parent commands

 ```
-      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,notification-controller])
+      --components strings   list of components, accepts comma-separated values (default [source-controller,kustomize-controller,helm-controller,notification-controller])
      --kubeconfig string    path to the kubeconfig file (default "~/.kube/config")
      --namespace string     the namespace scope for this operation (default "gitops-system")
      --timeout duration     timeout for this operation (default 5m0s)
--- a/docs/components/helm/controller.md
+++ b/docs/components/helm/controller.md
@@ -0,0 +1,25 @@
+# Helm Controller
+
+The Helm Controller is a Kubernetes operator, allowing one to declaratively manage Helm chart
+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,
+Helm actions are performed by the controller.
+
+Features:
+
+- Watches for `HelmRelease` objects and generates `HelmChart` objects
+- 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
+- Prunes Helm releases removed from cluster (garbage collection) 
+- Reports Helm releases status (alerting provided by [notification-controller](../notification/controller.md))
+
+Links:
+
+- Source code [fluxcd/helm-controller](https://github.com/fluxcd/helm-controller)
+- Specification [docs](https://github.com/fluxcd/helm-controller/tree/master/docs/spec)
--- a/docs/index.md
+++ b/docs/index.md
@@ -41,10 +41,12 @@ Components:
    - [HelmRepository CRD](components/source/helmrepositories.md)
 - [Kustomize Controller](components/kustomize/controller.md)
    - [Kustomization CRD](components/kustomize/kustomization.md)
+- [Helm Controller](components/helm/controller.md)
+    - [HelmRelease CRD](components/helm/helmreleases.md)
 - [Notification Controller](components/notification/controller.md)
    - [Provider CRD](components/notification/provider.md)
    - [Alert CRD](components/notification/alert.md)
    - [Receiver CRD](components/notification/receiver.md)
- Helm Controller (TBA)
+

 To get started with the toolkit please follow this [guide](get-started/index.md).