Skip to content
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

Consolidate updating guides #41160

Merged
merged 9 commits into from
Jun 24, 2024
Merged

Consolidate updating guides #41160

merged 9 commits into from
Jun 24, 2024

Conversation

ptgott
Copy link
Contributor

@ptgott ptgott commented May 2, 2024

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.

Copy link

github-actions bot commented May 2, 2024

The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with changelog: followed by the changelog entries for the PR.

Copy link

github-actions bot commented May 2, 2024

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

Comment on lines 53 to 155
Note that the `inventory ls` command will also list `teleport-auth` and
`teleport-proxy` services. These services are managed by the Teleport team, and
updates will be performed automatically.
Copy link
Contributor

@hugoShaka hugoShaka May 2, 2024

Choose a reason for hiding this comment

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

The auth and proxy services are only managed by us for cloud customers, self-hosted AU users are also responsible for updating their control plane services.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I had intended for this to be a guide for cloud-hosted clusters, but now realize that nothing in the introduction/prerequisites mentions this. I've added a prerequisite for a cloud-hosted cluster and a link to the reference for self-hosted users.

@bernardjkim bernardjkim self-requested a review May 2, 2024 23:27
@ptgott ptgott requested a review from hugoShaka May 3, 2024 17:29
Copy link

github-actions bot commented May 3, 2024

The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with changelog: followed by the changelog entries for the PR.

Copy link

github-actions bot commented May 3, 2024

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

@ptgott ptgott force-pushed the paul.gottschling/40636-refactor branch from 87a7cfe to 62ebdc7 Compare May 3, 2024 20:23
@ptgott ptgott changed the base branch from bernard/refactor-cloud-linux-docs to master May 3, 2024 20:23
Copy link

github-actions bot commented May 3, 2024

The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with changelog: followed by the changelog entries for the PR.

@ptgott ptgott added no-changelog Indicates that a PR does not require a changelog entry backport/branch/v15 labels May 3, 2024
docs/pages/upgrading/automatic-agent-updates.mdx Outdated Show resolved Hide resolved
docs/pages/upgrading/automatic-agent-updates.mdx Outdated Show resolved Hide resolved
docs/pages/upgrading/automatic-agent-updates.mdx Outdated Show resolved Hide resolved
@bernardjkim
Copy link
Contributor

I noticed that the static install script does not configure the stable/cloud channel for cloud installations. I've created a PR to update the script https://github.com/gravitational/next/pull/2488. We'll probably want to merge that first.

Copy link

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

docs/pages/upgrading/automatic-agent-updates.mdx Outdated Show resolved Hide resolved
docs/pages/upgrading/automatic-agent-updates.mdx Outdated Show resolved Hide resolved
ptgott added 9 commits June 24, 2024 11:22
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.
- Fix step numbering.
- Add cloud prerequisite and mention cloud-hosted clusters in the
  introduciton.
- Remove unintentionally preserved text about release channels for
  Teleport v14.
- Add instructions for determining the Teleport version to install.
Urge users to enroll their agents in automatic upgrades per feedback
from bernardjkim.
- 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.
@ptgott ptgott force-pushed the paul.gottschling/40636-refactor branch from 338bb45 to 444a616 Compare June 24, 2024 15:23
@ptgott ptgott enabled auto-merge June 24, 2024 15:23
Copy link

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

@ptgott ptgott added this pull request to the merge queue Jun 24, 2024
Merged via the queue into master with commit ea18339 Jun 24, 2024
38 checks passed
@ptgott ptgott deleted the paul.gottschling/40636-refactor branch June 24, 2024 15:40
@public-teleport-github-review-bot

@ptgott See the table below for backport results.

Branch Result
branch/v15 Failed
branch/v16 Failed

ptgott added a commit that referenced this pull request Jun 25, 2024
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
ptgott added a commit that referenced this pull request Jun 25, 2024
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
github-merge-queue bot pushed a commit that referenced this pull request Jun 25, 2024
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
github-merge-queue bot pushed a commit that referenced this pull request Jun 25, 2024
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants