...

This Universal Extension allows to create tasks that execute terraform commands. Typically, it can be used for Use Cases where UAC acts as an orchestrator for resource provisioning and Terraform needs to be used to provision those resources.Stonebranch users to orchestrate infrastructure provisioning processes using Terraform.

Version Information

Software Requirements

This integration requires Terraform, Universal Agent and Python runtime to execute the Universal Task.

...

Terraform is required to be installed on the host where agent the Universal Agent is installed. Related Terraform binaries and libraries needs need to be accessible by the agent.

...

Linux agents are supported:.

• Universal Agent for Linux Version 7.0.0.0 and later with python options installed.

...

Extension's Universal Agent host should be able to reach endpoints of services related to resource provisioning used by Terraform.

Key Features

This Universal Extension supports the following main features:.

• Init Terraform (Supports upgrade option)
• Plan Terraform (Supports Refresh-only planning mode)
• Apply Terraform
• Destroy Terraform

...

To use the Universal Template, you first must perform the following steps:.

1. This Universal Task requires the Resolvable Credentials feature. Check that the Resolvable Credentials Permitted system property has been set to true. For more information about Resolvable Credentials click here.

2. To import the Universal Template into your Controller, follow the instructions here.

3. When the files have been imported successfully, refresh the Universal Templates list; the Universal Template will appear on the list.

...

For the new Universal Task type, create a new task and enter the task-specific details that were created in the Universal Template.

Input Fields

Task Examples

Terraform Init

Init action with default fieldsImage Removedsetting the runtime directory where the Terraform will be initialized.

Image Added

Terraform Plan

Plan action with provided Plan Output File, Variables Script, Printing logs in json format and PATH variable to terraform binary.

Image Removed

Variable Script:

Image Removed

JSON format on STDERR using a specific runtime directory.

Image Added

Terraform Apply

Apply action with provided Plan File, Variables Script, Printing logs in json format and PATH variable to terraform binary.Image Removedusing a specific runtime directory.

Image Added

Anchor
variable-script variable-script

Variable Script

Passing credentials from the template to the terraform variable file.
One credential field can be passed, the configuration of which can be used to allow users to pass credentials into variable scripts. User has the freedom to decide which credential parameters (like "Runtime User", Runtime Password", "Key Location") can be used from the credential field to propagated to the variables script.

Image Added

Terraform Destroy

Destroy action with Printing logs in json format and PATH variable to terraform binaryImage RemovedJSON format using a specific runtime directory.

Image Added

Task Output

Exit Codes

...

Extension Output

Upon Task's successful completion, the extension produces an Extension Output similar to the one in the example below:In the context of a workflow, subsequent tasks can rely on the information provided by this integration as Extension Output.

Attribute changed is populated as follows.

Attribute result.commands provides information for the Terraform executed command. It contains the following sub-attributes.

An example of the Extension Output for a execution of Init action is presented below.

{
  "exit_code": 0,
  "status_description": "SUCCESS: Terraform command executed successfully!",
  "changed": true,
  "invocation": {
    "extension": "ue-terraform",
    "version": "1.0.

...

1",
    "fields": {
      "action": "Init",
      "upgrade_plugins": false,
      "variables_script": "",
      "plan_file": "",
      "plan_output_file": "",
      "planning_mode": [],
      "print_log_on_stderr": true,
      "json_output": false
    }
  },
  "result": {
    "commands": [
      {
        "cmd": "terraform init -no-color -input=false",
        "rc": 0
      }
    ]
  }
}

...

Attribute result.commands provides information for the Terraform executed command.

It contains the following sub-attributes.

...

The Extension Output for Terraform is described below.

Attribute changed is populated as follows:

...

If subsequent tasks in a workflow reply on the output of this Universal Extension, they should rely on Extension Output.

STDOUT and STDERR

STDOUT and STDERR provide additional information to Useruser. The populated content can be changed in future versions of this extension without notice. Backward compatibility is not guaranteed.

Document References

Changelog

ue-terraform-1.0.1 (2022-07-19)

Enhancements

• Fixed: Credentials can now be passed from Credential field to the variable script.