[v15] Improve Linux installation instructions #39043
Merged
Conversation
This file contains 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
Closes #32387 In the Installation page, the instructions for installing Teleport on Linux reuses the partial we use for how-to guides, `install-linux.mdx`. This is inappropriate for an installation reference, since the partial is not intended for users interested in a specific package manager. This change provides a comprehensive description of our package repositories for Teleport installations on Linux. Since the Installation page is a common entrypoint for users looking to get started with Teleport, this change also adds a section to the Linux installation instructions with recommended pages to follow for setting up Teleport. Also, since we have a script available form the corporate Teleport site that automatically chooses a package manager and configures it to target a Teleport package repo, this change adds instructions to use this. I have organized the Linux installation section to place H3 sections from less work/configuration to more work/configuration, from the one-line installation script to package manager-specific instructions and, finally, general information about our package repositories.
- Remove the version guidance for Cloud users and make the recommendation for them to enable automatic agent upgrades more prominent. - Add instructions for installing `teleport-ent-updater`. - Add instructions for changing the Teleport version to `cloud` for Team/Enterprise Cloud in package manager examples. Reorganize the package manager instructions so there is a single tabbed example of setting the version. To account for this, refactor the subsections of the "Linux" section so there is a single H3 for TAR and a single H3 for package repositories.
- Make it clear throughout the section that we recommend using the one-line installation script, which install the automatic updater for Teleport Cloud users. - Condense package repository and TAR archive H3s. By simplifying these sections, we can make the instructions to use the updater on Cloud more prominent. - Warn against using TAR archives with Teleport Cloud, and remove TabItems for these editions in the TAR archive section. - Incorporate instructions introduced by #38401 to query the Proxy Service for the latest compatible version.
- Remove Teleport Team mention - Add "(self-hosted only)" to the TAR subsection - Remove a Tabs component in the TAR section so readers aren't tempted to interact with the component before reading the initial body text.
ptgott
added
the
no-changelog
|
🤖 Vercel preview here: https://docs-7mfskjy54-goteleport.vercel.app/docs/ver/preview |
r0mant
approved these changes
Mar 6, 2024
stevenGravy
approved these changes
Mar 12, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Backport #36596 to branch/v15