Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[v17] Add reference page for tbot Helm chart #49160

Merged
merged 6 commits into from
Nov 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/pages/includes/helm-reference/zz_generated.tbot.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
1 change: 1 addition & 0 deletions docs/pages/reference/helm-reference/helm-reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
35 changes: 35 additions & 0 deletions docs/pages/reference/helm-reference/tbot.mdx
Original file line number Diff line number Diff line change
@@ -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!)
4 changes: 2 additions & 2 deletions examples/chart/tbot/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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"

Expand Down Expand Up @@ -226,4 +226,4 @@ extraArgs: []
# - name: HTTPS_PROXY
# value: "http://username:password@my.proxy.host:3128"
# ```
extraEnv: []
extraEnv: []
Loading