Creating a New Deployment

To create a new deployment, you can either navigate to the Deployment List View or select a Collection, which will become the parent collection of the new deployment.

Opening the “Create Deployment” Dialog

From the Deployment List View

1. Click Deployments in the left side drawer.
2. You will see a list of all existing deployments.
3. In the table’s action bar, click the (Plus) icon to open the Create Deployment dialog.

From a Collection

1. Navigate to the desired collection.
2. In the collection’s action bar, click the ➕ (Plus) icon.
3. The Create Deployment dialog will open with the Parent Collection already prefilled.

Create Deployment Dialog – Step-by-Step Guide

The dialog consists of five steps, each requiring information to successfully create the deployment.

1. Template Section

In this step, you select a deployment template and configure its parameters.

Selecting a Template

• Click the template selection field to open a searchable list of available templates.
• Once selected, the Version field will auto-populate with the latest version, but you may select an older one if needed.

Below the template selector, you’ll see a human-readable summary describing what the template will deploy.

Environment & Resource Provider

• Choose an environment by clicking one of the environment chips.
• Available environments are determined by your template and assigned resource providers.
• After selecting an environment, choose a Resource Provider from the filtered list.

Template Details Tabs

At the bottom, you’ll find three tabs containing template-specific information:

1. Parameters – Templates may require additional parameters. Required fields are marked with *.
2. Template Definition – Shows the template definition in text form. Missing parameters can also be filled in here. Both views stay in sync.
3. Resource Tree View – Displays a hierarchical preview of the resources and resource groups that will be deployed.

2. General Info

In this step, you define the deployment’s core information.

Parent Collection

• If the dialog was opened from the Deployment List View, the parent collection may be chosen here.
• If opened from a collection’s detail view via the operations bar, the parent is already fixed.

Naming the Deployment

• Enter a User Defined Name using only lowercase letters, numbers, and hyphens (-). The user defined name serves as the prefix of the techincal name.
• The Technical Name is generated automatically from the user defined name and the environment selected earlier.
• If the name already exists, you’ll see a warning message.

Display Name & Description

• The Display Name is auto-filled from the user defined name but can be changed freely. It appears in tables and item views.
• Add a Description to help others understand the purpose of the deployment. This appears in the deployment’s info widget.

Both fields can be edited later after the deployment is created.

Expiry Date

• Set an Expiry Date for the deployment. By default, it is set to 3 months.
• When a deployment expires, it will shut down and later be deleted.
• You will receive a notification before expiry, allowing time to extend it.

Advanced Configuration (Variables)

At the end of this step, there is a checkbox enabling an additional Variables step. Variables can also be added or edited after creation.

3. Variables (optional)

This step appears only if Advanced Configuration was enabled in the previous step. It functions identically to the Variables widget. For more information, refer to the Variables section of the documentation.

4. Owners

Every deployment must have at least one owner.

You can add multiple owners.

• Use the input box to search for a user by email and select from the dropdown.
• If the email does not appear, an Invite User button will show. Invited users will receive an invitation email after clicking the Deploy button in the final step.

5. Summary

This final step provides a complete overview of all settings made in previous steps.

• Review everything to ensure it meets your requirements.
• Use the navigation buttons or click directly on the step titles to go back and make changes if needed.

Creating the Deployment

Once everything looks correct in the Summary step, click Deploy.

• If an issue exists, an error message will appear at the bottom of the summary.
• If everything is valid, you’ll see a confirmation check and be redirected to your new deployment.

After the redirection, you’ll notice the deployment is in the Deploying state. You can monitor progress in the Jobs widget. For more details about jobs, see the Jobs section of this documentation.