Skip to content

Commit 06141b4

Browse files
authored
docs: Clarify aliases and scopes (#4966)
* docs: Clarify aliases and scopes * docs: trigger a new build
1 parent f9c5d66 commit 06141b4

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

website/content/docs/concepts/aliases.mdx

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ For example, if you have an alias `boundary.dev`, you can use it to connect to a
1616
When you create a resource in Boundary, it assigns the resource a randomly generated identifier.
1717
You must use those IDs to perform actions in Boundary.
1818

19-
When you connect to a target using the terminal, you must reference the target ID or target name and scope name. As an example, to SSH to a target, you can execute the command `boundary connect ssh -target-id ttcp_123456789`.
19+
When you connect to a target using the terminal, you must reference the target ID or target name and scope name.
20+
As an example, to SSH to a target, you can execute the command `boundary connect ssh -target-id ttcp_123456789`.
2021
Since it can be difficult to remember the unique IDs, users frequently have to look up the identifiers for any resources they want to operate on.
2122

2223
Aliases simplify this process.
@@ -41,8 +42,10 @@ Examples of valid aliases include `webserver` and `webserver.boundary`.
4142

4243
## Scopes
4344

44-
At this time, you can only create aliases in the `global` scope.
45-
The destination target for an alias can be in any scope, however.
45+
You can only create aliases in the `global` scope.
46+
However, you can associate aliases with targets or hosts from any scope.
47+
Support for additional resource types may be added in the future.
48+
4649
If you delete a project, Boundary clears the `destination_id` parameter for any aliases that resolve to targets in that project, so that they no longer function.
4750

4851
## Connect to a target using an alias

0 commit comments

Comments
 (0)