Skip to content

Commit

Permalink
Respond to PR feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
ptgott committed Jul 6, 2022
1 parent d39be6e commit 193c9f0
Show file tree
Hide file tree
Showing 12 changed files with 44 additions and 29 deletions.
5 changes: 3 additions & 2 deletions docs/pages/access-controls/reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,9 @@ To see the list of roles in a Teleport cluster, an administrator can execute:
<ScopedBlock scope={["oss", "enterprise"]}>

```code
# Log in to your cluster with tsh so you can use tctl.
# You can also run tctl on your Auth Service host.
# Log in to your cluster with tsh so you can use tctl from your local machine.
# You can also run tctl on your Auth Service host without running "tsh login"
# first.
$ tsh login --user=myuser --proxy=teleport.example.com
$ tctl get roles
```
Expand Down
5 changes: 3 additions & 2 deletions docs/pages/application-access/guides/connecting-apps.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,9 @@ join the cluster. Generate a short-lived join token and save it for example
in `/tmp/token`:

```code
# Log in to your cluster with tsh so you can use tctl.
# You can also run tctl on your Auth Service host.
# Log in to your cluster with tsh so you can use tctl from your local machine.
# You can also run tctl on your Auth Service host without running "tsh login"
# first.
$ tsh login --user=myuser --proxy=teleport.example.com
$ tctl tokens add \
--type=app \
Expand Down
5 changes: 3 additions & 2 deletions docs/pages/application-access/guides/dynamic-registration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,9 @@ To create an application resource, run:
<ScopedBlock scope={["oss", "enterprise"]}>

```code
# Log in to your Teleport cluster so you can use tctl remotely.
# You can also run tctl on your Auth Service host.
# Log in to your cluster with tsh so you can use tctl from your local machine.
# You can also run tctl on your Auth Service host without running "tsh login"
# first.
$ tsh login --proxy=teleport.example.com --user=myuser
$ tctl create app.yaml
```
Expand Down
7 changes: 4 additions & 3 deletions docs/pages/application-access/reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -100,8 +100,9 @@ assume that you have created a YAML file called `app.yaml` with your configurati
<ScopedBlock scope={["oss", "enterprise"]}>

```code
# Log in to your Teleport cluster.
# You can also run tctl on your Auth Service host.
# Log in to your cluster with tsh so you can use tctl from your local machine.
# You can also run tctl on your Auth Service host without running "tsh login"
# first.
$ tsh login --proxy=teleport.example.com --user=myuser
# Create the resource
$ tctl create -f app.yaml
Expand All @@ -111,7 +112,7 @@ $ tctl create -f app.yaml
<ScopedBlock scope={["cloud"]}>

```code
# Log in to your Teleport cluster.
# Log in to your cluster with tsh so you can use tctl from your local machine.
$ tsh login --proxy=mytenant.teleport.sh --user=myuser
# Create the resource.
$ tctl create -f app.yaml
Expand Down
7 changes: 4 additions & 3 deletions docs/pages/database-access/reference/configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -171,8 +171,9 @@ assume that you have created a YAML file called `db.yaml` with your configuratio
<ScopedBlock scope={["oss", "enterprise"]}>

```code
# Log in to your Teleport cluster.
# You can also run tctl on your Auth Service host.
# Log in to your cluster with tsh so you can use tctl from your local machine.
# You can also run tctl on your Auth Service host without running "tsh login"
# first.
$ tsh login --proxy=teleport.example.com --user=myuser
# Create the resource
$ tctl create -f db.yaml
Expand All @@ -182,7 +183,7 @@ $ tctl create -f db.yaml
<ScopedBlock scope={["cloud"]}>

