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

Add client tools managed updates to resources docs #51155

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
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
38 changes: 37 additions & 1 deletion docs/pages/reference/resources.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,8 @@ Here's the list of resources currently exposed via [`tctl`](./cli/tctl.mdx):
| [vnet_config](#vnet-config) | Configuration for the cluster's VNet options. |
| [cluster_auth_preference](#cluster-auth-preferences) | Configuration for the cluster's auth preferences. |
| [database_object_import_rule](#database-object-import-rule) | Database object import rules. |
| [autoupdate_config](#auto-update-config) | Client tools auto-update configuration |
| [autoupdate_version](#auto-update-version) | Client tools auto-update target version configuration |

## User

Expand Down Expand Up @@ -222,7 +224,7 @@ Global cluster configuration options for authentication.
metadata:
name: cluster-auth-preference
spec:
# Sets the list of allowed second factors for the cluster.
# Sets the list of allowed second factors for the cluster.
# Possible values: "otp", "webauthn", and "sso".
# Defaults to ["otp"].
second_factors: ["webauthn", "otp"]
Expand Down Expand Up @@ -317,3 +319,37 @@ Find out more on the
[Machine ID configuration reference](machine-id/configuration.mdx).

(!docs/pages/includes/machine-id/bot-spec.mdx!)

## Auto-update config

Configuration options for managed updates for Teleport client tools.

```yaml
kind: autoupdate_config
metadata:
name: autoupdate-config
spec:
tools:
# tools mode allows users to enable or disable client tool updates at the
# cluster level. Disable client tool automatic updates only if self-managed
# updates are in place.
mode: enabled|disabled
```

See [Teleport Client Tool Automatic Updates](../upgrading/client-tools-autoupdate.mdx) for more details.

## Auto-update version

Allows cluster administrators to manage the version of client tools that must be installed after logging into the cluster.

```yaml
kind: autoupdate_version
metadata:
name: autoupdate-version
spec:
tools:
# target_version is the semver version of client tools the cluster will advertise.
target_version: X.Y.Z
```

See [Teleport Client Tool Automatic Updates](../upgrading/client-tools-autoupdate.mdx) for more details.
6 changes: 5 additions & 1 deletion docs/pages/upgrading/client-tools-autoupdate.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,10 @@ Teleport v17.0.5 git:v17.0.5-0-g7cc4c2a go1.23.4

### Using `tctl`

<Admonition type="note">
`tctl autoupdate` commands are available in versions: >=17.2.0
</Admonition>

To enable or disable client tools automatic updates in the cluster, use the following command:

```code
Expand All @@ -85,7 +89,7 @@ client tools auto update target version has been cleared
```

If the target version is cleared, the cluster version will be used automatically, eliminating the need for manual
updates each time the cluster version is upgraded."
updates each time the cluster version is upgraded.

The `status` command retrieves the target version and mode configured for the logged-in cluster.
To use an unauthenticated endpoint for this configuration, include the `--proxy` flag.
Expand Down
Loading