-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Fix lint warning, make these unordered lists #29086
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
99e14b0
Fix lint warning, make these unordered lists
lsgunn-teleport 8b85e56
Change numbered steps, make a couple of edits
lsgunn-teleport b646052
Merge branch 'master' into LG/fix-numbering-for-lint-update
lsgunn-teleport 9c1eb36
Update the versions mentioned in the upgrade sequence
lsgunn-teleport 649198a
Changed to bullets because these aren't discrete steps in the traditi…
lsgunn-teleport ea3473c
Remove extra lines
lsgunn-teleport 42d4844
Fix lint issue
lsgunn-teleport 51d5cf1
Merge branch 'master' into LG/fix-numbering-for-lint-update
lsgunn-teleport b16add4
Merge branch 'master' into LG/fix-numbering-for-lint-update
lsgunn-teleport File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -3,8 +3,7 @@ title: Upgrading a Teleport Cluster | |||||
| description: This guide shows you the correct order in which to upgrade Teleport components when rolling out a new Teleport release in your cluster. | ||||||
| --- | ||||||
|
|
||||||
| In this guide, we will show you how to upgrade all of the components in your | ||||||
| Teleport cluster. | ||||||
| This guide demonstrates how to upgrade all of the components in your Teleport cluster. | ||||||
|
|
||||||
| (!docs/pages/includes/cloud/call-to-action.mdx!) | ||||||
|
|
||||||
|
|
@@ -28,13 +27,14 @@ title="Auth Service and Proxy Service versions"> | |||||
|
|
||||||
| In Teleport Cloud, we manage the Auth and Proxy Services for you. You can | ||||||
| determine the current version of these services by running the following | ||||||
| command, where `mytenant` is the name of your Teleport Cloud tenant: | ||||||
| command, where `mytenant` is the name of your Teleport Team or Teleport | ||||||
| Enterprise Cloud tenant: | ||||||
|
|
||||||
| ```code | ||||||
| $ curl -s https://mytenant.teleport.sh/webapi/ping | jq '.server_version' | ||||||
| ``` | ||||||
|
|
||||||
| Read the following rules to ensure that your Teleport resource services (e.g., | ||||||
| Read the following rules to ensure that your Teleport resource services (for example, | ||||||
| the SSH Service and Database Service) are compatible with the Teleport Auth and | ||||||
| Proxy Services. You should check the version of the Auth and Proxy Services | ||||||
| regularly to make sure that your Teleport resource services are compatible. | ||||||
|
|
@@ -47,28 +47,30 @@ regularly to make sure that your Teleport resource services are compatible. | |||||
|
|
||||||
| Back up before upgrading. We have more instructions in [Backing up Teleport](./backup-restore.mdx). | ||||||
|
|
||||||
| ## Upgrade Sequence | ||||||
| ## Upgrade sequence | ||||||
|
|
||||||
| <Tabs> | ||||||
| <TabItem scope={["enterprise", "oss"]} label="Self-Hosted"> | ||||||
| When upgrading a single Teleport cluster: | ||||||
|
|
||||||
| <Notice type="tip"> | ||||||
| Teleport requires upgrading the Teleport Cluster from one major version to another in sequence. | ||||||
| That means if you are currently on version 8.X you must upgrade to the latest version 9 before | ||||||
| going to version 10. To upgrade in sequence repeat upgrading the Teleport Cluster, confirming | ||||||
| If you are currently on version 11.x, you must upgrade to the latest version 12.x before | ||||||
| going to version 13.x. To upgrade in sequence, upgrade the Teleport cluster and confirm | ||||||
| a healthy start before continuing to the next version. | ||||||
| </Notice> | ||||||
|
|
||||||
| 1. **Upgrade the Auth Service first to the next Major version**. The Auth Service keeps the cluster state | ||||||
| and, if there are data format changes introduced in the new version, will | ||||||
| perform necessary migrations. Confirm the start of the Auth Service and a healthy state. | ||||||
| 2. Upgrade Proxy Service instances to the same version number. These are stateless and can be upgraded in | ||||||
| any sequence or at the same time. | ||||||
| 3. Finally, upgrade your Teleport resource services in any sequence or at the | ||||||
| same time to the same version number. | ||||||
| 4. If you are upgrading more then one version number then repeat Step 1 to 3 until you have reached your target | ||||||
| major version. | ||||||
| When upgrading a single Teleport cluster: | ||||||
|
|
||||||
| - Upgrade the **Auth Service** to the next **major version first**. | ||||||
| The Auth Service keeps the cluster state. If there are data format | ||||||
| changes introduced in the new version, the Auth Service performs the necessary migrations. | ||||||
| After the upgrade, start the Auth Service and CONFIRM that it's in a healthy state before | ||||||
| continuing. | ||||||
| - Upgrade Proxy Service instances to the same version number as the Auth Service. | ||||||
| Proxy Service instances are stateless and can be upgraded in any sequence or at the same time. | ||||||
| - Upgrade your Teleport resource services to the same version number as the Auth Service. | ||||||
| You can upgrade resource agents in any sequence or at the same time. | ||||||
|
|
||||||
| If you are upgrading more then one version number, repeat these steps until | ||||||
| you reach your target major version number. | ||||||
|
|
||||||
| <Admonition | ||||||
| type="warning" | ||||||
|
|
@@ -85,8 +87,9 @@ precaution. This allows for a safe rollback in case the migration itself fails. | |||||
|
|
||||||
| When upgrading multiple clusters: | ||||||
|
|
||||||
| 1. First, upgrade the root cluster, i.e. the one that other clusters trust. | ||||||
| 2. Upgrade the Trusted Clusters. | ||||||
| - Upgrade the root cluster—that is, the cluster that other clusters trust—first. | ||||||
| - Verify the upgrade was successful. | ||||||
| - Upgrade the Trusted Clusters. | ||||||
|
|
||||||
| </TabItem> | ||||||
| <TabItem scope={["cloud","team"]} label="Cloud-Hosted"> | ||||||
|
|
@@ -97,8 +100,9 @@ time. | |||||
|
|
||||||
| When upgrading multiple clusters: | ||||||
|
|
||||||
| 1. First, upgrade the root cluster, i.e. the one that other clusters trust. | ||||||
| 2. Upgrade the Trusted Clusters. | ||||||
| - Upgrade the root cluster—that is, the cluster that other clusters trust—first. | ||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| - Verify the upgrade was successful. | ||||||
| - Upgrade the Trusted Clusters. | ||||||
|
|
||||||
| </TabItem> | ||||||
| </Tabs> | ||||||
|
|
||||||
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
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
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
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.