Search Knowledge Base by Keyword

Environment Aliases

What are Environment Aliases?

An environment alias is an alternative name given to your environment. Specifying aliases for your environments or separate nodes can greatly ease their management.

It can clarify which item you are working with. Doing so, this will avoid making a mistake while choosing an environment or a node that needs to be adjusted.

You will find this very useful while working with several nodes of the same type when scaling horizontally your environment for example.

We will take here below the example of setting up aliases for the master and slave nodes in a DB cluster.

How to set up environments and nodes aliases?

1. Select your environment of same-type nodes and expand the instances list by clicking on the arrow icon or simply on the section.

expand-instances-to-set-up-environment-or-nodes-aliases-

2. Clicking on the Set Alias pencil icon, you can label the whole environment.

PLEASE NOTE: the domain name will remain the same.

click-on-pencil-icon-to-set-up-environment-or-nodes-aliases-

Whatever the alternative name you add, the value will be automatically saved accordingly.

name-instances-to-set-up-environment-or-nodes-aliases

3. In the same way, you can choose the node you would like to add the label for and click on the Set Alias icon or simply double-click on the Node ID: xxx to set an alias.

rename-a-node-to-set-up-environment-or-nodes-aliases-

Once done, press Enter to confirm the value for your alias.

press-enter-to-set-up-environment-or-nodes-aliases

Where do the Aliases appear?

The alternative names chosen for your environments and the nodes appear:

  • In your dashboard
dashboard-environment-or-nodes-aliases
  • In your Databases configuration panel.
databases-configuration-environment-or-nodes-aliases
  • In the embedded Web SSH client:
embedded-ssh-client-environment-or-nodes-aliases-

PLEASE NOTE: these aliases stay visible for other collaborators and will remain attached after an environment is clonedtransferred, etc.

If you delete the alias name, this will return the default value automatically.

Next Steps:

Was this article helpful?
0 out Of 5 Stars
5 Stars 0%
4 Stars 0%
3 Stars 0%
2 Stars 0%
1 Stars 0%
How can we improve this article?
Please submit the reason for your vote so that we can improve the article.