Skip to content

docs: Add timing for automatic agent updates to the cloud FAQ#33177

Merged
lsgunn-teleport merged 7 commits intomasterfrom
LG/agent-updates-for-cloud-faq
Oct 12, 2023
Merged

docs: Add timing for automatic agent updates to the cloud FAQ#33177
lsgunn-teleport merged 7 commits intomasterfrom
LG/agent-updates-for-cloud-faq

Conversation

@lsgunn-teleport
Copy link
Copy Markdown
Contributor

@lsgunn-teleport lsgunn-teleport commented Oct 9, 2023

Fixes gravitational/customer-sensitive-requests#137

@lsgunn-teleport lsgunn-teleport temporarily deployed to vercel October 9, 2023 20:40 — with GitHub Actions Inactive
@github-actions github-actions Bot requested a review from ptgott October 9, 2023 20:41
@github-actions github-actions Bot requested review from r0mant, xinding33 and zmb3 October 9, 2023 20:41
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Oct 9, 2023

🤖 Vercel preview here: https://docs-r903kabu5-goteleport.vercel.app/docs/ver/preview

Comment thread docs/pages/choose-an-edition/teleport-cloud/faq.mdx Outdated
Comment thread docs/pages/choose-an-edition/teleport-cloud/faq.mdx Outdated
Comment thread docs/pages/choose-an-edition/teleport-cloud/faq.mdx Outdated
@lsgunn-teleport lsgunn-teleport temporarily deployed to vercel October 9, 2023 22:04 — with GitHub Actions Inactive
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Oct 9, 2023

🤖 Vercel preview here: https://docs-jdgb9vp2g-goteleport.vercel.app/docs/ver/preview

Comment thread docs/pages/choose-an-edition/teleport-cloud/faq.mdx Outdated
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 account is NOT
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is correct today, but with automatic upgrades I believe we will no longer hold upgrades due to old agents. Would be good to confirm with @r0mant

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@r0mant, can you elaborate on what we might need to say here?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can't see this paragraph fully anymore cause I assume it got removed but the current changeset looks good to me. Just left one comment.


### When are agents automatically updated?

Typically, Teleport agents are automatically updated from one to a few days after
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's make it clear that you must be enrolled in automatic agent upgrades (and probably link to those docs) for this to happen.

I like to think of auth/proxy upgrades as "push" upgrades - we (Teleport) push the upgrade during the configured maintenance window. Agent upgrades are "pull" upgrades - we aren't pushing anything out, the agents are just configured to periodically check for new versions and pull them down.

@ptgott ptgott temporarily deployed to vercel October 10, 2023 21:43 — with GitHub Actions Inactive
@github-actions
Copy link
Copy Markdown
Contributor

🤖 Vercel preview here: https://docs-byw2e2ihc-goteleport.vercel.app/docs/ver/preview

@lsgunn-teleport lsgunn-teleport temporarily deployed to vercel October 11, 2023 19:24 — with GitHub Actions Inactive
@github-actions
Copy link
Copy Markdown
Contributor

🤖 Vercel preview here: https://docs-beuflhlq5-goteleport.vercel.app/docs/ver/preview

@lsgunn-teleport lsgunn-teleport temporarily deployed to vercel October 11, 2023 21:28 — with GitHub Actions Inactive
@github-actions
Copy link
Copy Markdown
Contributor

🤖 Vercel preview here: https://docs-phm0ibox3-goteleport.vercel.app/docs/ver/preview

Comment on lines +153 to +154
more than one major version behind, you might experience compatibility issues if your cluster is
automatically upgraded but agents aren't.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would rephrase to:

Suggested change
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 upgrades

@public-teleport-github-review-bot public-teleport-github-review-bot Bot removed the request for review from xinding33 October 11, 2023 21:46
Copy link
Copy Markdown
Contributor

@xinding33 xinding33 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No blocking changes but please take a look at the suggestions.

- 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.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This really should be "...if you enroll your agents in automatic updates."

## Upgrading

### Will Teleport be automatically upgraded with each release?
### Will Teleport be automatically upgraded?
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm only highlighting this single instance, but this comment is for all occurrences of "upgrade." I would like to adopt the word "update" for everything over "upgrade" for consistency sake. Please update the language when you get a chance. This is not a blocking request.

Comment on lines +187 to +189
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.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should really just be "Teleport agents are automatically updated during your scheduled maintenance period."

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@xinding33 just FYI, the issue implies that "during your scheduled maintenance period" isn't the case:

Currently after a cloud upgrade the version for the agents can be updated 1 or multiple days after.

@lsgunn-teleport lsgunn-teleport temporarily deployed to vercel October 12, 2023 17:54 — with GitHub Actions Inactive
@github-actions
Copy link
Copy Markdown
Contributor

🤖 Vercel preview here: https://docs-2pdun7g6p-goteleport.vercel.app/docs/ver/preview

@lsgunn-teleport lsgunn-teleport temporarily deployed to vercel October 12, 2023 18:06 — with GitHub Actions Inactive
@github-actions
Copy link
Copy Markdown
Contributor

🤖 Vercel preview here: https://docs-704el351u-goteleport.vercel.app/docs/ver/preview

@lsgunn-teleport lsgunn-teleport added this pull request to the merge queue Oct 12, 2023
Merged via the queue into master with commit 891356e Oct 12, 2023
@lsgunn-teleport lsgunn-teleport deleted the LG/agent-updates-for-cloud-faq branch October 12, 2023 18:32
@public-teleport-github-review-bot
Copy link
Copy Markdown

@lsgunn-teleport See the table below for backport results.

Branch Result
branch/v13 Failed
branch/v14 Create PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants