-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Consolidate updating guides (#43425)
Backports #41160 * Consolidate updating guides Include a how-to guide for the fast path we want most users to move to: using cloud-hosted Teleport Enterprise and enrolling agents in automatic updates. For other use cases and edge cases, include a general Updating Reference. * Respond to hugoShaka feedback - Fix step numbering. - Add cloud prerequisite and mention cloud-hosted clusters in the introduciton. * Respond to bernardjkim feedback - Remove unintentionally preserved text about release channels for Teleport v14. - Add instructions for determining the Teleport version to install. * Add an intro paragraph with a recommendation Urge users to enroll their agents in automatic upgrades per feedback from bernardjkim. * Add check for the Enterprise teleport-kube-agent Incorporates #41132 * Respond to r0mant feedback - Include self-hosted instructions in the how-to guide - Include a journalctl command to check logs - Edit the upgrading menu page and intro of the how-to guide to provide stronger language re: using automatic agent upgrades in cloud accounts. * Add `helm repo update` step * Fix linter errors * Respond to r0mant feedback
- Loading branch information
Showing
12 changed files
with
807 additions
and
981 deletions.
There are no files selected for viewing
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
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,47 +1,23 @@ | ||
--- | ||
title: Upgrading Teleport | ||
description: Explains how to upgrade Teleport depending on your environment and edition. | ||
layout: tocless-doc | ||
--- | ||
|
||
The guides in this section show you how to upgrade Teleport to a more recent | ||
version. | ||
|
||
## Upgrading compatibility overview | ||
Read the [Upgrading Compatibility Overview](./upgrading/overview.mdx) to | ||
understand how to upgrade components in your Teleport cluster while ensuring | ||
compatibility between all components. | ||
|
||
Since Teleport is a distributed system with a number of services that run on | ||
potentially many hosts, you should take care when upgrading the cluster to | ||
ensure that all components remain compatible. | ||
If you have a Teleport Enterprise (Cloud) account, you **must** [set up automatic | ||
Teleport agent updates](./upgrading/automatic-agent-updates.mdx) to ensure that | ||
the version of Teleport running on agents is always compatible with that of the | ||
Teleport cluster. You can also set up automatic agent upgrades in a self-hosted | ||
cluster. | ||
|
||
The [Upgrading Compatibility Overview](./upgrading/overview.mdx) explains how to | ||
upgrade components in your Teleport cluster to ensure that they communicate as | ||
expected. | ||
For more information about upgrading, for example, to upgrade manually, read the | ||
[Upgrading Reference](./upgrading/reference.mdx). | ||
|
||
## Upgrading guides | ||
|
||
After getting familiar with the Compatibility Overview, read one of the | ||
following guides to upgrade the components in your Teleport cluster. Choose the | ||
guide that matches your Teleport edition and the platform where you run Teleport | ||
services: | ||
|
||
Teleport Cloud: | ||
|
||
- [Linux Servers](./upgrading/cloud-linux.mdx) | ||
- [Kubernetes](./upgrading/cloud-kubernetes.mdx) | ||
|
||
Self-hosted deployments: | ||
|
||
- [Linux Servers](./upgrading/self-hosted-linux.mdx) | ||
- [Kubernetes](./upgrading/self-hosted-kubernetes.mdx) | ||
|
||
## Automatic agent upgrades | ||
|
||
We recommend that Teleport users set up automatic agent upgrades, where agents | ||
query a **version server** in order to determine whether they are out of date | ||
and need to install a new version of Teleport. | ||
|
||
On Teleport Cloud, the version server is managed for you. | ||
|
||
If you are running Teleport Enterprise, read the [Self-Hosted Automatic Agent | ||
Updates](./upgrading/self-hosted-automatic-agent-updates.mdx) guide to set up | ||
the version server yourself. | ||
You can find more information regarding the automatic updates architecture in the | ||
[Agent Update Management](./architecture/agent-update-management.mdx) page. |
Oops, something went wrong.