From 3cef9ee74d966cc69a36978c996e6d98952d9d41 Mon Sep 17 00:00:00 2001
From: Otto Bittner <cobittner@posteo.net>
Date: Fri, 3 Mar 2023 12:43:33 +0100
Subject: [PATCH] cli: add doc comments for helm

---
 cli/internal/helm/client.go |  2 +-
 cli/internal/helm/helm.go   | 17 +++++++++++++++++
 cli/internal/helm/values.go |  3 +++
 3 files changed, 21 insertions(+), 1 deletion(-)
 create mode 100644 cli/internal/helm/helm.go

diff --git a/cli/internal/helm/client.go b/cli/internal/helm/client.go
index 0ed6798ef..ca40ed0d4 100644
--- a/cli/internal/helm/client.go
+++ b/cli/internal/helm/client.go
@@ -36,7 +36,7 @@ const (
 	DenyDestructive = false
 )
 
-// Client handles interaction with helm.
+// Client handles interaction with helm and the cluster.
 type Client struct {
 	config  *action.Configuration
 	kubectl crdClient
diff --git a/cli/internal/helm/helm.go b/cli/internal/helm/helm.go
new file mode 100644
index 000000000..dd6487540
--- /dev/null
+++ b/cli/internal/helm/helm.go
@@ -0,0 +1,17 @@
+/*
+Copyright (c) Edgeless Systems GmbH
+
+SPDX-License-Identifier: AGPL-3.0-only
+*/
+
+/*
+Package helm provides a higher level interface to the Helm GO SDK.
+
+It is used by the CLI to:
+- load embedded charts
+- install charts
+- update helm releases
+- get versions for installed helm releases
+- create local backups before running service upgrades
+*/
+package helm
diff --git a/cli/internal/helm/values.go b/cli/internal/helm/values.go
index 8c89014e3..efc0ef997 100644
--- a/cli/internal/helm/values.go
+++ b/cli/internal/helm/values.go
@@ -6,6 +6,7 @@ SPDX-License-Identifier: AGPL-3.0-only
 
 package helm
 
+// Values for the Cilium Helm releases for AWS.
 var awsVals = map[string]any{
 	"endpointRoutes": map[string]any{
 		"enabled": true,
@@ -44,6 +45,7 @@ var awsVals = map[string]any{
 	"kubeProxyReplacementHealthzBindAddr": "0.0.0.0:10256",
 }
 
+// Values for the Cilium Helm releases for Azure.
 var azureVals = map[string]any{
 	"endpointRoutes": map[string]any{
 		"enabled": true,
@@ -84,6 +86,7 @@ var azureVals = map[string]any{
 	"kubeProxyReplacementHealthzBindAddr": "0.0.0.0:10256",
 }
 
+// Values for the Cilium Helm releases for GCP.
 var gcpVals = map[string]any{
 	"endpointRoutes": map[string]any{
 		"enabled": true,