Skip to content

Commit

Permalink
docs: update upgrading (#45402)
Browse files Browse the repository at this point in the history
* docs: update upgrading

* docs: update verbiage to you from they on instance owners

* docs: update description for self-hosted updates

* docs: spelling fix in agent upgrade desc

* docs: verbiage update for upgrading

Co-authored-by: Paul Gottschling <[email protected]>

---------

Co-authored-by: Steven Martin <[email protected]>
Co-authored-by: Paul Gottschling <[email protected]>
  • Loading branch information
3 people authored Aug 30, 2024
1 parent 5f461ef commit 0aa73a4
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 13 deletions.
28 changes: 16 additions & 12 deletions docs/pages/reference/architecture/agent-update-management.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ mode](../../faq.mdx), agent deployments
are sometimes simpler and more convenient. However, large Teleport deployments
can create an additional burden: updating all agents.

Starting with version 13, Teleport supports automatic agent updates for systemd-based
Linux distributions using `apt` or `yum` package managers, and Kubernetes clusters.
Teleport supports automatic agent updates for systemd-based
Linux distributions using `apt`, `yum` or `zypper` package managers, and Kubernetes clusters.

## Update logic and failure modes

Expand Down Expand Up @@ -41,7 +41,7 @@ applied even if the updater is outside its regular maintenance window.
## Security

When updating the agent, the updater will ensure the new version's authenticity
before deploying it. On Linux distributions using `apt` or `yum`, it relies on
before deploying it. On Linux distributions using `apt`, `yum` or `zypper`, it relies on
the existing package signature system. On Kubernetes-based environments, it
validates the OCI image signature (using [cosign's signature
](https://github.com/sigstore/cosign/blob/main/specs/SIGNATURE_SPEC.md)).
Expand All @@ -67,23 +67,27 @@ instances, or use the `stable/rolling` channel.

### Teleport Cloud

Teleport Cloud users can use Teleport Cloud's version server only if their
instance is enrolled in automatic updates. This version server will always
If you are using Teleport Cloud you can use Teleport Cloud's version server
only if an instance is enrolled in automatic updates. This version server will always
target the best version from a feature, compatibility, security and stability
point of view.

Teleport Cloud users whose control plane is not automatically updated must not use
automatic agent updates. This is because their Teleport instance version might
If your Teleport Cloud control plane is not automatically updated you must not use
automatic agent updates. This is because your Teleport instance version might
differ from the other Teleport Cloud instances and might not yet support the
latest agent version.

### Self-hosted Teleport

Self-hosted Teleport users can set up automatic agent updates. They must host
their version server and choose their target version. They are responsible for
ensuring the targeted version is compatible with their current auth/proxy
versions. They must also monitor the agent's health and rollout status to
ensure every agent is healthy and running the correct version.
If you are self-hosting Teleport Enterprise you can set up automatic agent updates.
The updater uses a version channel to retrieve the targeted version for an agent.
The Teleport Proxy Service provides a default version channel that matches to its current version.
You can configure the default version and set additional channel versions.

You are responsible for ensuring the version channels are compatible with the
current Teleport Proxy Service and Teleport Auth Service versions. You must also
monitor the agent's health and rollout status to ensure every agent is healthy
and running the correct version.

## Next steps

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/upgrading.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ If you have a Teleport Enterprise (Cloud) account, you **must** [set up automati
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.
Enterprise cluster.

For more information about upgrading, for example, to upgrade manually, read the
[Upgrading Reference](upgrading/upgrading.mdx).
Expand Down

0 comments on commit 0aa73a4

Please sign in to comment.