Plan a Terraform configuration
step
This step will plan the given Terraform module.
Specification
osOptional
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
workspaceOptional
string
The name of the Terraform workspace to run (defaults to 'default')
googleOptional
object
A mapping of Google account configuration.
google.connectionRequired
A Relay GCP connection to useConnection docs
!Connection {type: gcp, name: my-gcp-connection}
awsOptional
object
A mapping of AWS account configuration.
aws.connectionRequired
A Relay AWS connection to useConnection docs
!Connection {type: aws, name: my-aws-connection}
aws.regionRequired
string
The AWS region to use (for example, us-west-2)
directoryOptional
string
Subdirectory of the git repository containing the Terraform config root
varFiles[]Optional
array
A list of variable files to include relative to the module directory
varsOptional
object
A map of variables to set, overriding any defaults or variables from files
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.connectionOptional
A Relay SSH connection to useConnection docs
!Connection {type: ssh, name: my-ssh-connection}
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
Example step configuration
1name: terraform-step-plan2image: relaysh/terraform-step-plan3spec:4 directory: !Parameter directory5 git:6 connection: !Connection { type: ssh, name: my-ssh-connection }7 name: !Parameter name8 branch: !Parameter gitBranch9 repository: !Parameter gitRepository10 google:11 connection: !Connection { type: gcp, name: my-gcp-connection }12 workspace: !Secret workspace13
