From 638823f261d30c6b8343ced8e6918851613b223f Mon Sep 17 00:00:00 2001 From: Steven Martin Date: Mon, 22 May 2023 13:07:53 -0400 Subject: [PATCH 1/3] docs: update agent updates --- .../enroll-agent-into-automatic-updates.mdx | 32 ++++++++++++++++--- 1 file changed, 28 insertions(+), 4 deletions(-) diff --git a/docs/pages/management/operations/enroll-agent-into-automatic-updates.mdx b/docs/pages/management/operations/enroll-agent-into-automatic-updates.mdx index 4b1129c6e086b..3a2e2461144ce 100644 --- a/docs/pages/management/operations/enroll-agent-into-automatic-updates.mdx +++ b/docs/pages/management/operations/enroll-agent-into-automatic-updates.mdx @@ -36,7 +36,7 @@ updates. -- A Teleport agent, either: +- A Teleport Enterprise version 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 @@ -44,7 +44,7 @@ updates. know your version server URL and release channel -- A Teleport agent, either: +- A Teleport Enterprise version 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 @@ -57,6 +57,13 @@ updates. +Confirm you have the Teleport Enterprise version installed. + +```code +$ teleport version +Teleport Enterprise v(=teleport.version=) go(=teleport.golang=) +``` + Create the upgrade configuration directory: ```code @@ -69,16 +76,20 @@ Else, you can skip this step: ```code $ sudo touch /etc/teleport-upgrade.d/schedule -$ sudo chown /etc/teleport-upgrade.d/schedule +$ sudo chown /etc/teleport-upgrade.d/schedule ``` Configure the updater to connect to your custom version server and subscribe to the right release channel: ```code -$ echo / | sudo tee /etc/teleport-upgrade.d/endpoint +$ echo / | sudo tee /etc/teleport-upgrade.d/endpoint ``` + +Make sure not to include `https://` as a prefix to the server address. + + Install the `teleport-ent-updater` package (note: your teleport agent will be restarted during install): ```code @@ -111,6 +122,9 @@ not be exported yet. +Confirm you are using the 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 @@ -143,6 +157,13 @@ $ kubectl logs -updater +Confirm you have the Teleport Enterprise version 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: @@ -184,6 +205,9 @@ not be exported yet. +Confirm you are using the 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 From ac3660d39b3cc651f28b887323022745de5865dd Mon Sep 17 00:00:00 2001 From: Steven Martin Date: Mon, 22 May 2023 14:54:05 -0400 Subject: [PATCH 2/3] update verbiage Co-authored-by: Paul Gottschling --- .../enroll-agent-into-automatic-updates.mdx | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/pages/management/operations/enroll-agent-into-automatic-updates.mdx b/docs/pages/management/operations/enroll-agent-into-automatic-updates.mdx index 3a2e2461144ce..01fee3f0ec324 100644 --- a/docs/pages/management/operations/enroll-agent-into-automatic-updates.mdx +++ b/docs/pages/management/operations/enroll-agent-into-automatic-updates.mdx @@ -57,7 +57,7 @@ updates. -Confirm you have the Teleport Enterprise version installed. +Confirm you have the Teleport Enterprise edition installed. ```code $ teleport version @@ -122,8 +122,8 @@ not be exported yet. -Confirm you are using the enterprise image. The `enterprise` value setting -should have been set to `true` for the helm chart installation. +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`: @@ -157,7 +157,7 @@ $ kubectl logs -updater -Confirm you have the Teleport Enterprise version installed. +Confirm you have the Teleport Enterprise edition installed. ```code $ teleport version @@ -205,8 +205,8 @@ not be exported yet. -Confirm you are using the enterprise image. The `enterprise` value setting -should have been set to `true` for the helm chart installation. +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`: From 85870faa54ced8b505a52ec2cc9ad96b12f43479 Mon Sep 17 00:00:00 2001 From: Steven Martin Date: Mon, 22 May 2023 14:55:41 -0400 Subject: [PATCH 3/3] update language --- .../operations/enroll-agent-into-automatic-updates.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/pages/management/operations/enroll-agent-into-automatic-updates.mdx b/docs/pages/management/operations/enroll-agent-into-automatic-updates.mdx index 01fee3f0ec324..57c4d03fa6fb0 100644 --- a/docs/pages/management/operations/enroll-agent-into-automatic-updates.mdx +++ b/docs/pages/management/operations/enroll-agent-into-automatic-updates.mdx @@ -36,7 +36,7 @@ updates. -- A Teleport Enterprise version 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 @@ -44,7 +44,7 @@ updates. know your version server URL and release channel -- A Teleport Enterprise version 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