» How Terraform Runs Execute
Deprecation warning: Terraform Enterprise (Legacy) features of Atlas will no longer be actively developed or maintained and will be fully decommissioned on Thursday, May 31, 2018. Please see our Upgrading From Terraform Enterprise (Legacy) guide to migrate to the new Terraform Enterprise.
This briefly covers the internal process of running Terraform plan and applies. It is not necessary to know this information, but may be valuable to help understand implications of running or debugging failed runs.
» Steps of Execution
- A set of Terraform configuration and directory of files is uploaded via Terraform Push or GitHub
- Terraform Enterprise creates a version of the Terraform configuration and waits for the upload to complete. At this point, the version will be visible in the UI even if the upload has not completed
- Once the upload finishes, Terraform Enterprise creates a run and queues a
- In the run environment, the package including the files and Terraform configuration are downloaded
terraform planis run against the configuration in the run environment
- Logs are streamed into the UI and stored
.tfplanfile created in the plan is uploaded and stored
- Once the plan completes, the environment is torn down and status is updated in the UI
- The plan then requires confirmation by an operator. It can optionally be discarded and ignored at this stage
- Once confirmed, the run then executes a
terraform applyin a new environment against the saved
- The logs are streamed into the UI and stored
- Once the apply completes, the environment is torn down, status is updated in the UI and changed state is saved back
Note: In the case of a failed apply, it's safe to re-run. This is possible because Terraform saves partial state and can "pick up where it left off".
» Customizing Terraform Execution
As described in the steps above, Terraform will be run against your configuration
when changes are pushed via GitHub,
terraform push, or manually queued in the
UI. There are a few options available to customize the execution of Terraform.
- The directory that contains your environment's Terraform configuration can be customized
to support directory structures with more than one set of Terraform configuration files.
To customize the directory for your Environment, set the Terraform Directory
property in the GitHub Integration settings for your environment. This is equivalent to
[dir]argument when running Terraform in your local shell.
- The directory in which Terraform is executed from can be customized to support directory
structures with nested sub-directories or configurations that use Terraform modules with
relative paths. To customize the directory used for Terraform execution in your Environment, set the
TF_ATLAS_DIRenvironment variable to the relative path of the directory - ie.
terraform/production. This is equivalent to changing directories to the appropriate path in your local shell and then executing Terraform.