Skip to content

Commit

Permalink
[v15] docs: update db gui client (#49155)
Browse files Browse the repository at this point in the history
* docs: update db gui client

* docs: remove Teleport version ref in db gui client

Co-authored-by: Paul Gottschling <[email protected]>

* docs: include peer as join session mode in access role ref

---------

Co-authored-by: Paul Gottschling <[email protected]>
  • Loading branch information
stevenGravy and ptgott authored Nov 19, 2024
1 parent 5bad931 commit a05ad68
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 4 deletions.
15 changes: 13 additions & 2 deletions docs/pages/connect-your-client/gui-clients.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,20 @@ work with Teleport.

### Prerequisites

(!docs/pages/includes/edition-prereqs-tabs.mdx!)
- A running Teleport cluster. If you want to get started with Teleport, [sign
up](https://goteleport.com/signup) for a free trial or [set up a demo
environment](../admin-guides/deploy-a-cluster/linux-demo.mdx).

- The `tsh` client tool. Visit [Installation](../installation.mdx) for instructions on downloading
`tsh`. See the [Using Teleport Connect](./teleport-connect.mdx) guide for a graphical desktop client
that includes `tsh`.

- To check that you can connect to your Teleport cluster, sign in with `tsh login`. For example:

```code
$ tsh login --proxy=<Var name="teleport.example.com" /> --user=<Var name="[email protected]" />
```

- (!docs/pages/includes/tctl.mdx!)
- The Teleport Database Service configured to access a database. See one of our
[guides](../enroll-resources/database-access/guides/guides.mdx) for how to set up the Teleport
Database Service for your database.
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/includes/role-spec.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -373,7 +373,7 @@ spec:
# generates a role name from the value capture
roles: ['$1-admin']

# Teleport can attach annotations to pending Access Requests. these
# Teleport can attach annotations to pending Access Requests. These
# annotations may be literals, or be variable interpolation expressions,
# effectively creating a means for propagating selected claims from an
# external identity provider to the plugin system.
Expand Down Expand Up @@ -411,7 +411,7 @@ spec:
# The different session kinds this policy applies to.
kinds: ['k8s', 'ssh']
# The list of session participant modes the role may join the session as.
modes: ['moderator', 'observer']
modes: ['moderator', 'observer', 'peer']

# spiffe is a list of SPIFFE IDs that the role holder is allowed to request
# SVIDs for. As long as the request matches one of the blocks within the
Expand Down

0 comments on commit a05ad68

Please sign in to comment.