STEP
Plan a Terraform configuration
This step will plan the given Terraform module.
Source code and documentation
https://github.com/relay-integrations/relay-terraform/tree/master/steps/plan/Specification
osOptional
object
Additional packages and commands to run prior to terraform execution
os.packagesOptional
array
list of apk packages to install at container execution time
os.commandsOptional
array
List of shell commands to run after packages are installed but before Terrafrom executes
workspaceOptional
string
The name of the Terraform workspace to run (defaults to 'default')
credentialsOptional
object
Relay secret containing a base-64 encoded service-account.json file for accessing GCP
credentials.service-account.jsonOptional
string
awsOptional
object
AWS access credentials
aws.accessKeyIDRequired
string
Access Key ID for the AWS account
aws.secretAccessKeyRequired
string
The secret key for the AWS account
aws.regionOptional
string
The default AWS region to use
directoryOptional
string
Subdirectory of the git repository containing the Terraform config root
varsOptional
object
A map of variables to set as tfvars
backendConfigOptional
object
A map of backend configuration variables to be passed to terraform as -backend-config=key=value
gitOptional
object
A git repository containing the terraform code to run
git.ssh_keyRequired
string
The SSH key to use when cloning the git repository. You can pass the key into Relay as a secret.
git.known_hostsRequired
string
SSH known hosts file. Pass the contents of the file into Relay as a secr et.
git.nameRequired
string
A directory name for the git clone
git.branchOptional
string
The git branch to clone
git.repositoryRequired
string
The git repository URL
Outputs
planRequired
string
Terraform plan data to be used to apply this specific plan
changedOptional
boolean
Boolean set to true if any resources will be changed by running the plan