```code
# Log in to your Teleport cluster
# Log in to your Teleport cluster so you can use tctl from your local machine.
$ tsh login --proxy=mytenant.teleport.sh --user=myuser
# Create the resource
$ tctl create -f db.yaml
Expand Down
5 changes: 3 additions & 2 deletions docs/pages/desktop-access/troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,9 @@ new CA using the following command:
<ScopedBlock scope={["oss", "enterprise"]}>

```code
# Log in to your Teleport cluster so you can use tctl remotely.
# You can also run tctl on your Auth Service host.
# Log in to your cluster with tsh so you can use tctl from your local machine.
# You can also run tctl on your Auth Service host without running "tsh login"
# first.
$ tsh login --proxy=teleport.example.com --user=myuser
$ tctl auth export --type=windows >user-ca.cer
```
Expand Down
7 changes: 4 additions & 3 deletions docs/pages/enterprise/sso/oidc.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,9 @@ Create the connector:
<ScopedBlock scope={["oss", "enterprise"]}>

```code
# Log in to your Teleport cluster so you can use tctl remotely.
# You can also run tctl on your Auth Service host.
# Log in to your cluster with tsh so you can use tctl from your local machine.
# You can also run tctl on your Auth Service host without running "tsh login"
# first.
$ tsh login --proxy=teleport.example.com --user=myuser
$ tctl create oidc-connector.yaml
```
Expand All @@ -80,7 +81,7 @@ $ tctl create oidc-connector.yaml
<ScopedBlock scope={["cloud"]}>

```code
# Log in to your Teleport cluster so you can use tctl remotely
# Log in to your Teleport cluster so you can use tctl remotely.
$ tsh login --proxy=mytenant.teleport.sh --user=myuser
$ tctl create oidc-connector.yaml
```
Expand Down
5 changes: 3 additions & 2 deletions docs/pages/kubernetes-access/controls.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -123,8 +123,9 @@ Create or update this role using `tctl`:
<ScopedBlock scope={["oss", "enterprise"]}>

```code
# Log in to your Teleport cluster so you can use tctl remotely.
# You can also run tctl on your Auth Service host.
# Log in to your cluster with tsh so you can use tctl from your local machine.
# You can also run tctl on your Auth Service host without running "tsh login"
# first.
$ tsh login --proxy=teleport.example.com --user=myuser
$ tctl create -f member.yaml
```
Expand Down
5 changes: 3 additions & 2 deletions docs/pages/kubernetes-access/guides/cicd.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,9 @@ Generate a `kubeconfig` using the `jenkins` user and its roles using [`tctl auth
<ScopedBlock scope={["oss", "enterprise"]}>

```code
# Log in to your Teleport cluster so you can use tctl remotely.
# You can also run tctl on your Auth Service host.
# Log in to your cluster with tsh so you can use tctl from your local machine.
# You can also run tctl on your Auth Service host without running "tsh login"
# first.
$ tsh login --proxy=teleport.example.com --user=myuser
# Create a new local user for Jenkins
$ tctl users add jenkins --roles=robot
Expand Down
5 changes: 4 additions & 1 deletion docs/pages/server-access/guides/tsh.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -352,7 +352,10 @@ In this example, we're creating a certificate with a TTL of one hour for the
<ScopedBlock scope={["oss", "enterprise"]}>

```code
# To be executed on a Teleport Auth Server
# Log in to your cluster with tsh so you can use tctl from your local machine.
# You can also run tctl on your Auth Service host without running "tsh login"
# first.
$ tsh login --proxy=teleport.example.com --user=myuser
$ tctl auth sign --ttl=1h --user=jenkins --out=jenkins.pem
```

Expand Down
5 changes: 3 additions & 2 deletions docs/pages/setup/guides/ssh-key-extensions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,9 @@ In order to export the Teleport CA, execute the following command:
<ScopedBlock scope={["oss", "enterprise"]}>

```code
# Log in to your Teleport cluster so you can use tctl remotely.
# You can also run tctl on your Auth Service host.
# Log in to your cluster with tsh so you can use tctl from your local machine.
# You can also run tctl on your Auth Service host without running "tsh login"
# first.
$ tsh login --proxy=teleport.example.com --user=myuser
$ tctl auth export --type=user | sed 's/^cert-authority //g'
```
Expand Down
12 changes: 7 additions & 5 deletions docs/pages/setup/operations/backup-restore.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -114,9 +114,10 @@ When migrating backends, you should back up your Auth Service's
### Example of backing up and restoring a cluster

```code
# Log in to your cluster with tsh so you can use tctl.
# You can also run tctl on your Auth Service host.
$ tsh login --user=myuser --proxy=teleport.example.com
# Log in to your cluster with tsh so you can use tctl from your local machine.
# You can also run tctl on your Auth Service host without running "tsh login"
# first.
$ tsh login --proxy=teleport.example.com --user=myuser
# Export dynamic configuration state from old cluster
$ tctl get all --with-secrets > state.yaml
Expand Down Expand Up @@ -177,8 +178,9 @@ When migrating backends, you should back up your Auth Service's
### Example of backing up and restoring a cluster

```code
# Log in to your cluster with tsh so you can use tctl.
# You can also run tctl on your Auth Service host.
# Log in to your cluster with tsh so you can use tctl from your local machine.
# You can also run tctl on your Auth Service host without running "tsh login"
# first.
$ tsh login --user=myuser --proxy=teleport.example.com
# Export dynamic configuration state from old cluster
$ tctl get all --with-secrets > state.yaml
Expand Down

0 comments on commit 193c9f0

Please sign in to comment.