Search…
⌃K
Links

Environment handles

Create custom, unique resource pools for your environments.
An environment "handle" is a pre-generated, unique identifier that can be used for deterministic resource pools, such as environment URLs. For example, you can use an environment handle to create deterministic URLs for your environments for OAuth applications.
In ReleaseHub, Professional account-holders can create a custom handle name and specify the number of resource handles to use it with. One of these resource handles can be "checked out" by an environment, which will then display the handle in its domain name.
For example, the end result of your environment handle being inserted into an environment's domain URL would look something like this:
https://service-${env_id}-appname.releaseapp.io
This is no different to a regular ephemeral environment space, except that your environment handle ${env_id} is allocated from the handle pool.

Create an environment handle

Select the Env Handles tab in Account Settings. In the Environment Handles page, click the New button.
List of Environment Handles
In the modal window that opens, enter a name for your handle and how many handles you need. Click Create.
Create Handle modal window

View environment handle details

In the Environment Handle Details page, you can see the name of each resource handle and which environment currently has it checked out. Notice how each resource handle name begins with the base handle name, followed by an incrementing index number. This is what will appear in the environment's URL.

Add the environment handle to your Application Template

In order for an environment to check out a unique handle, add the following to your Application Template:
environment_templates:
- name: ephemeral
datasets:
- name: handle_name
URL handle pools are only applied during environment creation and cannot be changed or applied retroactively to an existing environment.

Environment-specific environment variables

Environment handles allow you to set specific environment variables for each individual environment. For example, you may have a set of third-party service tokens that require a unique ID for each environment for testing purposes. This is a common pattern for services like Firebase or Twilio. You can provide each environment with a specific set of environment variables to be applied to that environment.
To add an environment variable to a handle, expand the section below the environment handle and click the plus sign. Insert the key and value in the relevant fields and click the check mark to save your changes.
Adding a specific environment value to the "llama" environment handle.
Remove an environment variable from a handle by clicking the trash sign next to it.