From a771b6c8a583b1edf5c9562bbc070275a7ededc7 Mon Sep 17 00:00:00 2001 From: Vadym Popov Date: Fri, 17 Jan 2025 02:25:00 -0800 Subject: [PATCH] Add client tools managed updates to resources docs --- docs/pages/reference/resources.mdx | 39 ++++++++++++++++++- .../upgrading/client-tools-autoupdate.mdx | 6 ++- 2 files changed, 43 insertions(+), 2 deletions(-) diff --git a/docs/pages/reference/resources.mdx b/docs/pages/reference/resources.mdx index a1371935a7f7d..384579e95e1b8 100644 --- a/docs/pages/reference/resources.mdx +++ b/docs/pages/reference/resources.mdx @@ -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 @@ -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"] @@ -317,3 +319,38 @@ 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 client tools managed updates. + +```yaml +kind: autoupdate_config +metadata: + name: autoupdate-config +spec: + tools: + # tools mode allows to enable client tools updates or disable at the + # cluster level. Disable client tools automatic updates only if self-managed + # updates are in place. + mode: enabled|disabled +``` + +(!docs/pages/upgrading/client-tools-autoupdate.mdx!) + + +## 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 +``` + +(!docs/pages/upgrading/client-tools-autoupdate.mdx!) \ No newline at end of file diff --git a/docs/pages/upgrading/client-tools-autoupdate.mdx b/docs/pages/upgrading/client-tools-autoupdate.mdx index 0d414ae131c36..d3a1a27bc13fb 100644 --- a/docs/pages/upgrading/client-tools-autoupdate.mdx +++ b/docs/pages/upgrading/client-tools-autoupdate.mdx @@ -64,6 +64,10 @@ Teleport v17.0.5 git:v17.0.5-0-g7cc4c2a go1.23.4 ### Using `tctl` + + `tctl autoupdate` commands are available in versions: >=17.2.0 + + To enable or disable client tools automatic updates in the cluster, use the following command: ```code @@ -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.