Create an alias suffix for a scope

When you create an alias in a project scope, you must create suffixes for both the containing org scope and the project scope in which the alias resides. You can have only one suffix per project or org scope. Org suffixes must be globally unique. Project suffixes must be unique within the org the project resides in, but they can be reused across orgs.

Once you create the suffixes, you append them to any aliases you create in the project scope. You can reuse alias values across scopes because the suffixes make them globally unique values.

For example, your organization might use an alias value postgres-db and differentiate between different departments using suffixes. An engineering org might use the suffix eng and suffixes frontend and backend for projects within the org scope to create the following alias combinations:

postgres-db - Alias in the global scope
postgres-db.backend.eng - Alias in the project scope with org and project suffixes
postgres-db.frontend.eng - Alias in the project scope with org and project suffixes

Permissions

You must have write permissions for a scope to create, edit, or delete a suffix in that scope. Any user who has the * all action grant for a scope can set or remove aliases.

If you want to configure a new role to manage suffixes, use the following commands to create a new role with the required grants.

For a specified org:

$ boundary roles create -scope-id global -name "org-alias-suffix-manager" \

boundary roles add-grants -id $ROLE_ID \
  -grant "ids=$ORG_ID; type=scope;actions=set-alias-suffix,remove-alias-suffix"

boundary roles add-principals -id "ROLE_ID" \
  -principal "$USER_ID"

For a specified project:

$ boundary roles create -scope-id $ORG_ID -name "project-alias-suffix-manager" \

boundary roles add-grants -id $ROLE_ID \
  -grant "ids=$PROJECT_ID; type=scope;actions=set-alias-suffix,remove-alias-suffix"

boundary roles add-principals -id "$ROLE_ID" \
  -principal "$USER_ID"

Create the suffixes

Complete the following steps to create suffixes for the org and project scopes:

Select whether you want to create a suffix for an org or a project scope:

Log in to Boundary.
Select Orgs in the navigation pane, and then select the org scope.
Select Org Settings in the navigation pane, and then click Create alias suffix.
In the Alias suffix field, type a unique value for the suffix.
Click Save.
Boundary will append the org suffix to any aliases you create in the nested project scope using the following format:
alias.projectsuffix.orgsuffix

Log in to Boundary.
Select Orgs in the navigation pane, and then select the org scope that contains the project.
Select the project scope.
Select Project Settings in the navigation pane, and then click Create alias suffix.
In the Alias suffix field, type a unique value for the suffix.
Click Save.
Boundary will append the project suffix to any aliases you create in the project scope using the following format:
alias.projectsuffix.orgsuffix

Select whether you want to create a suffix for an org or a project scope:

Log in to Boundary.
Use the following command to create an alias suffix in the org scope that contains the project scope. Make sure to provide the ID for the org scope:
```
$ boundary scopes set-alias-suffix \
    -id o_1234567890 \
    -alias-suffix org1
```
You must provide the the following attributes when you create a suffix:
- -id=<string> - The ID of the org or project scope for which you want to create the suffix. You can also specify the scope using the BOUNDARY_SCOPE_ID environment variable.
- -alias-suffix - Specifies the string that you want to use as the suffix to append to aliases in the designated scope or scopes. The alias-suffix can be a hostname or a DNS-like string.
When you create an alias in the project scope, you must append the suffix using the following format:
alias.projectsuffix.orgsuffix

Log in to Boundary.
Use the following command to create an alias suffix in the project scope you want to create an alias for. Make sure to provide the ID for the project scope:
```
$ boundary scopes set-alias-suffix \
    -id p_1234567890 \
    -alias-suffix proj1
```
You must provide the the following attributes when you create a suffix:
- -id=<string> - The ID of the org or project scope for which you want to create the suffix. You can also specify the scope using the BOUNDARY_SCOPE_ID environment variable.
- -alias-suffix - Specifies the string that you want to use as the suffix to append to aliases in the designated scope or scopes. The alias-suffix can be a hostname or a DNS-like string.
When you create an alias in the project scope, you must append the suffix using the following format:
alias.projectsuffix.orgsuffix

Next steps

Once you have created suffixes for the org and project scope, you can Create a target alias for targets in the project scope.

More information

For more information about aliases, refer to Overview of aliases.
To change the name of a suffix or to delete it, refer to Manage alias suffixes.