From 3d9c3197ad1780b75d6356801a59ac35550d4d25 Mon Sep 17 00:00:00 2001 From: Tiago Silva Date: Wed, 3 May 2023 14:27:53 +0100 Subject: [PATCH 1/3] Add client compatibility to instalation guide. This PR adds a note to emphasize that clients must be at the same major version as Teleport servers --- docs/pages/installation.mdx | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/pages/installation.mdx b/docs/pages/installation.mdx index d78662c05483a..8826e7db3e03e 100644 --- a/docs/pages/installation.mdx +++ b/docs/pages/installation.mdx @@ -12,6 +12,17 @@ If you are new to Teleport, we recommend following our + + +When installing Teleport clients - `tsh`, `tctl`, and `tbot` - ensure to +install the same major version as the Teleport cluster. For example, if the cluster is +running Teleport 12, you should install a Teleport 12 client. + +See our [Upgrading](./management/operations/upgrading.mdx) guide for more +information. + + + ## Operating system support Teleport is officially supported on the platforms listed below. It is worth @@ -132,7 +143,7 @@ chart. The Teleport package in Homebrew is not maintained by Teleport and we can't - guarantee its reliability or security. + guarantee its reliability or security. From a93375447a4e3811ed086de9df7fa75cc3f818f5 Mon Sep 17 00:00:00 2001 From: Tiago Silva Date: Wed, 3 May 2023 15:28:02 +0100 Subject: [PATCH 2/3] Update docs/pages/installation.mdx Co-authored-by: Zac Bergquist --- docs/pages/installation.mdx | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/pages/installation.mdx b/docs/pages/installation.mdx index 8826e7db3e03e..68bdab279008e 100644 --- a/docs/pages/installation.mdx +++ b/docs/pages/installation.mdx @@ -14,9 +14,12 @@ If you are new to Teleport, we recommend following our -When installing Teleport clients - `tsh`, `tctl`, and `tbot` - ensure to -install the same major version as the Teleport cluster. For example, if the cluster is -running Teleport 12, you should install a Teleport 12 client. +For best results, Teleport clients (`tsh`, `tctl`, `tbot`) +should be the same major version as the cluster they are +connecting to. Teleport servers are compatible with clients +that are on the same major version or one major version older. +Teleport servers do not support clients that are on a newer +major version. See our [Upgrading](./management/operations/upgrading.mdx) guide for more information. From 06abd79d335d5eb67d41749d7e4c85435731a5fb Mon Sep 17 00:00:00 2001 From: Tiago Silva Date: Thu, 4 May 2023 10:18:55 +0100 Subject: [PATCH 3/3] fix paul comment --- docs/pages/installation.mdx | 25 +++++++++++-------------- 1 file changed, 11 insertions(+), 14 deletions(-) diff --git a/docs/pages/installation.mdx b/docs/pages/installation.mdx index 68bdab279008e..63cd0d77ffaed 100644 --- a/docs/pages/installation.mdx +++ b/docs/pages/installation.mdx @@ -5,26 +5,23 @@ h1: Installation videoBanner: VifXROQFjwg --- - +This guide shows you how to install Teleport binaries on your platform, +including: +- `teleport` +- `tsh` +- `tctl` +- `tbot` If you are new to Teleport, we recommend following our [getting started guides](./try-out-teleport/introduction.mdx). - +For best results, Teleport clients (`tsh`, `tctl`, `tbot`) should be the same major +version as the cluster they are connecting to. Teleport servers are compatible +with clients that are on the same major version or one major version older. +Teleport servers do not support clients that are on a newer major version. - +See our [Upgrading](./management/operations/upgrading.mdx) guide for more information. -For best results, Teleport clients (`tsh`, `tctl`, `tbot`) -should be the same major version as the cluster they are -connecting to. Teleport servers are compatible with clients -that are on the same major version or one major version older. -Teleport servers do not support clients that are on a newer -major version. - -See our [Upgrading](./management/operations/upgrading.mdx) guide for more -information. - - ## Operating system support