Usage

Creating Multiple Environments

The Create Multiple Environments step provides the ability to create multiple environments using one JSON file or JSON text body. The format of this JSON body allows you to either create environments from a template or without a template. When creating from a template, the format of this JSON body follows the HCL Launch createEnvironmentFromTemplate REST endpoint. For more information, see Create a new environment from template topic.

When not using a template to create an environment, the format of the JSON body follows the HCL Launch createEnvironment REST endpoint. For more information, see Create a new Environment topic.

Note that if either the templateName or templateId fields are supplied in the JSON text for an environment, the createEnvironmentFromTemplate is used automatically.

To create multiple environments, create multiple JSON environment objects inside of a JSON array as follows:

[{"application": "Application assigned to the environment.",
"name": "Environment name or ID.",
"description": "Description of the environment",
"requireApprovals": "True/false to specify whether environment requires approvals.",
"noSelfApprovals": "True/false to specify whether environment allows self approvals.",
"nodeProperties": {"Node property name": "Property value"},
"properties": {"Environment property name": "Property value"},
"templateName": "(Optional) Supply either the templateId or templateName to use a template.",
"templateId": "(Optional) Supply either the templateId or templateName to use a template."},
{"application": "Application assigned to the environment.",
"name": "Environment name or ID.",
"description": "Description of the environment",
"requireApprovals": "True/false to specify whether environment requires approvals.",
"noSelfApprovals": "True/false to specify whether environment allows self approvals.",
"nodeProperties": {"Node property name": "Property value"},
"properties": {"Environment property name": "Property value"},
"templateName": "(Optional) Supply either the templateId or templateName to use a template.",
"templateId": "(Optional) Supply either the templateId or templateName to use a template."}]

Steps

The following process steps are available in the HCL Launch Environments plugin.

• Add Base Resource To Environment
• Add Environment To Team
• Check If Environment Exists
• Create Environment
• Create Environment Property
• Create Environment from Template
• Create Multiple Environments
• Delete Environment
• Get Component Environment Properties
• Get Environment Details
• Get Environment Properties
• Get Latest Version By Environment and Component
• Set Component Environment Property
• Verify Inventory Status

Add Base Resource To Environment

Adds a base resource to an environment as a deployment target.

Add Environment To Team

Adds an environment or list of environments delimited by commas to a team for a given application and type classification.

Check If Environment Exists

This step will succeed if the environment exists and fail if it does not.

Create Environment

Creates an environment for the specified application.

Create Environment Property

Create a property for an application environment.

Create Environment from Template

Creates an environment from a template for the specified application.

Create Multiple Environments

Creates multiple environments using JSON format. Outputs a comma delimited list of the environment UUIDs that were created (environment.ids).

Delete Environment

Deletes an environment.

Get Component Environment Properties

Get the name-value pairs of all component environment properties and sets them as output properties for this step. Secure property values cannot be resolved.

Get Environment Details

Retrieve basic configuration information about a environment.

Get Environment Properties

Get the name-value pairs of all environment properties and sets them as output properties for this step. Secure property values cannot be resolved.

Get Latest Version By Environment and Component

Gets the latest Version of a Component in a given Environment

Set Component Environment Property

Sets an environment-specific property value for a component. The property must already exist.

Verify Inventory Status

Verifies that the environment has a component with a certain version in inventory.