Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com>
  • Loading branch information
stellarsquall and Dan-Heath authored Nov 18, 2024
1 parent 1ce8ec2 commit d4c02eb
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 15 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ description: >-
Learn how to connect to a target configured with an alias.
---

After you [Create a target alias](/boundary/docs/configuration/target-aliases/create-target-alias), you can refer to the alias when establishing sessions.
After you [Create a target alias](/boundary/docs/configuration/target-aliases/create-target-alias), you can refer to the alias when you establish sessions.

With aliases, you don't have to specify the target ID, target name, or scope when connecting with Boundary. Target aliases are also required to use [transparent sessions](/boundary/docs/configuration/target-aliases/transparent-sessions).
With aliases, you don't have to specify the target ID, target name, or scope when you connect with Boundary. Target aliases are also required to use [transparent sessions](/boundary/docs/configuration/target-aliases/transparent-sessions).

# Connect to a target using an alias

Expand All @@ -27,4 +27,4 @@ $ boundary connect ssh example.alias.boundary

Aliases are globally unique, so you don't need to specify the scope to connect to the target.

After verifying that you can connect to the target using an alias, you can try to connect to the target using [transparent sessions](/boundary/docs/configuration/target-aliases/transparent-sessions). <sup>HCP/ENT</sup>
After you verify that you can connect to the target using an alias, you can try to connect to the target using [transparent sessions](/boundary/docs/configuration/target-aliases/transparent-sessions). <sup>HCP/ENT</sup>
6 changes: 3 additions & 3 deletions website/content/docs/configuration/target-aliases/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ description: >-

# Overview

Target aliases simplify the connection workflow end users by allowing targets to be referenced by a globally unique DNS-like string.
Target aliases simplify the connection workflow for end users by allowing them to reference targets using a globally unique DNS-like string.

Without aliases, connecting to an end target requires referencing the target ID, or a combination of target name and scope:
Without aliases, connecting to an end target requires you to reference the target ID, or a combination of target name and scope:

```shell-session
$ boundary connect ssh -target-id ttcp_1234567890
Expand All @@ -32,4 +32,4 @@ To set up a target alias:
1. [Create a target alias](/boundary/docs/configuration/target-aliases/create-target-alias)
1. [Connect to a target using an alias](/boundary/docs/configuration/target-aliases/connect-target-alias)

After setting up a target alias, you can optionally [Configure transparent sessions for end users](/boundary/docs/configuration/target-aliases/transparent-sessions). <sup>HCP/ENT</sup>
After you set up a target alias, you can optionally [Configure transparent sessions for end users](/boundary/docs/configuration/target-aliases/transparent-sessions). <sup>HCP/ENT</sup>
Original file line number Diff line number Diff line change
Expand Up @@ -63,30 +63,30 @@ When you have validated that transparent sessions work, you can create and estab

To establish transparent sessions to other services:

1. Make a list of the services you use
1. Create workers as needed for network partitions
1. Add the services to Boundary as targets
1. [Create aliases for the targets](/boundary/docs/configuration/target-aliases/create-target-alias)
1. Connect to the target using your client of choice
1. Make a list of the services you use.
1. Create workers as needed for network partitions.
1. Add the services to Boundary as targets.
1. [Create aliases for the targets](/boundary/docs/configuration/target-aliases/create-target-alias).
1. Connect to the target using your client of choice.

## Connect using transparent sessions

Without transparent sessions, clients must use the [Boundary connect helpers](/boundary/docs/concepts/connection-workflows) to establish a session:
Without transparent sessions, you must use the [Boundary connect helpers](/boundary/docs/concepts/connection-workflows) to establish a session:

```shell-session
$ boundary connect ssh -target-name sql-database -target-scope-name -staging
```

Or use the Boundary Desktop Client app to start a session, and connect on a local port supplied by Boundary:
Alternatively, you can use the Boundary Desktop Client to start a session, and connect on a local port supplied by Boundary:

```shell-session
$ ssh 127.0.0.1 -p 55374
```

With transparent sessions, the target alias is used as the address to esablish a session. If the [client agent is running](#install-the-boundary-clients), you can use the alias to start a session:
With transparent sessions, you use the target alias as the address to establish a session. If the [client agent is running](#install-the-boundary-clients), you can use the alias to start a session:

```shell-session
$ ssh my.alias.name
```

Boundary will then start the session as usual, and broker or inject any credentials you have configured.
Boundary starts the session as usual, and brokers or injects any credentials you have configured.

0 comments on commit d4c02eb

Please sign in to comment.