Skip to content

docs: update agent updates #26707

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.

Sign up for GitHub

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
stevenGravy merged 3 commits into from
May 22, 2023
Merged

docs: update agent updates #26707

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
638823f
docs: update agent updates
stevenGravy May 22, 2023
ac3660d
update verbiage
stevenGravy May 22, 2023
85870fa
update language
stevenGravy May 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 28 additions & 4 deletions docs/pages/management/operations/enroll-agent-into-automatic-updates.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,15 +36,15 @@ updates.

<Tabs>
<TabItem label="Self-hosted">
- A Teleport agent, either:
- A Teleport Enterprise agent, either:
- started via systemd on a distribution using the `apt` or `yum` package managers
- deployed with the `teleport-kube-agent` Helm chart
- automatic update infrastructure set up. For Self-Hosted users this means you
already followed [this guide](./self-hosted-automatic-agent-updates.mdx) and
know your version server URL and release channel
</TabItem>
<TabItem label="Teleport Cloud">
- A Teleport agent, either:
- A Teleport Enterprise agent, either:
- started via systemd on a distribution using the `apt` or `yum` package managers
- deployed with the `teleport-kube-agent` Helm chart
- as a Teleport Cloud user, you must check if your Could Tenant is enrolled
Expand All @@ -57,6 +57,13 @@ updates.
<Tabs dropdownCaption="Cluster Type" dropdownSelected="Self-hosted">
<TabItem label="systemd" options="Self-hosted">

Confirm you have the Teleport Enterprise edition installed.

```code
$ teleport version
Teleport Enterprise v(=teleport.version=) go(=teleport.golang=)
```

Create the upgrade configuration directory:

```code
Expand All @@ -69,16 +76,20 @@ Else, you can skip this step:

```code
$ sudo touch /etc/teleport-upgrade.d/schedule
$ sudo chown <your-teleport-user> /etc/teleport-upgrade.d/schedule
$ sudo chown <Var name="your-teleport-user" /> /etc/teleport-upgrade.d/schedule
Copy link
Copy Markdown
Collaborator

@zmb3 zmb3 May 22, 2023

Choose a reason for hiding this comment

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

I thought you couldn't use vars in code blocks?

Copy link
Copy Markdown
Contributor Author

@stevenGravy stevenGravy May 22, 2023

Choose a reason for hiding this comment

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

You can. You can't in other types like yaml.

image

```

Configure the updater to connect to your custom version server and subscribe
to the right release channel:

```code
$ echo <version-server-url/path>/<release-channel> | sudo tee /etc/teleport-upgrade.d/endpoint
$ echo <Var name="version-server-url/path" />/<Var name="release-channel" /> | sudo tee /etc/teleport-upgrade.d/endpoint
```

<Admonition type="tip" title="Note">
Make sure not to include `https://` as a prefix to the server address.
</Admonition>

Install the `teleport-ent-updater` package (note: your teleport agent will be restarted during install):

```code
Expand Down Expand Up @@ -111,6 +122,9 @@ not be exported yet.

<TabItem label="teleport-kube-agent chart" options="Self-hosted">

Confirm you are using the Teleport Enterprise image. The `enterprise` value setting
should have been set to `true` for the Helm chart installation.

Add the following chart values to your existing agent `values.yaml`:

```yaml
Expand Down Expand Up @@ -143,6 +157,13 @@ $ kubectl logs <your-agent-release>-updater
</TabItem>
<TabItem label="systemd " options="Teleport Cloud">

Confirm you have the Teleport Enterprise edition installed.

```code
$ teleport version
Teleport Enterprise v(=teleport.version=) go(=teleport.golang=)
```

If you changed the agent user to run as non-root, create
`/etc/teleport-upgrade.d/schedule` and grant ownership to your Teleport user.
Else, you can skip this step:
Expand Down Expand Up @@ -184,6 +205,9 @@ not be exported yet.
</TabItem>
<TabItem label="teleport-kube-agent chart " options="Teleport Cloud">

Confirm you are using the Teleport Enterprise image. The `enterprise` value setting
should have been set to `true` for the Helm chart installation.

Add the following chart values to your existing agent `values.yaml`:

```yaml
Expand Down