Parameters allow the user to store sensitive information in the vault in order to reference it later in the pipeline step. This documentation provides helpful information on how to create a parameter and how to configure it into a pipeline step.

Create a New Parameter

1. Navigate to Tool Registry → Parameters

Open

2. Select + New Parameter

Open

3. In Create New Parameter form, set the following fields:

• Name - set a unique name for the parameter. Name must begin with "opsera-" and can contain lowercase letters, numbers, dashes, and periods.

• Secured in Vault - Toggle is enabled by default. If you wish to disable, the parameter will not be secured in the vault. Once this value is set and the form is saved, this cannot be changed.

• Value - Value by default will be hidden. To view, click on the eye icon.

• Roles - Set any access roles by Assignee and Access Type. Select + Add Role to save.

4. Select Create to save the parameter.

Parameter Pipeline Configuration

Parameter Selection

A prerequisite to setting up parameters within a pipeline step is having a configured Jenkins tool. The tool needs a build Job and an Account with linked tool. In the following example, there is an account linked to a configured Gitlab Support tool being used.

Accounts:

To set up the step in the pipeline:

1. Navigate to a Terraform pipeline

2. To create a Command Line Step where the Parameter Selection will be utilized, select Edit Workflow, then select the + icon to add a new step.

3. In Step Setup, Choose Command Line from the Tool drop down.

4. Save settings, close and select the gear icon to open up step configurations.

5. Select the Jenkins Tool to be used from the drop down.

6. Select the following fields:

   
   Parameter Selection:
   This functionality helps users use Opsera Parameters that are already defined under the Parameters tab in Tool Registry. In order to use any of these parameters in the step - enter them in the commands with the following syntax: ${parameter_name}, where the parameter_name is the one of the names derived from this list of available parameters.

   If the Use Terraform Output checkbox has been selected, the available parameters will appear in the Parameter selection option with Terraform Output as the Parameter Origin. They use the same syntax mentioned above in order to be used in the commands.

   You must select all parameters that you pass in the commands in the parameter selection view as well in order for the details to be fetched during runtime.

Response Parameter Mapping

The prerequisite to this setup is that there must be an SCM Tool and AWS Tool configured and ready to use.

To set up the step in the pipeline:

1. Navigate to the Terraform pipeline.

2. To create a Terraform Step where the Response Parameter Mapping will be utilized, select Edit Workflow, then select the + icon to add a new step.

3. In Step Setup, Choose Terraform from the Tool drop down.

4. Select fields from the drop downs.

• For Job Type, select Execute Script.