From 23c65c61d452991cfeb3f7b62c1755308a0f9b43 Mon Sep 17 00:00:00 2001
From: Noah Stride <noah.stride@goteleport.com>
Date: Mon, 29 Jul 2024 18:19:55 +0100
Subject: [PATCH] Add docstrings to all values

---
 examples/chart/tbot/values.yaml | 46 ++++++++++++++++++++++-----------
 1 file changed, 31 insertions(+), 15 deletions(-)

diff --git a/examples/chart/tbot/values.yaml b/examples/chart/tbot/values.yaml
index f042dca16d82f..472a933653533 100644
--- a/examples/chart/tbot/values.yaml
+++ b/examples/chart/tbot/values.yaml
@@ -1,6 +1,13 @@
+# image(string) -- sets the container image used for tbot pods created by this
+# chart.
+#
+# You can override this to use your own tbot image rather than a
+# Teleport-published image.
 image: public.ecr.aws/gravitational/tbot-distroless
-# clusterName should be the name of the Teleport cluster that your Bot will
-# join.
+# clusterName(string) -- should be the name of the Teleport cluster that your
+# Bot will join.
+#
+# For example: `clusterName: "test.teleport.sh"`
 clusterName: ""
 
 # teleportAuthAddress(string)
@@ -10,25 +17,19 @@ teleportAuthAddress: ""
 # Mutually exclusive with teleportAuthAddress.
 teleportProxyAddress: ""
 
+# defaultOutput -- controls the default output configured for the tbot agent.
 defaultOutput:
+  # defaultOutput.enabled(bool) -- controls whether the default output is enabled.
   enabled: true
+  # defaultOutput.secretName(string) -- sets the name of the Kubernetes Secret
+  # that the default output will be written to.
   secretName: ""
 
+# customConfig -- allows you to provide a custom tbot configuration. If set,
+# this config will replace the one generated by the helm chart, meaning that
+# certain values within this file will be meaningless.
 customConfig: {}
 
-# serviceAccount -- controls the Kubernetes ServiceAccounts deployed and used by
-# the chart.
-serviceAccount:
-  # serviceAccount.create(bool) -- controls whether Helm Chart creates the
-  # Kubernetes `ServiceAccount` resources for the agent.
-  # When off, you are responsible for creating the appropriate ServiceAccount
-  # resources.
-  create: true
-  # serviceAccount.name(string) -- sets the name of the `ServiceAccount` resource
-  # used by the chart. By default, the `ServiceAccount` has the name of the
-  # Helm release.
-  name: ""
-
 # joinMethod(string) -- describes how tbot joins the Teleport cluster.
 joinMethod: "kubernetes"
 
@@ -54,9 +55,24 @@ token: ""
 # </Admonition>
 teleportVersionOverride: ""
 
+# anonymousTelemetry(bool) -- controls whether anonymous telemetry is enabled.
 anonymousTelemetry: false
+# debug(bool) -- controls whether the tbot agent runs in debug mode.
 debug: false
 
+# serviceAccount -- controls the Kubernetes ServiceAccounts deployed and used by
+# the chart.
+serviceAccount:
+  # serviceAccount.create(bool) -- controls whether Helm Chart creates the
+  # Kubernetes `ServiceAccount` resources for the agent.
+  # When off, you are responsible for creating the appropriate ServiceAccount
+  # resources.
+  create: true
+  # serviceAccount.name(string) -- sets the name of the `ServiceAccount` resource
+  # used by the chart. By default, the `ServiceAccount` has the name of the
+  # Helm release.
+  name: ""
+
 # imagePullPolicy(string) -- sets the pull policy for any pods created by the chart.
 # See [the Kubernetes documentation](https://kubernetes.io/docs/concepts/containers/images/#updating-images)
 # for more details.