a92c0c7ed2
* adds target aliases and transparent sessions usage docs * fixes relative link * Apply suggestions from code review Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com> * Update website/content/docs/configuration/target-aliases/create-target-alias.mdx Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com> * fixes paragraph formatting * add authenticaton requirement * adds example link * Apply suggestions from code review Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com> * clarifies host selection for session * use DNS-like aliases in example * fixes indentation * Update website/content/docs/concepts/aliases.mdx Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com> * adds callout box for 0.16 clusters --------- Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com> Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>
35 lines
1.3 KiB
Plaintext
35 lines
1.3 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: Overview
|
|
description: >-
|
|
Learn how to configure aliases and transparent sessions to enhance end-user workflows and simplify target access.
|
|
---
|
|
|
|
# Overview
|
|
|
|
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 you to reference the target ID, or a combination of target name and scope:
|
|
|
|
```shell-session
|
|
$ boundary connect ssh -target-id ttcp_1234567890
|
|
```
|
|
|
|
```shell-session
|
|
$ boundary connect ssh -target-name sql-database -target-scope-name -staging
|
|
```
|
|
|
|
With target aliases, a single globally referenced value is assigned to a target, simplifying connection workflows and enabling transparent sessions for Enterprise and HCP end users.
|
|
|
|
```shell-session
|
|
$ boundary connect ssh sql-database-staging
|
|
```
|
|
|
|
## Configure target aliases
|
|
|
|
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 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> |