Terraform Cheat Sheet
[vc_row][vc_column][vc_column_text]Format and Validate Terraform code
| terraform fmt | format code per HCL canonical standard |
| terraform validate | validate code for syntax |
| terraform validate -backend=false | validate code skip backend validation |
Initialize your Terraform working directory
| Command | What does it do? |
| terraform init | initialize directory, pull down providers |
| terraform init -get-plugins=false | initialize directory, do not download plugins |
| terraform init -verify-plugins=false | initialize directory, do not verify plugins for signature |
Plan, Deploy and Cleanup Infrastructure
| Command | What does it do? |
| terraform apply –auto-approve | apply changes without being prompted to enter “yes” |
| terraform destroy –auto-approve | destroy/cleanup deployment without being prompted for “yes” |
| terraform plan -out plan.out | output the deployment plan to plan.out |
| terraform apply plan.out | use the plan.out plan file to deploy infrastructure |
| terraform plan -destroy | outputs a destroy plan |
| terraform apply -target=aws_instance.my_ec2 | only apply/deploy changes to the targeted resource |
| terraform apply -var my_region_variable=us-east-1 | pass a variable via command-line while applying a configuration |
| terraform apply refresh=false | do not reconcile state file with real-world resources |
| terraform apply –parallelism=5 | number of simultaneous resource operations |
| terraform refresh | reconcile the state in Terraform state file with real-world resources |
| terraform providers | get information about providers used in current configuration |
Terraform Workspaces
| Command | What does it do? |
| terraform workspace new mynewworkspace | create a new workspace |
| terraform workspace select default | change to the selected workspace |
| terraform workspace list | list out all workspaces |
Terraform State Manipulation
| Command | What does it do? |
| terraform state show aws_instance.my_ec2 | show details stored in Terraform state for the resource |
| terraform state pull > terraform.tfstate | download and output terraform state to a file |
| terraform state mv aws_iam_role.my_ssm_role module.custom_module | move a resource tracked via state to different module |
| terraform state replace-provider hashicorp/aws registry.custom.com/aws | replace an existing provider with another |
| terraform state list | list out all the resources tracked via the current state file |
| terraform state rm aws_instance.myinstace | unmanage a resource, delete it from Terraform state file |
Terraform Import And Outputs
| Command | What does it do? |
| terraform import aws_instance.new_ec2_instance i-abcd1234 | import EC2 instance with id i-abcd1234 into the Terraform resource named “new_ec2_instance” of type “aws_instance” |
| terraform import ‘aws_instance.new_ec2_instance[0]’ i-abcd1234 | same as above, imports a real-world resource into an instance of Terraform resource |
| terraform output | list all outputs as stated in code |
| terraform output instance_public_ip | list out a specific declared output |
| terraform output -json | list all outputs in JSON format |
Terraform Miscellaneous commands
| Command | What does it do? |
| terraform version | display Terraform binary version, also warns if version is old |
| terraform get -update=true | download and update modules in the “root” module. |
Terraform Graph(Dependency Graphing)
| Command | What does it do? |
| terraform graph | dot -Tpng > graph.png | produce a PNG diagrams showing relationship and dependencies between Terraform resource in your configuration/code |
Terraform Console(Test out Terraform interpolations)
| Command | What does it do? |
| echo ‘join(“,”,[“foo”,”bar”])’ | terraform console | echo an expression into terraform console and see its expected result as output |
| echo ‘1 + 5’ | terraform console | Terraform console also has an interactive CLI just enter “terraform console” |
| echo “aws_instance.my_ec2.public_ip” | terraform console | display the Public IP against the “my_ec2” Terraform resource as seen in the Terraform state file |
Terraform Taint/Untaint
| Command | What does it do? |
| terraform taint aws_instance.my_ec2 | taints resource to be recreated on next apply |
| terraform untaint aws_instance.my_ec2 | Remove taint from a resource |
| terraform force-unlock LOCK_ID | forcefully unlock a locked state file, LOCK_ID provided when locking the State file beforehand |
Terraform Cloud
| Command | What does it do? |
| terraform login | obtain and save API token for Terraform cloud |
| terraform logout | Log out of Terraform Cloud, defaults to hostname app.terraform.io |
Main commands
- init: Prepare your working directory for other commands
- validate: Check whether the configuration is valid
- plan: Show changes required by the current configuration
- apply: Create or update infrastructure
- destroy: Destroy previously-created infrastructure
[/vc_column_text][/vc_column][/vc_row][vc_row title=”Download as PDF” url=”https://webmagicinformatica.com/wp-content/uploads/2022/03/Git-Cheat-Sheet-WebMagic-Informatica.pdf” new_window=”” custom_style=”custom_style” text_align=”text-center” font_size=”14″ font_weight=”” border_width=”1″ color=”” border_color=”” bg_color=”” hover_color=”” hover_border_color=”#ffb606″ hover_bg_color=”” icon=”” icon_size=”14″ icon_position=”” button_size=”medium” rounding=”tiny-rounded” vc_id=””][vc_column][thim-button title=”Download as PDF” url=”https://webmagicinformatica.com/wp-content/uploads/2022/05/Terraform-Cheat-Sheet-WebMagic-Informatica.pdf” new_window=”” custom_style=”custom_style” text_align=”text-center” border_width=”1″ hover_border_color=”#ffb606″ button_size=”medium” rounding=”tiny-rounded”][/vc_column][/vc_row]
You may also like
GCP Network Cheatsheet
Ansible Cheat Sheet
