gravitational/teleport
1
0
Fork 0
mirror of https://github.com/gravitational/teleport.git synced 2026-10-12 02:15:01 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
0d1113f5de7ef287c6a7d872f5f8177826840d3e
teleport/docs/pages/includes/helm-reference/zz_generated.access-mattermost.mdx
T
Paul Gottschling 0d1113f5de Consolidate Reference docs section contents (#58248) 
* Consolidate Reference docs section contents

Closes #56206

Reduce the number of first-level children in the Reference section of
the docs from 23 to 9, not counting the index page available at
`/docs/reference/`. This makes the Reference section easier to navigate,
since a user can more readily form a mental model of the content
available in the section with fewer items and a more thematic
organization.

- Add a section for deployment references, consolidating reference
  guides for configuring and architecting a Teleport deployment.
- Move the Predicate Language and User Types references into the Access
  Controls section of References.
- Add a section for API reference guides, consolidating the Terraform,
  MWI Terraform, and Operator sections.
- Move Cloud FAQ to Quick Links. This places the guide next to the main
  FAQ in the sidebar to make it more discoverable, since the guide is
  currently rather hidden. This also helps pave the way to merge the two
  FAQs in the future.

* Add an MWI reference section

The MWI Terraform module reference does not belong with reference guides
for API clients. Add a section to the reference guide for Machine &
Workload Identity.

* Rename "API" to "Infrastructure as Code"

Teleport users expect tctl, Operator, and Terraform Provider docs to be
in an Infrastructure as Code reference section, rather than the more
vague "API" section.

Responds to **ravicious** feedback.
2025-09-12 14:42:13 +00:00

379 lines
11 KiB
Plaintext
Raw Blame History

{/* Generated file. Do not edit.*/}
{/* Generate this file by navigating to examples/chart and running make render-chart-ref*/}
## `teleport`
`teleport` contains the configuration describing how the plugin connects to
your Teleport cluster.
### `teleport.address`
| Type | Default |
|------|---------|
| `string` | `""` |
`teleport.address` is the address of the Teleport cluster the plugin
connects to. The address must contain both the domain name and the port of
the Teleport cluster. It can be either the address of the auth servers or the
proxy servers.
For example:
- joining a Proxy: `teleport.example.com:443` or `teleport.example.com:3080`
- joining an Auth: `teleport-auth.example.com:3025`
When the address is empty, `tbot.teleportProxyAddress`
or `tbot.teleportAuthAddress` will be used if they are set.
### `teleport.identitySecretName`
| Type | Default |
|------|---------|
| `string` | `""` |
`teleport.identitySecretName` is the name of the Kubernetes secret
that contains the credentials for the connection to your Teleport cluster.
The secret should be in the following format:
```yaml
apiVersion: v1
kind: Secret
type: Opaque
metadata:
name: teleport-plugin-identity
data:
auth_id: #...
```
Check out the [Access Requests with
Mattermost](../../identity-governance/access-request-plugins/ssh-approval-mattermost.mdx) guide
for more information about how to acquire these credentials.
### `teleport.identitySecretPath`
| Type | Default |
|------|---------|
| `string` | `"auth_id"` |
`teleport.identitySecretPath` is the key in the Kubernetes secret
specified by `teleport.identitySecretName` that holds the credentials for
the connection to your Teleport cluster. If the secret has the path,
`"auth_id"`, you can omit this field.
## `mattermost`
`mattermost` contains the configuration used by the plugin to authenticate to Mattermost.
You can pass the Mattermost token:
- via the chart Values by setting `mattermost.token`
- via an existing Kubernetes Secret by setting `mattermost.tokenFromSecret`
### `mattermost.url`
| Type | Default |
|------|---------|
| `string` | `""` |
`mattermost.url` is the Jira URL. For example: `https://mattermost.example.com`.
### `mattermost.token`
| Type | Default |
|------|---------|
| `string` | `""` |
`mattermost.token` is the Mattermost token used by the plugin to interact
with Mattermost. When set, the Chart creates a Kubernetes Secret for you.
This value has no effect if `mattermost.tokenFromSecret` is set.
### `mattermost.tokenFromSecret`
| Type | Default |
|------|---------|
| `string` | `""` |
`mattermost.tokenFromSecret` is the name of the Kubernetes Secret
containing the Mattermost token. When this value is set, you must create the
Secret before creating the chart release.
### `mattermost.tokenSecretPath`
| Type | Default |
|------|---------|
| `string` | `"mattermostToken"` |
`mattermost.tokenSecretPath` is the Kubernetes Secret key
containing the Mattermost token. The secret name is set via `mattermost.tokenFromSecret`.
### `mattermost.recipients`
| Type | Default |
|------|---------|
| `list[string]` | `[]` |
`mattermost.recipients` is the list of recipients who should be
notified for each Access Request.
## `log`
`log` controls the plugin logging.
### `log.severity`
| Type | Default |
|------|---------|
| `string` | `"INFO"` |
`log.severity` is the log level for the Teleport process.
Available log levels are: `DEBUG`, `INFO`, `WARN`, `ERROR`.
The default is `INFO`, which is recommended in production.
`DEBUG` is useful during first-time setup or to see more detailed logs for debugging.
### `log.output`
| Type | Default |
|------|---------|
| `string` | `"stdout"` |
`log.output` sets the output destination for the Teleport process.
This can be set to any of the built-in values: `stdout`, `stderr`.
The value can also be set to a file path (such as `/var/log/teleport.log`)
to write logs to a file. Bear in mind that a few service startup messages
will still go to `stderr` for resilience.
## `tbot`
`tbot` controls the optional tbot deployment that obtains and renews
credentials for the plugin to connect to Teleport.
Only default and mandatory values are described here, see the tbot chart reference
for the full list of supported values.
### `tbot.enabled`
| Type | Default |
|------|---------|
| `bool` | `false` |
`tbot.enabled` controls if tbot should be deployed with the Mattermost plugin.
### `tbot.clusterName`
| Type | Default |
|------|---------|
| `string` | `""` |
`tbot.clusterName` is the name of the Teleport cluster tbot and the Mattermost plugin will join.
Setting this value is mandatory when tbot is enabled.
### `tbot.teleportProxyAddress`
| Type | Default |
|------|---------|
| `string` | `""` |
`tbot.teleportProxyAddress` is the teleport Proxy Service address the bot will connect to.
This must contain the port number, usually 443 or 3080 for Proxy Service.
Connecting to the Proxy Service is the most common and recommended way to connect to Teleport.
This is mandatory to connect to Teleport Enterprise (Cloud).
This setting is mutually exclusive with `teleportAuthAddress`.
For example:
```yaml
tbot:
teleportProxyAddress: "test.teleport.sh:443"
```
### `tbot.teleportAuthAddress`
| Type | Default |
|------|---------|
| `string` | `""` |
`tbot.teleportAuthAddress` is the teleport Auth Service address the bot will connect to.
This must contain the port number, usually 3025 for Auth Service. Direct Auth Service connection
should be used when you are deploying the bot in the same Kubernetes cluster than your `teleport-cluster`
Helm release and have direct access to the Auth Service.
Else, you should prefer connecting via the Proxy Service.
This setting is mutually exclusive with `teleportProxyAddress`.
For example:
```yaml
teleportAuthAddress: "teleport-auth.teleport-namespace.svc.cluster.local:3025"
```
### `tbot.joinMethod`
| Type | Default |
|------|---------|
| `string` | `"kubernetes"` |
`tbot.joinMethod` describes how tbot joins the Teleport cluster.
See [the join method reference](../../reference/deployment/join-methods.mdx) for a list fo supported values and detailed explanations.
## `annotations`
`annotations` contains annotations to apply to the different Kubernetes
objects created by the chart. See [the Kubernetes annotation
documentation](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/)
for more details.
### `annotations.config`
| Type | Default |
|------|---------|
| `object` | `{}` |
`annotations.config` contains the Kubernetes annotations
put on the `ConfigMap` resource created by the chart.
### `annotations.deployment`
| Type | Default |
|------|---------|
| `object` | `{}` |
`annotations.deployment` contains the Kubernetes annotations
put on the `Deployment` or `StatefulSet` resource created by the chart.
### `annotations.pod`
| Type | Default |
|------|---------|
| `object` | `{}` |
`annotations.pod` contains the Kubernetes annotations
put on the `Pod` resources created by the chart.
### `annotations.secret`
| Type | Default |
|------|---------|
| `object` | `{}` |
`annotations.secret` contains the Kubernetes annotations
put on the `Secret` resource created by the chart.
This has no effect when `joinTokenSecret.create` is `false`.
## `image`
`image` sets the container image used for plugin pods created by the chart.
You can override this to use your own plugin image rather than a Teleport-published image.
### `image.repository`
| Type | Default |
|------|---------|
| `string` | `"public.ecr.aws/gravitational/teleport-plugin-mattermost"` |
`image.repository` is the image repository.
### `image.pullPolicy`
| Type | Default |
|------|---------|
| `string` | `"IfNotPresent"` |
`image.pullPolicy` is the [Kubernetes image pull policy](https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy).
### `image.tag`
| Type | Default |
|------|---------|
| `string` | `""` |
`image.tag` Overrides the image tag whose default is the chart appVersion.
Normally, the version of the Teleport plugin matches the
version of the chart. If you install chart version 15.0.0, you'll use
the plugin version 15.0.0. Upgrading the plugin is done by upgrading the chart.
<Admonition type="warning">
`image.tag` is intended for development and custom tags. This MUST NOT be
used to control the plugin version in a typical deployment. This
chart is designed to run a specific plugin version. You will face
compatibility issues trying to run a different version with it.
If you want to run the Teleport plugin version `X.Y.Z`, you should use
`helm install --version X.Y.Z` instead.
</Admonition>
## `imagePullSecrets`
| Type | Default |
|------|---------|
| `list` | `[]` |
`imagePullSecrets` is a list of secrets containing authorization tokens
which can be optionally used to access a private Docker registry.
See the [Kubernetes reference](https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod) for more details.
## `podSecurityContext`
| Type | Default |
|------|---------|
| `object` | `{}` |
`podSecurityContext` sets the pod security context for any pods created by the chart.
See [the Kubernetes documentation](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-pod)
for more details.
To unset the security context, set it to `null` or `~`.
## `securityContext`
| Type | Default |
|------|---------|
| `object` | `{}` |
`securityContext` sets the container security context for any pods created by the chart.
See [the Kubernetes documentation](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-the-security-context-for-a-container)
for more details.
To unset the security context, set it to `null` or `~`.
## `resources`
| Type | Default |
|------|---------|
| `object` | `{}` |
`resources` sets the resource requests/limits for any pods created by the chart.
See [the Kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/)
for more details.
## `nodeSelector`
| Type | Default |
|------|---------|
| `object` | `{}` |
`nodeSelector` sets the node selector for any pods created by the chart.
See [the Kubernetes documentation](https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector)
for more details.
## `tolerations`
| Type | Default |
|------|---------|
| `list` | `[]` |
`tolerations` sets the tolerations for any pods created by the chart.
See [the Kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/)
for more details.
## `affinity`
| Type | Default |
|------|---------|
| `object` | `{}` |
`affinity` sets the affinities for any pods created by the chart.
See [the Kubernetes documentation](https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity)
for more details.
Reference in New Issue View Git Blame Copy Permalink