Terraform Plan Output to Readable File: A Guide

• Introduction
• Step-by-Step Guide
• Code Example
• Additional Notes
• Summary
• Conclusion
• References

When working with Terraform, understanding the execution plan before applying changes to your infrastructure is crucial. While terraform plan provides this information, the output is not easily digestible. To view the plan in a human-readable format, follow these steps:

To get a human-readable Terraform plan, you should use the terraform show command with a plan file.

1. Generate a plan file: Run terraform plan -out=tfplan.out to save the execution plan to a file named "tfplan.out". This file is in a binary format, not directly human-readable.

2. Convert the plan to a readable format: Use the command terraform show tfplan.out to display the plan in a user-friendly format within your terminal.

3. (Optional) Save the readable output to a file: Redirect the output of the previous command to a file using terraform show tfplan.out > readable_plan.txt. This will create a file named "readable_plan.txt" containing the human-readable plan.

While you can redirect the output of terraform plan directly to a file, this approach is not recommended for storing and reusing the plan. The -out flag with terraform plan is specifically designed for saving an executable plan that can be later applied using terraform apply.

This code snippet explains how to create a human-readable Terraform plan. It starts by creating a simple Terraform configuration file. Then, it uses the 'terraform plan' command to generate a plan file. The 'terraform show' command is used to display the plan in a user-friendly format, which can optionally be saved to a text file. The code emphasizes that while you can redirect the output of 'terraform plan' directly, it's recommended to use the '-out' flag for saving an executable plan.

This example demonstrates how to generate a human-readable Terraform plan.

1. Create a Terraform Configuration File (e.g., main.tf):

resource "google_storage_bucket" "example" {
  name          = "my-tf-test-bucket"
  location      = "US"
  force_destroy = false
}

2. Generate a Plan File:

terraform plan -out=tfplan.out

This command generates an execution plan and saves it to the "tfplan.out" file.

3. Convert the Plan to a Readable Format:

terraform show tfplan.out

This command displays the plan in a user-friendly format within your terminal.

4. (Optional) Save the Readable Output to a File:

terraform show tfplan.out > readable_plan.txt

This command redirects the output of the previous command to a file named "readable_plan.txt".

Important Note:

While you can redirect the output of terraform plan directly to a file, this is not recommended for storing and reusing the plan. The -out flag with terraform plan is specifically designed for saving an executable plan that can be later applied using terraform apply.

• Importance of Review: Always review the human-readable plan (terraform show) before applying changes. This helps prevent unintended consequences and ensures your infrastructure changes are as expected.
• Version Control: It's good practice to commit your .tfplan files to version control. This provides an audit trail of planned changes and allows for easy rollback if needed.
• Plan vs. Apply: Remember that terraform plan only shows the planned execution, while terraform apply actually makes the changes to your infrastructure.
• Alternative Output Formats: While terraform show provides a user-friendly format, you can explore tools like terraform-plan-parser or jq for further customization and integration with other tools.
• Security Considerations: Be mindful of sensitive information that might be present in your plan output, especially when sharing or storing it. Consider using tools to redact or mask sensitive data.
• Large Plans: For very large plans, the output of terraform show can be overwhelming. Consider using tools like grep or less to filter and navigate the output effectively.
• Automation: Integrate the generation and review of human-readable plans into your CI/CD pipelines to ensure consistent and auditable infrastructure changes.
• Collaboration: Share the human-readable plan with your team for review and collaboration, especially in larger projects. This promotes transparency and helps catch potential issues early on.

Note: While you can redirect terraform plan output directly, it's not recommended for storing reusable plans. Use the -out flag for creating executable plans for later use with terraform apply.

In conclusion, generating a human-readable Terraform plan is essential for understanding and verifying infrastructure changes before applying them. Using the terraform show command with a plan file allows for easy review and collaboration, reducing the risk of unintended consequences. Remember to integrate this practice into your workflow for safer and more transparent infrastructure management.

• Terraform plan Write Out is Not Readable Text - Terraform ... | Was reading the doc and tried several times to write out a plan to a file that is readable text. Looks like it’s writing out binary. I have been redirecting the output via the “>” operation. When redirecting output, the plan is readable. When using terraform plan -out=new.plan, this shows portion of plan file: I can use redirect but would like to get the option working.
• devops - Terraform plan human readable output in automation ... | Nov 7, 2019 ... I used several ways like using terraform show for the plan file, then grabbing that to a custom file and posting that as a comment in GitHub PR.
• Best way to store a terraform plan in S3 : r/Terraform | Posted by u/Ok_Entertainment3613 - 6 votes and 17 comments
• Terraform plan output to JSON. The Terraform CLI currently doesn't ... | The Terraform CLI currently doesn’t output the plan to a human readable file when running the plan command. It currently prints to the…
• Terraform Unable to Read State Files · Issue #12857 · hashicorp ... | It appears that Terraform is unable to read a (newly created or existing) state file, hence causing major problems when updating a resource. Typically, we use a Makefile to deploy but the same resu...
• Command: apply | Terraform | HashiCorp Developer | When you pass a saved plan file to terraform apply , Terraform takes the ... for all files it would normally read or write in the current working directory.
• Terraform Plan/Apply unable to read state file from another ... | Hi, We have created central storage account in separated subscription to store state files in secure location. In single stage we have terraform init which is using service connection A to subscrip...
• Internals: JSON Output Format | Terraform | HashiCorp Developer | ... Terraform can output a machine-readable JSON representation of a plan file's changes. ... // to try to apply this plan, possibly after asking a human operator for ...
• Running CI/CD Pipeline Across Multiple Directories in one project ... | Hello, So I’ve recently created a little test environment, just to mess around with creating a pipeline. I have my .gitlab-ci.yml file in the root of my directory, and if I add a new file, s3.tf for example, with the necessary code to create an S3 Bucket in AWS, I can run my pipeline and it will deploy the infrastructure with no problem at all. However, I’d like to expand this project at some point, so I would prefer to put all of my ‘infrastructure’ files into a directory called ‘infra’. The...