From 92c3e433b3947c98db105cec46fa6ed15b28c61c Mon Sep 17 00:00:00 2001 From: Lisa Gunn Date: Mon, 9 Oct 2023 13:29:26 -0700 Subject: [PATCH 1/7] Add agent updates follow the cluster upgrade to the FAQ --- .../choose-an-edition/teleport-cloud/faq.mdx | 21 ++++++++++++------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/docs/pages/choose-an-edition/teleport-cloud/faq.mdx b/docs/pages/choose-an-edition/teleport-cloud/faq.mdx index 985987fdf766d..d98374920bbd9 100644 --- a/docs/pages/choose-an-edition/teleport-cloud/faq.mdx +++ b/docs/pages/choose-an-edition/teleport-cloud/faq.mdx @@ -138,26 +138,26 @@ The ability to download recordings for offline viewing will be available in a fu ### Will Teleport be automatically upgraded with each release? -Teleport Cloud follows the Teleport [Upcoming +Teleport Team and Teleport Enterprise Cloud follow the Teleport [Upcoming Releases](../../upcoming-releases.mdx) timelines. -- Major version upgrades for customer Auth and Proxy Servers occur after the - first minor release (for example (=teleport.major_version=).1.0) of Teleport. +- Major version upgrades for cloud Teleport Auth Service and Teleport Proxy Service occur + after the first minor release (for example (=teleport.major_version=).1.0) of Teleport. This typically happens within one month of a new major release of Teleport becoming available. - After the first minor release, subsequent minor and patch upgrades typically occur within a week. - For major version upgrades (e.g. 12.x to 13.x), your Teleport tenant will NOT be automatically upgraded if any - Teleport agents connected to the cluster are not compatible (> 1 major version behind). This is done to ensure - backwards compatibility. To get version information on your agents versions - see [here](#how-can-i-find-version-information-on-connected-agents). + For major version upgrades (for example, 12.x to 13.x), your Teleport tenant is NOT + automatically upgraded if any Teleport agents connected to the cluster are not compatible + (> 1 major version behind). This version check is done to ensure backwards compatibility. + To get version information for your agents, see [here](#how-can-i-find-version-information-on-connected-agents). Please reach out to support if you wish to proceed regardless of this compatibility check. -### Are upgrades times configurable for my Teleport Enterprise Cloud tenant? +### Are upgrades times configurable for Teleport Enterprise Cloud? Yes, you can set the window start time that works best for your organization for upgrades. Teleport provides a scheduled maintenance time window for any @@ -172,6 +172,11 @@ Teleport recommends subscribing to the Teleport Enterprise Cloud updates at [status.teleport.sh](https://status.teleport.sh) to keep up to date on scheduled maintenance. +### When are agents automatically updated? + +Typically, Teleport agents are automatically updated from one to a few days after +your Teleport cluster is upgraded during a scheduled maintenance period. + ### How can I find version information on connected agents? To find the version of Teleport agent is attached to your cluster, run the From fec964038244a838b7477c2d1f49d258bb0725d8 Mon Sep 17 00:00:00 2001 From: Lisa Gunn Date: Mon, 9 Oct 2023 13:39:27 -0700 Subject: [PATCH 2/7] Revise maintenance window start time topic --- docs/pages/choose-an-edition/teleport-cloud/faq.mdx | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/pages/choose-an-edition/teleport-cloud/faq.mdx b/docs/pages/choose-an-edition/teleport-cloud/faq.mdx index d98374920bbd9..5c38aab0a5d1f 100644 --- a/docs/pages/choose-an-edition/teleport-cloud/faq.mdx +++ b/docs/pages/choose-an-edition/teleport-cloud/faq.mdx @@ -164,9 +164,10 @@ for upgrades. Teleport provides a scheduled maintenance time window for any upgrades, patches and other required updates for all tenants. An upgrade for your tenant will not start earlier than the window start time you set. -To set the window start time select your username in the Web UI, then the Help -& Support option from the drop-down. The Scheduled Upgrades section within that -page allows you to configure the window start time. +To set the window start time, select your username in the Teleport Web UI, then +click **Help & Support**. Under Scheduled Upgrades, you can see the current +maintenance window start time. Click **Edit** to set a different start +time for scheduled maintenance. Teleport recommends subscribing to the Teleport Enterprise Cloud updates at [status.teleport.sh](https://status.teleport.sh) to keep up to date on From daa9d964f5d326c990f7f7263a91b4e17a7ba4e7 Mon Sep 17 00:00:00 2001 From: Lisa Gunn Date: Mon, 9 Oct 2023 15:04:17 -0700 Subject: [PATCH 3/7] Edit the upgrade topics --- .../choose-an-edition/teleport-cloud/faq.mdx | 25 +++++++++++-------- 1 file changed, 14 insertions(+), 11 deletions(-) diff --git a/docs/pages/choose-an-edition/teleport-cloud/faq.mdx b/docs/pages/choose-an-edition/teleport-cloud/faq.mdx index 5c38aab0a5d1f..077fb1d2c60f1 100644 --- a/docs/pages/choose-an-edition/teleport-cloud/faq.mdx +++ b/docs/pages/choose-an-edition/teleport-cloud/faq.mdx @@ -138,24 +138,27 @@ The ability to download recordings for offline viewing will be available in a fu ### Will Teleport be automatically upgraded with each release? -Teleport Team and Teleport Enterprise Cloud follow the Teleport [Upcoming -Releases](../../upcoming-releases.mdx) timelines. +Teleport Team and Teleport Enterprise Cloud are upgraded after each Teleport release +is delivered. You can see the schedule for Teleport releases on [Teleport Upcoming +Releases](../../upcoming-releases.mdx). -- Major version upgrades for cloud Teleport Auth Service and Teleport Proxy Service occur - after the first minor release (for example (=teleport.major_version=).1.0) of Teleport. +- Major version upgrades for the Teleport Auth Service and Teleport Proxy Service on + Teleport Cloud occur after the first minor release (for example (=teleport.major_version=).1.0) + of Teleport. This typically happens within one month of a new major release of Teleport becoming available. - After the first minor release, subsequent minor and patch upgrades typically occur within a week. - - For major version upgrades (for example, 12.x to 13.x), your Teleport tenant is NOT - automatically upgraded if any Teleport agents connected to the cluster are not compatible - (> 1 major version behind). This version check is done to ensure backwards compatibility. - To get version information for your agents, see [here](#how-can-i-find-version-information-on-connected-agents). +For major version upgrades (for example, 12.x to 13.x), your Teleport account is NOT +automatically upgraded if any Teleport agents connected to the cluster are not compatible +(more than one major version behind). This version check is done to ensure backwards compatibility. + +To get version information for your agents, see [How can I find version information on +connected agents?](#how-can-i-find-version-information-on-connected-agents). - Please reach out to support if you wish to proceed regardless of this compatibility check. - +If you want to proceed with an upgrade regardless of this compatibility check, contact +[Teleport support](https://goteleport.com/support/). ### Are upgrades times configurable for Teleport Enterprise Cloud? From 9be440e175ad577a12c0b0c3a23f54a6f1aeb289 Mon Sep 17 00:00:00 2001 From: Lisa Gunn Date: Wed, 11 Oct 2023 12:24:25 -0700 Subject: [PATCH 4/7] Modify auto update information for cluster services and agents --- .../choose-an-edition/teleport-cloud/faq.mdx | 51 +++++++++++-------- 1 file changed, 29 insertions(+), 22 deletions(-) diff --git a/docs/pages/choose-an-edition/teleport-cloud/faq.mdx b/docs/pages/choose-an-edition/teleport-cloud/faq.mdx index 077fb1d2c60f1..36aba458aa86e 100644 --- a/docs/pages/choose-an-edition/teleport-cloud/faq.mdx +++ b/docs/pages/choose-an-edition/teleport-cloud/faq.mdx @@ -136,31 +136,32 @@ The ability to download recordings for offline viewing will be available in a fu ## Upgrading -### Will Teleport be automatically upgraded with each release? - -Teleport Team and Teleport Enterprise Cloud are upgraded after each Teleport release -is delivered. You can see the schedule for Teleport releases on [Teleport Upcoming -Releases](../../upcoming-releases.mdx). - -- Major version upgrades for the Teleport Auth Service and Teleport Proxy Service on - Teleport Cloud occur after the first minor release (for example (=teleport.major_version=).1.0) - of Teleport. - This typically happens within one month of a new major release of Teleport - becoming available. -- After the first minor release, subsequent minor and patch upgrades typically - occur within a week. - -For major version upgrades (for example, 12.x to 13.x), your Teleport account is NOT -automatically upgraded if any Teleport agents connected to the cluster are not compatible -(more than one major version behind). This version check is done to ensure backwards compatibility. - +### Will Teleport be automatically upgraded? + +The Teleport Auth Service and Teleport Proxy Service for Teleport Team and Teleport Enterprise Cloud +are automatically kept up to date with patches and minor releases following the release schedule +described in [Teleport Upcoming Releases](../../upcoming-releases.mdx). + +- Major version upgrades for the Teleport Auth Service and Teleport Proxy Service typically occur + one month after new major versions are released. +- Minor upgrades and patches typically occur between one day and a week after a release. +- Teleport Auth Service and Teleport Proxy Service upgrades are pushed to Teleport cloud accounts + during your scheduled maintenance window. +- Teleport agents are only upgraded automatically if you enroll in automatic agent updates. + +If you have Teleport agents connected to a Teleport Team or Teleport Enterprise cluster that are +more than one major version behind, you might experience compatibility issues if your cluster is +automatically upgraded but agents aren't. + To get version information for your agents, see [How can I find version information on connected agents?](#how-can-i-find-version-information-on-connected-agents). +For information about enrolling in automatic agent updates, see [Enroll an agent into automatic +updates](../management/operations/enroll-agent-into-automatic-updates/). -If you want to proceed with an upgrade regardless of this compatibility check, contact +For more information about automatic upgrades and compatibility issues, contact [Teleport support](https://goteleport.com/support/). -### Are upgrades times configurable for Teleport Enterprise Cloud? +### Are upgrade times configurable for Teleport Enterprise Cloud? Yes, you can set the window start time that works best for your organization for upgrades. Teleport provides a scheduled maintenance time window for any @@ -178,8 +179,14 @@ scheduled maintenance. ### When are agents automatically updated? -Typically, Teleport agents are automatically updated from one to a few days after -your Teleport cluster is upgraded during a scheduled maintenance period. +Teleport Team and Teleport Enterprise must be set to receive automatic updates +to use the Teleport Cloud version server for automatic agent updates. With automatic +agent upgrades, agents periodically check the version server for new releases and +update the software when new versions are found. + +If you enroll in automatic agent upgrades, Teleport agents are automatically +updated from one to a few days after your Teleport cluster is upgraded during +a scheduled maintenance period. ### How can I find version information on connected agents? From f0d48b5779cb645d2b2a203ac4321e2669b45fd8 Mon Sep 17 00:00:00 2001 From: Lisa Gunn Date: Wed, 11 Oct 2023 14:28:29 -0700 Subject: [PATCH 5/7] Fix link to agent update enrollment --- docs/pages/choose-an-edition/teleport-cloud/faq.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pages/choose-an-edition/teleport-cloud/faq.mdx b/docs/pages/choose-an-edition/teleport-cloud/faq.mdx index 36aba458aa86e..8fa58f9f3bd28 100644 --- a/docs/pages/choose-an-edition/teleport-cloud/faq.mdx +++ b/docs/pages/choose-an-edition/teleport-cloud/faq.mdx @@ -156,7 +156,7 @@ automatically upgraded but agents aren't. To get version information for your agents, see [How can I find version information on connected agents?](#how-can-i-find-version-information-on-connected-agents). For information about enrolling in automatic agent updates, see [Enroll an agent into automatic -updates](../management/operations/enroll-agent-into-automatic-updates/). +updates](../../management/operations/enroll-agent-into-automatic-updates/). For more information about automatic upgrades and compatibility issues, contact [Teleport support](https://goteleport.com/support/). From e2f4fad4f7be127fbd7155b11826ca33162287eb Mon Sep 17 00:00:00 2001 From: Lisa Gunn Date: Thu, 12 Oct 2023 10:53:42 -0700 Subject: [PATCH 6/7] Revise cluster and agent Upgrade > Update FAQs --- .../choose-an-edition/teleport-cloud/faq.mdx | 56 ++++++++++--------- 1 file changed, 30 insertions(+), 26 deletions(-) diff --git a/docs/pages/choose-an-edition/teleport-cloud/faq.mdx b/docs/pages/choose-an-edition/teleport-cloud/faq.mdx index 8fa58f9f3bd28..e94a98c613834 100644 --- a/docs/pages/choose-an-edition/teleport-cloud/faq.mdx +++ b/docs/pages/choose-an-edition/teleport-cloud/faq.mdx @@ -134,59 +134,63 @@ Proxy recording mode is disabled for cloud customers The ability to download recordings for offline viewing will be available in a future release. -## Upgrading +## Updates -### Will Teleport be automatically upgraded? +### Will Teleport be updated automatically? The Teleport Auth Service and Teleport Proxy Service for Teleport Team and Teleport Enterprise Cloud are automatically kept up to date with patches and minor releases following the release schedule described in [Teleport Upcoming Releases](../../upcoming-releases.mdx). -- Major version upgrades for the Teleport Auth Service and Teleport Proxy Service typically occur +- Major version updatesd for the Teleport Auth Service and Teleport Proxy Service typically occur one month after new major versions are released. -- Minor upgrades and patches typically occur between one day and a week after a release. -- Teleport Auth Service and Teleport Proxy Service upgrades are pushed to Teleport cloud accounts +- Minor updates and patches typically occur between one day and a week after a release. +- Teleport Auth Service and Teleport Proxy Service updates are pushed to Teleport cloud accounts during your scheduled maintenance window. -- Teleport agents are only upgraded automatically if you enroll in automatic agent updates. +- Teleport agents are only updated automatically if you enroll them in automatic updates. If you have Teleport agents connected to a Teleport Team or Teleport Enterprise cluster that are -more than one major version behind, you might experience compatibility issues if your cluster is -automatically upgraded but agents aren't. +more than one major version behind, you might experience compatibility issues unless your agents +are enrolled in automatic updates. To get version information for your agents, see [How can I find version information on connected agents?](#how-can-i-find-version-information-on-connected-agents). For information about enrolling in automatic agent updates, see [Enroll an agent into automatic -updates](../../management/operations/enroll-agent-into-automatic-updates/). +updates](../../management/operations/enroll-agent-into-automatic-updates.mdx). -For more information about automatic upgrades and compatibility issues, contact +For more information about automatic updates and compatibility issues, contact [Teleport support](https://goteleport.com/support/). -### Are upgrade times configurable for Teleport Enterprise Cloud? +### Are updates times configurable for Teleport Enterprise Cloud? -Yes, you can set the window start time that works best for your organization -for upgrades. Teleport provides a scheduled maintenance time window for any -upgrades, patches and other required updates for all tenants. An upgrade for -your tenant will not start earlier than the window start time you set. +Yes, Teleport provides a scheduled maintenance time window for updates and you can set +the start time for the maintenance window that works best for your organization. The +scheduled maintenance windows applies for all updates, including patches and agent updates +for all Teleport Cloud accounts. Updates for your cluster won't start earlier than the +maintenance window start time you set. -To set the window start time, select your username in the Teleport Web UI, then -click **Help & Support**. Under Scheduled Upgrades, you can see the current -maintenance window start time. Click **Edit** to set a different start -time for scheduled maintenance. - -Teleport recommends subscribing to the Teleport Enterprise Cloud updates at -[status.teleport.sh](https://status.teleport.sh) to keep up to date on +To set the maintenance window start time, select your username in the Teleport Web UI, +then click **Help & Support**. Under Scheduled Upgrades, you can see the current +maintenance window start time. Click **Edit** to set a different start time for scheduled maintenance. +Teleport recommends you check the status of Teleport Cloud at +[status.teleport.sh](https://status.teleport.sh). From the status page, click +**Subscribe to Updates** to get email notifications whenever Teleport Cloud creates, +updates, or resolves an incident and stay informed about scheduled maintenance and +new releases. + ### When are agents automatically updated? Teleport Team and Teleport Enterprise must be set to receive automatic updates to use the Teleport Cloud version server for automatic agent updates. With automatic -agent upgrades, agents periodically check the version server for new releases and +agent updates, agents periodically check the version server for new releases and update the software when new versions are found. -If you enroll in automatic agent upgrades, Teleport agents are automatically -updated from one to a few days after your Teleport cluster is upgraded during -a scheduled maintenance period. +If you enroll in automatic agent updates, Teleport agents are automatically +updated after your Teleport cluster is updated during your scheduled maintenance +period. For information about enrolling in automatic agent updates, see [Enroll an +agent into automatic updates](../../management/operations/enroll-agent-into-automatic-updates.mdx). ### How can I find version information on connected agents? From c61a15ae3665f8656e1458390d6addf57bbd653c Mon Sep 17 00:00:00 2001 From: Lisa Gunn Date: Thu, 12 Oct 2023 11:05:53 -0700 Subject: [PATCH 7/7] Fix update typo --- docs/pages/choose-an-edition/teleport-cloud/faq.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pages/choose-an-edition/teleport-cloud/faq.mdx b/docs/pages/choose-an-edition/teleport-cloud/faq.mdx index e94a98c613834..81f61797f36f6 100644 --- a/docs/pages/choose-an-edition/teleport-cloud/faq.mdx +++ b/docs/pages/choose-an-edition/teleport-cloud/faq.mdx @@ -142,7 +142,7 @@ The Teleport Auth Service and Teleport Proxy Service for Teleport Team and Telep are automatically kept up to date with patches and minor releases following the release schedule described in [Teleport Upcoming Releases](../../upcoming-releases.mdx). -- Major version updatesd for the Teleport Auth Service and Teleport Proxy Service typically occur +- Major version updates for the Teleport Auth Service and Teleport Proxy Service typically occur one month after new major versions are released. - Minor updates and patches typically occur between one day and a week after a release. - Teleport Auth Service and Teleport Proxy Service updates are pushed to Teleport cloud accounts