Skip to content

Commit

Permalink
docs: Set correct repo version based on Cloud automatic upgrader output
Browse files Browse the repository at this point in the history
  • Loading branch information
webvictim committed Mar 27, 2024
1 parent b9b5905 commit d835781
Showing 1 changed file with 30 additions and 30 deletions.
60 changes: 30 additions & 30 deletions docs/pages/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ the same major version as the service that manages automatic updates:
```code
$ TELEPORT_EDITION="cloud"
$ TELEPORT_DOMAIN=<Var name="example.teleport.sh" />
$ TELEPORT_VERSION="$(curl https://$TELEPORT_DOMAIN/v1/webapi/automaticupgrades/channel/default/version | sed 's/v//')
$ TELEPORT_VERSION="$(curl https://$TELEPORT_DOMAIN/v1/webapi/automaticupgrades/channel/default/version | sed 's/v//')"
```

</TabItem>
Expand All @@ -126,7 +126,7 @@ Download and run the installation script on the server where you want to install
Teleport:

```code
$ curl https://goteleport.com/static/install.sh | bash -s ${TELEPORT_VERSION?} ${TELEPORT_EDITION?}
$ curl https://goteleport.com/static/install.sh | bash -s ${TELEPORT_VERSION?} ${TELEPORT_EDITION?}
```

### Package repositories
Expand All @@ -145,40 +145,40 @@ repositories.

<Tabs>
<TabItem label="Teleport Community Edition">

```code
$ export TELEPORT_PKG=teleport
$ export TELEPORT_VERSION=v(=teleport.major_version=)
```

</TabItem>
<TabItem label="Teleport Cloud">

Teleport Cloud installations must include the automatic agent updater. The
following commands show you how to determine the Teleport version to install
by querying your Teleport Cloud account. This way, the Teleport installation
has the same major version as the service that conducts automatic updates:

```code
$ export TELEPORT_PKG="teleport-ent teleport-ent-updater"
$ export TELEPORT_DOMAIN=<Var name="example.teleport.com" />
$ export TELEPORT_VERSION="$(curl https://$TELEPORT_DOMAIN/v1/webapi/automaticupgrades/channel/default/version | sed 's/v//')
$ export TELEPORT_VERSION="$(curl https://$TELEPORT_DOMAIN/v1/webapi/automaticupgrades/channel/default/version | cut -d. -f1)"
```

</TabItem>
<TabItem label="Teleport Enterprise (Self-Hosted)">

```code
$ export TELEPORT_PKG=teleport-ent
$ export TELEPORT_VERSION=v(=teleport.major_version=)
```

For FedRAMP/FIPS-compliant installations, install the `teleport-ent-fips` package instead:

```code
$ export TELEPORT_PKG=teleport-ent-fips
```

</TabItem>
</Tabs>

Expand All @@ -196,9 +196,9 @@ repositories.
distribution variants. When installing Teleport using RPM repositories, you
may need to replace the `ID` variable set in `/etc/os-release` with `ID_LIKE`
to install packages of the closest supported distribution.

Currently supported distributions (and `ID` values) are:

| Distribution | Version | `ID` value in `/etc/os-release` |
|--------------|----------------------|---------------------------------|
| Amazon Linux | 2 and 2023 | `amzn` |
Expand All @@ -207,12 +207,12 @@ repositories.
| RHEL | >= 7 | `rhel` |
| SLES | >= 12 SP5, >= 15 SP5 | `sles` |
| Ubuntu | >= 16.04 | `ubuntu` |

Note that [Enhanced Session
Recording](./server-access/guides/bpf-session-recording.mdx) requires Linux
kernel version 5.8+. This means that it requires more recent OS versions than
other Teleport features:

| Distribution | Version |
|--------------|--------------------------|
| Amazon Linux | 2 (post 11/2021), 2023 |
Expand All @@ -226,7 +226,7 @@ repositories.

<Tabs>
<TabItem label="apt">

```code
# Download the Teleport PGP public key
$ sudo curl https://apt.releases.teleport.dev/gpg \
Expand All @@ -237,15 +237,15 @@ repositories.
https://apt.releases.teleport.dev/${ID?} ${VERSION_CODENAME?} \
stable/${TELEPORT_VERSION?}" \
| sudo tee /etc/apt/sources.list.d/teleport.list > /dev/null
$ sudo apt-get update
$ sudo apt-get install ${TELEPORT_PKG?}
```

</TabItem>

<TabItem label="yum">

```code
# Add the Teleport YUM repository. You'll need to update this file for each
# major release of Teleport.
Expand All @@ -259,11 +259,11 @@ repositories.
# Tip: Add /usr/local/bin to path used by sudo (so 'sudo tctl users add' will work as per the docs)
# echo "Defaults secure_path = /sbin:/bin:/usr/sbin:/usr/bin:/usr/local/bin" > /etc/sudoers.d/secure_path
```

</TabItem>

<TabItem label="zypper">

```code
# Add the Teleport Zypper repository. You'll need to update this file for each
# major release of Teleport.
Expand All @@ -277,11 +277,11 @@ repositories.
# Tip: Add /usr/local/bin to path used by sudo (so 'sudo tctl users add' will work as per the docs)
# echo "Defaults secure_path = /sbin:/bin:/usr/sbin:/usr/bin:/usr/local/bin" > /etc/sudoers.d/secure_path
```

</TabItem>

<TabItem label="dnf">

```code
# Add the Teleport YUM repository for v(=teleport.major_version=). You'll need to update this
# file for each major release of Teleport.
Expand All @@ -292,14 +292,14 @@ repositories.
$ sudo yum install -y yum-utils
# Use the dnf config manager plugin to add the teleport RPM repo
$ sudo dnf config-manager --add-repo "$(rpm --eval "https://yum.releases.teleport.dev/$ID/$VERSION_ID/Teleport/%{_arch}/stable/${TELEPORT_VERSION?}/teleport.repo")"
# Install teleport
$ sudo dnf install ${TELEPORT_PKG}
# Tip: Add /usr/local/bin to path used by sudo (so 'sudo tctl users add' will work as per the docs)
# echo "Defaults secure_path = /sbin:/bin:/usr/sbin:/usr/bin:/usr/local/bin" > /etc/sudoers.d/secure_path
```

</TabItem>
</Tabs>

Expand Down Expand Up @@ -338,7 +338,7 @@ script](#one-line-installation-script) or manually install Teleport from a
$ SYSTEM_ARCH=""
```

The following architecture values are available:
The following architecture values are available:

- `amd64`
- `arm64`
Expand Down

0 comments on commit d835781

Please sign in to comment.