Add client compatibility to installation guide#25548
Merged
Conversation
This PR adds a note to emphasize that clients must be at the same major version as Teleport servers
github-actions
Bot
requested review from
alexfornuto,
ptgott,
r0mant,
xinding33 and
zmb3
zmb3
reviewed
May 3, 2023
Co-authored-by: Zac Bergquist <zac.bergquist@goteleport.com>
zmb3
approved these changes
May 3, 2023
ptgott
reviewed
May 3, 2023
|
|
||
| </Admonition> | ||
|
|
||
| <Admonition type="warning" title="Teleport client compatibility"> |
Contributor
There was a problem hiding this comment.
The successive Admonitions appear pretty busy to me:
I think we can strip both Admonition wrappers and add an intro sentence so the text flows more smoothly, making the first part of the guide looks like this:
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
guide](http://localhost:3000/docs/get-started/).
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](http://localhost:3000/docs/management/operations/upgrading/) guide for more information.
ptgott
approved these changes
May 4, 2023
public-teleport-github-review-bot
Bot
removed request for
alexfornuto,
r0mant and
xinding33
This was referenced May 5, 2023
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds a note to emphasize that clients must be at the same major version as Teleport servers