Skip to content

Commit

Permalink
Ensure tctl commands include login instructions
Browse files Browse the repository at this point in the history
See #10192

Add the tctl.mdx partial or a "tsh login" command in some pages that
include example tctl commands. Note that this change does not address
SSO guides, which will be handled separately.

Where a guide requires a complete restructuring to provide full context,
"docs/pages/application-access/guides/connecting-apps.mdx", I've added
"tsh login" instruction above the first tctl command.
  • Loading branch information
ptgott committed Jul 6, 2022
1 parent 57ccc0e commit d39be6e
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 6 deletions.
3 changes: 3 additions & 0 deletions docs/pages/application-access/guides/connecting-apps.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +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.
$ tsh login --user=myuser --proxy=teleport.example.com
$ tctl tokens add \
--type=app \
--app-name=grafana \
Expand Down
2 changes: 2 additions & 0 deletions docs/pages/enterprise/workflow/ssh-approval-slack.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ Here is an example of sending an access request via Teleport's Slack plugin:

(!/docs/pages/includes/commercial-prereqs-tabs.mdx!)

(!/docs/pages/includes/tctl.mdx!)

## Step 1/7. Install the Teleport Slack plugin

We currently only provide `linux-amd64` binaries. You can also compile these plugins
Expand Down
21 changes: 15 additions & 6 deletions docs/pages/setup/operations/backup-restore.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,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.
$ tsh login --user=myuser --proxy=teleport.example.com
# Export dynamic configuration state from old cluster
$ tctl get all --with-secrets > state.yaml
Expand Down Expand Up @@ -174,6 +177,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.
$ tsh login --user=myuser --proxy=teleport.example.com
# Export dynamic configuration state from old cluster
$ tctl get all --with-secrets > state.yaml
Expand Down Expand Up @@ -216,12 +222,15 @@ also apply to a new cluster being bootstrapped from the state of an old cluster:
</TabItem>
<TabItem scope={["cloud"]} label="Teleport Cloud">

In Teleport Cloud, backend data is managed for you automatically. If you would
like to migrate configuration resources to a self-hosted Teleport cluster,
follow our recommended backup practice of storing configuration resources in a
git repository and running `tctl create -f` regularly for each resource. This
will enable you to keep your configuration resources up to date regardless of
storage backend.
In Teleport Cloud, backend data is managed for you automatically.

If you would like to migrate configuration resources to a self-hosted Teleport
cluster, follow our recommended backup practice of storing configuration
resources in a git repository and running `tctl create -f` regularly for each
resource.

This will enable you to keep your configuration resources up to date regardless
of storage backend.

</TabItem>
</Tabs>
Expand Down

0 comments on commit d39be6e

Please sign in to comment.