When a terraform operator resource is created, a workflow is kicked off which calls a series of tasks. Tasks are pods that run scripts defined by the user.
The scripts here are, in most cases, enough to satisfy the most common use case of terraform operator workflow.
The images directory contains the container image build tools for the tasks. There are generally three types of tasks:
- Setup
- Terraform
- Script
The provided scripts in images is an aid in creating container images. Each team or user will need to provide their own container registries.
This image a lightweight image suited for performing git clones and wgets of http sources. It generally executes the setup.sh
The default image contains the specific terraform version defined in the terraform operator resource; spec.terraformVersion
If a custom terraform image is built, the tag MUST match the spec.terraformVersion defined.
This is an all-purpose image that can execute scripts defined by the user. The default image contains a large toolset but is likely missing binaries for advanced users.
The task script is usually downloaded by the task container when it starts, and then executes the script immediately using the exec bash builtin command.
When customizing the scripts, terraform operator uses a common set of environment variables that get injected into every pod.
| Environment Variable Name | Description |
|---|---|
TFO_TASK |
The name of the task being executed. Will be one of the following:
When a terraform operator resource is deleted, users that have configured the resources created by terraform to be destroyed will have a set of tasks that match the following with a -delete suffix appended to the end of each task name. For example, when a delete-workflow beings, it will have a task name of setup-delete |
TFO_GENERATION_PATH |
The path inside the task container that points to the root of all the things that are created for the current generation. A "generation" the terraform operator resource configuration after it has been updated. Every update incurs a new generation, therefore a new workflow will begin. Use TFO_GENERATION_PATH to work only in the context of all things related to a particular configuration. |
TFO_MAIN_MODULE |
The path to the root of the terraform module. This is always ${TFO_GENERATION_PATH}/main. |
Setup is responsible for placing the terraform module at the $TFO_MAIN_MODULE location. It is also responsible for downloading resources and placing them according to their configuration.
Default: setup.sh
Depending on the $TFO_TASK, the terraform's main function is to execute terraform init, terraform plan or terraform apply for the module in $TFO_MAIN_MODULE. Sometimes there are a few steps of configuration that must be done before executing the terraform commands.
Default: tf.sh
These are general scripts configured by the user for any purpose. The user should always try and work within the $TFO_GENERATION_PATH to avoid getting mixed up with data from other runs.
No Default
If you'd like to contribute, feel free to open a Pull Request or an Issue.