While addressing #10636, I noticed that the Details box that appears
for Cloud users when they visit some of our Helm guides is in a slightly
odd location, in the middle of a Prerequisites item. I have moved this to
the top of each guide instead.
I have also refactored the helm-install.mdx partial to split it into
multiple partials, which allows us to use the "Step n/d" format in our
Helm guides.
Also adds a Cloud warning to the Digital Ocean Helm guide.
* Situate the Installation guide more clearly
For a reader who begins their journey through the Teleport docs
with the Installation guide, it can be difficult to determine
what to do after following the guide. This change makes the
relationship between the Installation page and other docs pages
clearer by:
- Adding an Admonition to read the Getting Started guides if you
have not yet tried Teleport. These guides include installation
instructions, so they can be our recommended starting place.
- Adding a Next Steps section that links to instructions on
enabling Teleport for different infrastructure resources.
Closes#9355
* Respond to PR feedback
Since we no longer support version 5, including this guide only
risks misleading current/prospective users. This change removes
the v5 migration guide and redirects the path to the Kubernetes Access
Introduction page.
* Add Cloud-specific instructions to two guides
Ensure that users of a particular scope don't see irrelevant info
See #10633
GitHub SSO guide
- Edit the tctl partial to show only scope-relevant info.
- Use tabs in the Prerequisites
- Light edits for clarity
Adding Nodes
- Use Tabs for prerequisites
- Move sections specific to self-hosted deployments into Details
boxes that are hidden for Cloud users
- Use Tabs components to offer Cloud-specific alternatives to
examples of commands that presuppose a self-hosted deployment
- Misc clarity edits
* Respond to PR feedback
* Fix linter issues
* helm: Adds extraArgs and extraEnv to teleport-kube-agent
These were present in teleport-cluster but not teleport-kube-agent. This PR fixes that.
* Line breaks
* Also add to StatefulSet
- Rename the page, since it's about diagnostics rather than metrics
alone
- Change major section headings to H2s so they apper in the table of
contents
- Move information about heartbeats and recovery to an H3 so it's
more visible
Updates #10799
Co-authored-by: Paul Gottschling <paul.gottschling@goteleport.com>
* Mention Cloud compatibility in three guides
Server Access getting started:
- Remove the instructions to install and set up the Auth
Service, and add references to main Getting Started guides
and Cloud signup page.
- Add a prerequisite to have deployed the Auth Service and
Proxy Service.
EC2 joining guide: make it explicit that the Cloud is not
compatible with this. Also make small style tweaks.
App Access getting started page:
- The guide assumes that you are running the Auth Service,
Proxy Service, and App Service via the same binary, which
does not work for Cloud users.
* Respond to PR feedback
- Add newlines after headings
- Use teleport app start instead of teleport start --roles=app
- Fix incorrect Ubuntu version number
- Add a Details box explaining tctl usage for Cloud
- Correctly capitalize "Node"
* Fix bot_name in Machine ID docs
Follow-up to #11039, this fixes the bot_name token field to use the
revised value (bot name rather than bot username, to match the field
name).
See also #10854
* Remove outdated comment warning
* Change token example to add node only
Given that it's not possible to join a proxy server via proxy address (`teleport.example.com:443`) and there relatively few circumstances where people would want to add both `node` and `proxy` services on one cluster, I think this example is likely to cause more confusion than anything else.
* Update adding-nodes.mdx
Remove static token example and tidy up
start-auth-proxy.mdx is a partial used by a number of Database Access
guides. After PR #9556, the partial included garbled instructions for
setting up Teleport with Let's Encrypt. This change edits these
instructions for clarity.
* Add plugin setup instructions for cloud users
- Turn the identity file export and RBAC instructions into
includes, since these instructions are the same for each
plugin.
- Change the tab set re: an impersonation role to a detail box
scoped to cloud users.
- Add separate example config files for cloud and self-hosted
deployments of each plugin.
- Misc. changes for clarity
Fixes#8936
* Respond to PR feedback
Also make minor stylistic tweaks
* Respond to PR feedback with stylistic tweaks
* Standardize ACME instruction details
Our Getting Started guides often include instructions for
configuring Let's Encrypt and ACME before starting
Teleport, but not all of these instructions have the same
level of detail, and some are missing some context around
how Teleport uses ACME and why you need to open port 443 on
your Proxy Service host. This change adds an include that
spells out these instructions and invokes the include in the
appropriate guides.
The intention was to include as much relevant information within
the guides themselves to prevent the reader from having to
navigate to other pages.
Closes#6448
* Respond to PR feedback
- Substitute "proxy" for "node" where it was incorrectly used
- Some small stylistic fixes
- Clarify that "teleport configure" does not write the config
itself
* Add Cloud compatibility notes to guides
Add Details boxes to some guides that do not mention Teleport
Cloud, indicating how each guide relates to Teleport Cloud users.
* Respond to PR feedback
Removes Details boxes unless necessary to warn users of
incompatibility with Teleport Cloud.
Also makes minor stylistic tweaks.
* Clarify Cloud compatibility in the VS Code guide
- Mention Teleport Cloud in the guide's Prerequisites section
- Add a warning for Cloud users re: the tsh config command
Also add misc style and clarity tweaks.
* Respond to PR feedback
* Address PR feedback
- Fix spelling
- Clarify the username you should use in the ssh command
`aws elb describe-load-balancers` is old command and does not output latest LBs. for new LBs `aws elbv2` shall be used. Output structure is little different so, whole line is changed (i.e. jq filter too).
* Fix meta description clash
Two docs pages had the same meta description, which hurts SEO.
This changes the meta description of one of the page and uses
this opportunity to do some light copy editing.
Fixes#8713
* Respond to PR feedback
* Updating quick start enterprise
- Add in logins since users have been skipping the access role part
- Use the joe user directly and mention it must exist (easy miss)
- HTTPS mention correction
Paul Gottschling