STEP

Plan a Terraform configuration

This step will plan the given Terraform module.

Specification

os
Optional
object
Additional packages and commands to run prior to terraform execution
os.packages
Optional
array
list of apk packages to install at container execution time
os.commands
Optional
array
List of shell commands to run after packages are installed but before Terrafrom executes
workspace
Optional
string
The name of the Terraform workspace to run (defaults to 'default')
credentials
Optional
object
Relay secret containing a base-64 encoded service-account.json file for accessing GCP
credentials.service-account.json
Optional
string
aws
Optional
object
AWS access credentials
aws.accessKeyID

Required

string
Access Key ID for the AWS account
aws.secretAccessKey

Required

string
The secret key for the AWS account
aws.region
Optional
string
The default AWS region to use
directory
Optional
string
Subdirectory of the git repository containing the Terraform config root
vars
Optional
object
A map of variables to set as tfvars
backendConfig
Optional
object
A map of backend configuration variables to be passed to terraform as -backend-config=key=value
git
Optional
object
A git repository containing the terraform code to run
git.ssh_key

Required

string
The SSH key to use when cloning the git repository. You can pass the key into Relay as a secret.
git.known_hosts

Required

string
SSH known hosts file. Pass the contents of the file into Relay as a secr et.
git.name

Required

string
A directory name for the git clone
git.branch
Optional
string
The git branch to clone
git.repository

Required

string
The git repository URL

Outputs

plan

Required

string
Terraform plan data to be used to apply this specific plan
changed
Optional
boolean
Boolean set to true if any resources will be changed by running the plan

Integrations in this step

Install the Relay CLI

Relay CLI is an essential companion for authoring and managing workflows. You can install it with a package manager or download it.
brew install puppetlabs/puppet/relay
Learn more about setting up Relay.

How to contribute

We’re excited to see and share in our community’s creation. Take a look at our community overview to learn how to begin contributing to Relay.