Fix Cloud installation instructions #39508
Conversation
The current instructions are missing a `"` character in the `curl` command and target the wrong channel for the current Teleport Cloud version: `default` instead of `stable/cloud`. This change corrects the instructions.
|
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 |
|
I believe there's still an issue that the apt and other instructions point to a version repo not cloud. |
|
🤖 Vercel preview here: https://docs-8it20rjej-goteleport.vercel.app/docs/ver/preview |
stevenGravy
added
the
no-changelog
|
@bernardjkim Would it make sense to change I suppose we could add instructions to check whether the updater is on a different major version than Teleport Cloud first, then have the user assign |
By This is why we're currently instructing users to first query the latest compatible version from the proxy endpoint. It's not ideal, but it is a temporary workaround. However, we're planning to simplify this in the future. We're planning on having the Teleport updater manage the installation of Teleport. This would mean that all users can just install the latest version of the Teleport updater and the Teleport updater will install the latest compatible version of Teleport for the user. |
I thought we had gone with the cloud repo so they don't have to go back in and change after the proxy/auth updates. That way they don't have to change their repo settings which could be a lot of work and isn't automatic now. |
Per this it seems cloud repo still makes sense until this is applied. |
Yeah, that's correct. All cloud tenants should be using the Sorry, I didn't realize TELEPORT_VERSION variable was being used in two different places here. When using the installation script we want to specify the exact version of Teleport. When installing Teleport from the package repository, the I updated the other page in #38401 with these changes, but I must have missed this one by mistake. |
|
Also: the zypper install instructions contain a yum command, and don't trust the teleport repo signing keys |
|
@stevenGravy @bernardjkim I've pushed some more fixes! @hugoShaka I've fixed the |
|
🤖 Vercel preview here: https://docs-er80l3wl3-goteleport.vercel.app/docs/ver/preview |
|
On the first teleport install, it complains about not trusting the repo keys and wants manual action. It would fail if the script were to be run in a non-interactive shell. I could not trust the gpg keys in a single |
|
@hugoShaka Thanks! That was my experience too, and I'm not sure what we can change in the installation instructions to produce a better experience. I think @fheinecke is investigating. |
If you make a separate refresh like in my previous example it works properly, it doesn't ask for manual action during the install command and works in non-interactive shells: $ zypper addrepo --repo $(rpm --eval "https://zypper.releases.teleport.dev/sles/15/Teleport/%{_arch}/stable/cloud/teleport-zypper.repo")
$ zypper --gpg-auto-import-keys refresh
$ zypper install -y teleport-ent |
ptgott
force-pushed
the
paul.gottschling/2024-03-18-installation
branch
from
a2f5ba4 to
b238c9e
Compare
|
@hugoShaka Thanks! Made this change in b238c9e2082f659ab493779bf9afe8e0ca180ede. @stevenGravy This is ready for another review, I think. |
|
🤖 Vercel preview here: https://docs-7khfklh54-goteleport.vercel.app/docs/ver/preview |
- For Cloud users, specify a `teleport-ent` version. - Turn the release channel into an environment variable so Cloud users can use `stable/cloud`. - Correct an errant `yum` command in the `zypper` instructions. Also trust the repo key.
ptgott
force-pushed
the
paul.gottschling/2024-03-18-installation
branch
from
b238c9e to
03dd48a
Compare
|
🤖 Vercel preview here: https://docs-mn4gi18cf-goteleport.vercel.app/docs/ver/preview |
|
@bernardjkim can you review this one and make sure the recommended repos here are in line with our latest guidance for automatic upgrades? |
| $ 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/stable/cloud/version | sed 's/v//')" | ||
| $ export TELEPORT_PKG="teleport-ent-${TELEPORT_VERSION?} teleport-ent-updater" |
There was a problem hiding this comment.
Ah, ran into an error here. When installing via apt, the command should be
apt-get install teleport-ent=X.Y.Z instead of apt-get install teleport-ent-X.Y.Z
Other than that. Looks good, thanks!
Add a note re: specifying a `teleport-ent` version on Debian/Ubuntu.
|
🤖 Vercel preview here: https://docs-pgrxfw516-goteleport.vercel.app/docs/ver/preview |
|
@ptgott is there any way to keep these in sync with our smoke tests? Can the contents of the code blocks maybe be loaded from another file, that I could also pull into a GHA workflow at release time? This could help prevent issues like we have with Zypper where the instructions don't actually work. |
|
@fheinecke This seems doable. I'll open an issue so we can work on this separately from this PR. It would also be nice to sync the package manager-specific installation logic in our one-line installation script with these instructions. |
|
@zmb3 It looks like this still needs one approval from a required reviewer. Would you have time to give this a look? Thanks! |
public-teleport-github-review-bot
bot
removed request for
r0mant,
hugoShaka and
xinding33
The current instructions are missing a
"character in thecurlcommand and target the wrong channel for the current Teleport Cloud version:defaultinstead ofstable/cloud. This change corrects the instructions.