mirror of
https://github.com/gravitational/teleport.git
synced 2026-11-04 19:12:46 +08:00
Paul Gottschling
2bd4f277bb
* Make the Labeling guide easier to follow See #11841 The current guide is a conceptual introduction to Teleport's labeling functionality. Since we cover this information in our reference guides, I wanted to make it possible for readers to follow this guide as a tutorial and get started labeling resources quickly. - Introduce labels at the beginning of the guide to set the stage conceptually before the steps begin. - Clarify in the Prerequisites section that the instructions in the guide apply to any Teleport resource, not just Nodes - Require a host for running a Teleport Node in the Prerequisites and include instructions for starting the Node. Previously, we included sample commands/config for applications as well. Requiring a Node and including setup instructions for that Node will ensure that all instructions in the guide can be followed easily. - Add scoped instructions via Tabs and ScopedBlocks. - Reorganize sections into a series of steps. - Add commands to verify that labels have been added. * Respond to PR feedback * Improve the Labeling guide for self-hosted users See: #11841 - Edit tctl.mdx: Users of self-hosted Teleport can run tctl commands from their local machines after logging in to a cluster, just like they can with Teleport Cloud. I have edited tctl.mdx to instruct self- hosted users to use tctl remotely. This way, users won't need to access their Auth Service hosts in order to follow the guides that use tctl.mdx. - Add steps for fixing unexpected "tsh ls" output Also applies PR feedback. - Add provisions for labeling specific resources as a table near the top of the page. - Remove the option to add labels using CLI flags. - Fix command output spacing Also misc. clarity tweaks. * Respond to PR feedback
45 lines
1.0 KiB
Plaintext
45 lines
1.0 KiB
Plaintext
<Details
|
|
title="Make sure you can connect to Teleport"
|
|
scope={["oss", "enterprise"]}
|
|
scopeOnly={true}
|
|
opened={true}
|
|
>
|
|
|
|
To connect to Teleport, log in to your cluster using `tsh`, then use `tctl`
|
|
remotely:
|
|
|
|
```code
|
|
$ tsh login --proxy=teleport.example.com --user=email@example.com
|
|
$ tctl status
|
|
# Cluster teleport.example.com
|
|
# Version (=teleport.version=)
|
|
# CA pin (=presets.ca_pin=)
|
|
```
|
|
|
|
You can run subsequent `tctl` commands in this guide on your local machine.
|
|
|
|
For full privileges, you can also run `tctl` commands on your Auth Service host.
|
|
|
|
</Details>
|
|
<Details
|
|
title="Make sure you can connect to Teleport"
|
|
scope={["cloud"]}
|
|
scopeOnly={true}
|
|
opened={true}
|
|
>
|
|
|
|
To connect to Teleport, log in to your cluster using `tsh`, then use `tctl`
|
|
remotely:
|
|
|
|
```code
|
|
$ tsh login --proxy=myinstance.teleport.sh --user=email@example.com
|
|
$ tctl status
|
|
# Cluster myinstance.teleport.sh
|
|
# Version (=cloud.version=)
|
|
# CA pin sha256:sha-hash-here
|
|
```
|
|
|
|
You must run subsequent `tctl` commands in this guide on your local machine.
|
|
|
|
</Details>
|