-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[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
- Loading branch information
Showing
4 changed files
with
39 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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!) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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:[email protected]:3128" | ||
# ``` | ||
extraEnv: [] | ||
extraEnv: [] |