-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[v16] docs: use code styling instead of bash (#47749)
* docs: use code styling instead of bash * docs: revert host user creation * docs: add prompt for tctl
- Loading branch information
1 parent
4e06dbb
commit 210e92c
Showing
27 changed files
with
57 additions
and
57 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -49,16 +49,16 @@ To add saved sessions to PuTTY: | |
|
||
1. Sign into a Teleport cluster using the `tsh login` command: | ||
|
||
```bash | ||
C:\Users\gus>tsh login --proxy=teleport.example.com | ||
```code | ||
$ tsh login --proxy=teleport.example.com | ||
``` | ||
|
||
This command retrieves your user certificates and saves them in a local file in the `%USERPROFILE%/.tsh` directory. | ||
|
||
2. List SSH nodes that the user can connect to inside the cluster: | ||
|
||
```bash | ||
C:\Users\gus>tsh ls | ||
```code | ||
$ tsh ls | ||
Node Name Address Labels | ||
----------------------------------- -------------- ---------------------------- | ||
ip-172-31-30-140 127.0.0.1:3022 company=acmecorp,env=aws,... | ||
|
@@ -71,8 +71,8 @@ ip-172-31-8-63 172.31.8.63:22 type=openssh | |
For example, you can add a saved session for the login `ubuntu` on the node `ip-172-31-30-140` to the Windows | ||
registry by running the following command: | ||
|
||
```bash | ||
C:\Users\gus>tsh puttyconfig ubuntu@ip-172-31-30-140 | ||
```code | ||
$ tsh puttyconfig ubuntu@ip-172-31-30-140 | ||
Added PuTTY session for ubuntu@ip-172-31-30-140 [proxy:teleport.example.com] | ||
``` | ||
|
||
|
@@ -82,8 +82,8 @@ If you are adding a session for a registered OpenSSH node within your cluster (a | |
[`teleport join openssh`](../enroll-resources/server-access/openssh/openssh-agentless.mdx)), you must specify the `sshd` port | ||
(usually 22) when adding a session with `tsh puttyconfig`: | ||
|
||
```bash | ||
C:\Users\gus>tsh puttyconfig --port 22 ubuntu@ip-172-31-8-63 | ||
```code | ||
$ tsh puttyconfig --port 22 ubuntu@ip-172-31-8-63 | ||
Added PuTTY session for ubuntu@ip-172-31-8-63 [proxy:teleport.example.com] | ||
``` | ||
|
||
|
@@ -94,16 +94,16 @@ You can also use `tsh puttyconfig user@host:22` if you prefer. | |
|
||
1. Sign into a Teleport cluster using the `tsh login` command: | ||
|
||
```bash | ||
C:\Users\gus>tsh login --proxy=mytenant.teleport.sh | ||
```code | ||
$ tsh login --proxy=mytenant.teleport.sh | ||
``` | ||
|
||
This command retrieves your user certificates and saves them in a local file in the `%USERPROFILE%/.tsh` directory. | ||
|
||
2. List SSH nodes that the user can connect to inside the cluster: | ||
|
||
``` | ||
C:\Users\gus>tsh ls | ||
$ tsh ls | ||
Node Name Address Labels | ||
----------------------------------- -------------- ---------------------------- | ||
ip-172-31-30-140 ⟵ Tunnel company=acmecorp,env=aws,... | ||
|
@@ -115,8 +115,8 @@ ip-172-31-34-128.us-east-2.compu... ⟵ Tunnel access=open,enhanced_reco... | |
For example, you can add a saved session for the login `ubuntu` on the node `ip-172-31-30-140` to the Windows | ||
registry by running the following command: | ||
|
||
```bash | ||
C:\Users\gus>tsh puttyconfig ubuntu@ip-172-31-30-140 | ||
```code | ||
$ tsh puttyconfig ubuntu@ip-172-31-30-140 | ||
Added PuTTY session for ubuntu@ip-172-31-30-140 [proxy:mytenant.teleport.sh] | ||
``` | ||
|
||
|
@@ -154,8 +154,8 @@ recording of the session after you stop the session and disconnect from the host | |
|
||
To list available leaf clusters, run the following command: | ||
|
||
```bash | ||
C:\Users\gus>tsh clusters | ||
```code | ||
$ tsh clusters | ||
Cluster Name Status Cluster Type Labels Selected | ||
----------------- ------ ------------ ------ -------- | ||
teleport.example.com online root * | ||
|
@@ -167,8 +167,8 @@ You can access a leaf cluster in a PuTTY session by adding the `--leaf <leaf clu | |
For example, if your leaf cluster is named `example.teleport.sh` and your node is called `ip-172-31-34-128.us-east-2.compute.internal`, | ||
you can add a PuTTY session for the login `ec2-user` using the following command: | ||
|
||
```bash | ||
C:\Users\gus>tsh puttyconfig --leaf example.teleport.sh [email protected] | ||
```code | ||
$ tsh puttyconfig --leaf example.teleport.sh [email protected] | ||
Added PuTTY session for [email protected] [leaf:example.teleport.sh,proxy:teleport.example.com] | ||
``` | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.