Skip to content
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
73 changes: 73 additions & 0 deletions docs/pages/includes/helm-reference/zz_generated.access-discord.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ 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`

Expand Down Expand Up @@ -145,6 +147,77 @@ 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 Discord plugin.

### `tbot.clusterName`

| Type | Default |
|------|---------|
| `string` | `""` |

`tbot.clusterName` is the name of the Teleport cluster tbot and the Discord 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/join-methods.mdx) for a list fo supported values and detailed explanations.

## `annotations`

`annotations` contains annotations to apply to the different Kubernetes
Expand Down
73 changes: 73 additions & 0 deletions docs/pages/includes/helm-reference/zz_generated.access-email.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ 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`

Expand Down Expand Up @@ -265,6 +267,77 @@ 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 mail plugin.

### `tbot.clusterName`

| Type | Default |
|------|---------|
| `string` | `""` |

`tbot.clusterName` is the name of the Teleport cluster tbot and the mail 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/join-methods.mdx) for a list fo supported values and detailed explanations.

## `annotations`

`annotations` contains annotations to apply to the different Kubernetes
Expand Down
73 changes: 73 additions & 0 deletions docs/pages/includes/helm-reference/zz_generated.access-jira.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ 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.identityFromSecret`

Expand Down Expand Up @@ -213,6 +215,77 @@ 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 Jira plugin.

### `tbot.clusterName`

| Type | Default |
|------|---------|
| `string` | `""` |

`tbot.clusterName` is the name of the Teleport cluster tbot and the Jira 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/join-methods.mdx) for a list fo supported values and detailed explanations.

## `annotations`

`annotations` contains annotations to apply to the different Kubernetes
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ 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`

Expand Down Expand Up @@ -141,6 +143,77 @@ 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/join-methods.mdx) for a list fo supported values and detailed explanations.

## `annotations`

`annotations` contains annotations to apply to the different Kubernetes
Expand Down
Loading
Loading