atmos terraform

Purpose

Use these subcommands to interact with terraform.

Usage

Executes terraform commands.

atmos terraform <command> <component> -s <stack> [options]
atmos terraform <command> <component> --stack <stack> [options]

info

atmos supports all terraform commands and options described in Terraform CLI reference.

In addition, the component argument and stack flag are required to generate variables and backend config for the component in the stack.

Additions and differences from native terraform:

• before executing other terraform commands, atmos runs terraform init

• you can skip over atmos calling terraform init if you know your project is already in a good working state by using the --skip-init flag like so atmos terraform <command> <component> -s <stack> --skip-init

• atmos terraform deploy command executes terraform plan and then terraform apply

• atmos terraform deploy command supports --deploy-run-init=true|false flag to enable/disable running terraform init before executing the command

• atmos terraform deploy command sets -auto-approve flag before running terraform apply

• atmos terraform apply and atmos terraform deploy commands support --from-plan flag. If the flag is specified, the commands will use the previously generated planfile instead of generating a new varfile

• atmos terraform clean command deletes the .terraform folder, .terraform.lock.hcl lock file, and the previously generated planfile and varfile for the specified component and stack

• atmos terraform workspace command first runs terraform init -reconfigure, then terraform workspace select, and if the workspace was not created before, it then runs terraform workspace new

• atmos terraform import command searches for region in the variables for the specified component and stack, and if it finds it, sets AWS_REGION=<region> ENV var before executing the command

• atmos terraform generate backend command generates a backend config file for an atmos component in a stack

• atmos terraform generate backends command generates backend config files for all atmos components in all stacks

• atmos terraform generate varfile command generates a varfile for an atmos component in a stack

• atmos terraform generate varfiles command generates varfiles for all atmos components in all stacks

• atmos terraform shell command configures an environment for an atmos component in a stack and starts a new shell allowing executing all native terraform commands inside the shell

tip

Run atmos terraform --help to see all the available options

Examples

atmos terraform plan test/test-component-override-3 -s tenant1-ue2-dev
atmos terraform apply test/test-component-override-3 -s tenant1-ue2-dev
atmos terraform destroy test/test-component-override-3 -s tenant1-ue2-dev
atmos terraform init test/test-component-override-3 -s tenant1-ue2-dev
atmos terraform workspace test/test-component-override-3 -s tenant1-ue2-dev
atmos terraform clean test/test-component-override-3 -s tenant1-ue2-dev

Arguments

Argument	Description	Required
component	atmos terraform component	yes

Flags

Flag	Description	Alias	Required
--stack	atmos stack	-s	yes
--dry-run	Dry-run		no

note

All native terraform flags are supported

Subcommands

📄️ clean

Use this command to delete the .terraform folder, the folder that TFDATADIR ENV var points to, .terraform.lock.hcl file, varfile and planfile for a

📄️ generate backend

Use this command to generate a backend config file for an `atmos` terraform component in a stack.

📄️ generate backends

Use this command to generate the Terraform "backend config" files for all `atmos` Terraform Components in all Stacks.

📄️ generate varfile

Use this command to generate a varfile (.tfvar ) for a Terraform Component in a Stack.

📄️ generate varfiles

Use this command to generate the Terraform varfiles (`.tfvar`) for all `atmos` Terraform Components in all Stacks.

📄️ shell

This command starts a new `SHELL` configured with the environment for an `atmos` Component in a Stack so allow executing all native terraform commands inside of the shell without using any atmos-specific arguments and flags.

📄️ workspace

This command calculates the `terraform` workspace for an `atmos` component (from the context variables and stack config), then runs `terraform init -reconfigure`, then selects the workspace by executing the `terraform workspace select` command.