From 1d27dbcf77698eab3df07b61a2872da5a67e43b5 Mon Sep 17 00:00:00 2001 From: Hugo Shaka Date: Mon, 18 Nov 2024 18:55:51 -0500 Subject: [PATCH] [v17] Add reference page for tbot Helm chart (#49160) * Add reference page for tbot Helm chart * Update docs/pages/reference/helm-reference/tbot.mdx * Update docs/pages/reference/helm-reference/tbot.mdx * Apply suggestions from code review * fix broken link * trick the broken markdown link checker --- .../helm-reference/zz_generated.tbot.mdx | 2 +- .../helm-reference/helm-reference.mdx | 1 + docs/pages/reference/helm-reference/tbot.mdx | 35 +++++++++++++++++++ examples/chart/tbot/values.yaml | 4 +-- 4 files changed, 39 insertions(+), 3 deletions(-) create mode 100644 docs/pages/reference/helm-reference/tbot.mdx diff --git a/docs/pages/includes/helm-reference/zz_generated.tbot.mdx b/docs/pages/includes/helm-reference/zz_generated.tbot.mdx index 036f40f8e6f8e..743030c0506b7 100644 --- a/docs/pages/includes/helm-reference/zz_generated.tbot.mdx +++ b/docs/pages/includes/helm-reference/zz_generated.tbot.mdx @@ -121,7 +121,7 @@ Ignored if `customConfig` is set. | `string` | `"kubernetes"` | `joinMethod` describes how tbot joins the Teleport cluster. -See [the join method reference](../../join-methods.mdx) for a list fo supported values and detailed explanations. +See [the join method reference](../../reference/join-methods.mdx) for a list fo supported values and detailed explanations. Ignored if `customConfig` is set. ## `token` diff --git a/docs/pages/reference/helm-reference/helm-reference.mdx b/docs/pages/reference/helm-reference/helm-reference.mdx index 61f9efaaf7d02..dad5fabc38c13 100644 --- a/docs/pages/reference/helm-reference/helm-reference.mdx +++ b/docs/pages/reference/helm-reference/helm-reference.mdx @@ -15,6 +15,7 @@ layout: tocless-doc Teleport Kubernetes Operator. - [teleport-access-graph](teleport-access-graph.mdx): Deploy the Teleport Policy Access Graph service. +- [tbot](tbot.mdx): Deploy an instance of TBot, the [MachineID](../../enroll-resources/machine-id/introduction.mdx) agent. - [teleport-plugin-event-handler](teleport-plugin-event-handler.mdx): Deploy the Teleport Event Handler plugin which sends events and session logs to Fluentd. diff --git a/docs/pages/reference/helm-reference/tbot.mdx b/docs/pages/reference/helm-reference/tbot.mdx new file mode 100644 index 0000000000000..e68ebfc5ae72a --- /dev/null +++ b/docs/pages/reference/helm-reference/tbot.mdx @@ -0,0 +1,35 @@ +--- +title: tbot Chart Reference +description: Values that can be set using the tbot Helm chart +--- + +This chart deploys an instance of the [MachineID](../../enroll-resources/machine-id/introduction.mdx) agent, +TBot, into your Kubernetes cluster. + +To use it, you will need to know: + +- The address of your Teleport Proxy Service or Auth Service +- The name of your Teleport cluster +- The name of a join token configured for Machine ID and your Kubernetes cluster + as described in the [Machine ID on Kubernetes guide](../../enroll-resources/machine-id/deployment/kubernetes.mdx) + +By default, this chart is designed to use the `kubernetes` join method but it +can be customized to use any delegated join method. We do not recommend that +you use the `token` join method with this chart. + +## Minimal configuration + +This basic configuration will write a Teleport identity file to a secret in +the deployment namespace called `test-output`. + +```yaml +clusterName: "test.teleport.sh" +teleportProxyAddress: "test.teleport.sh:443" +defaultOutput: + secretName: "test-output" +token: "my-token" +``` + +## Full reference + +(!docs/pages/includes/helm-reference/zz_generated.tbot.mdx!) diff --git a/examples/chart/tbot/values.yaml b/examples/chart/tbot/values.yaml index 680fda9d1a7fb..bdc2670142648 100644 --- a/examples/chart/tbot/values.yaml +++ b/examples/chart/tbot/values.yaml @@ -70,7 +70,7 @@ outputs: [] services: [] # joinMethod(string) -- describes how tbot joins the Teleport cluster. -# See [the join method reference](../../join-methods.mdx) for a list fo supported values and detailed explanations. +# See [the join method reference](../../reference/join-methods.mdx) for a list fo supported values and detailed explanations. # Ignored if `customConfig` is set. joinMethod: "kubernetes" @@ -226,4 +226,4 @@ extraArgs: [] # - name: HTTPS_PROXY # value: "http://username:password@my.proxy.host:3128" # ``` -extraEnv: [] \ No newline at end of file +extraEnv: []