Terraform show for state inspection - Mini Project: Build & Apply

Terraform show for state inspection

📖 Scenario: You are managing cloud infrastructure using Terraform. You want to inspect the current state of your deployed resources to understand what Terraform has created and is managing.

🎯 Goal: Learn how to use terraform show to inspect the Terraform state file and understand the current infrastructure state.

📋 What You'll Learn

Create a Terraform state file with a simple resource

Configure Terraform to manage an AWS S3 bucket

Use terraform show to inspect the state

Output the state information in JSON format

💡 Why This Matters

🌍 Real World

Terraform state inspection is essential for understanding what resources are managed and their current configuration, helping avoid drift and troubleshoot issues.

💼 Career

Cloud engineers and DevOps professionals use Terraform state inspection daily to verify infrastructure and ensure deployments are as expected.

1

Create a Terraform configuration with an AWS S3 bucket

Create a file named main.tf with a resource block for an AWS S3 bucket named my-example-bucket in the us-east-1 region. Use the AWS provider with version constraint "~> 4.0".

Terraform

# Write the Terraform provider and resource configuration here
# Your code here

Hint

Start by defining the AWS provider and then add a resource block for the S3 bucket with the exact name my-example-bucket.

2

Initialize Terraform and create the state file

Add a line to initialize Terraform by running terraform init in your terminal. Then add a line to create the infrastructure with terraform apply -auto-approve. (Note: For this exercise, just add these commands as comments in a file named commands.sh.)

Terraform

# Add the Terraform initialization and apply commands as comments
# Your code here

Hint

Write the commands as comments so you remember the steps to initialize and apply Terraform.

3

Use terraform show to inspect the state

Add a comment line with the command terraform show -json terraform.tfstate > state.json to export the current Terraform state to a JSON file named state.json.

Terraform

# Add the terraform show command as a comment
# Your code here

Hint

This command exports the Terraform state in JSON format so you can inspect it easily.

4

Add output to display the S3 bucket name from the state

Add an output block in main.tf named bucket_name that outputs the bucket name from the resource aws_s3_bucket.my_example_bucket.bucket.

Terraform

# Add an output block for bucket_name
# Your code here

Hint

Outputs help you see important values from your Terraform state after applying.

Practice

1. What is the main purpose of the terraform show command?

easy

A. To apply changes to your infrastructure

B. To display the current state of your infrastructure managed by Terraform

C. To initialize a new Terraform working directory

D. To destroy all resources managed by Terraform

Solution

1. Step 1: Understand the role of terraform show

   This command is used to display the saved state of your infrastructure, showing what Terraform currently knows about your resources.

2. Step 2: Differentiate from other commands

   Commands like terraform apply, terraform init, and terraform destroy perform actions, but terraform show only displays information.

3. Final Answer:

   To display the current state of your infrastructure managed by Terraform -> Option B

4. Quick Check:

   terraform show = display state [OK]

Hint: Remember: show means display info, not change it [OK]

Common Mistakes:

• Confusing show with apply or destroy commands
• Thinking show modifies infrastructure
• Assuming show initializes Terraform

2. Which of the following is the correct syntax to display the Terraform state in JSON format?

easy

A. terraform show -json

B. terraform show --json-output

C. terraform show json

D. terraform show -format=json

Solution

1. Step 1: Recall the correct flag for JSON output

   The official Terraform command to show state in JSON format uses the -json flag.

2. Step 2: Verify other options

   Options like --json-output, json as a subcommand, or -format=json are not valid Terraform syntax.

3. Final Answer:

   terraform show -json -> Option A

4. Quick Check:

   Use -json flag for JSON output [OK]

Hint: Use '-json' flag exactly for JSON output [OK]

Common Mistakes:

• Adding extra words like '--json-output'
• Using subcommands instead of flags
• Mixing up flag syntax

3. Given the following Terraform state snippet shown by terraform show:

resource "aws_instance" "web" {
  id = "i-1234567890abcdef0"
  ami = "ami-0abcdef1234567890"
  instance_type = "t2.micro"
}

What will terraform show -json output include for the instance type?

medium

A. "instance_type": "t2.large"

B. "instance_type": "ami-0abcdef1234567890"

C. "instance_type": null

D. "instance_type": "t2.micro"

Solution

1. Step 1: Identify the instance_type in the state snippet

   The snippet shows instance_type = "t2.micro" for the resource.

2. Step 2: Understand JSON output reflects state values

   The JSON output from terraform show -json will include the exact value stored, which is "t2.micro".

3. Final Answer:

   "instance_type": "t2.micro" -> Option D

4. Quick Check:

   State value matches JSON output [OK]

Hint: JSON output matches exact state values [OK]

Common Mistakes:

• Confusing AMI ID with instance type
• Assuming default or null values
• Mixing resource attributes

4. You run terraform show -json but get an error: error: no state file found. What is the most likely cause?

medium

A. Terraform is not installed

B. The -json flag is not supported

C. Terraform state file does not exist in the current directory

D. The configuration files have syntax errors

Solution

1. Step 1: Understand the error message

   The error indicates Terraform cannot find the state file to show.

2. Step 2: Identify common reasons for missing state

   If the state file is missing from the current directory, terraform show cannot display state.

3. Final Answer:

   Terraform state file does not exist in the current directory -> Option C

4. Quick Check:

   Missing state file causes this error [OK]

Hint: Check if state file exists before show [OK]

Common Mistakes:

• Assuming -json flag is unsupported
• Thinking Terraform is not installed
• Blaming config syntax errors for state show

5. You want to programmatically extract the IDs of all AWS instances from your Terraform state. Which command and option combination is best suited for this task?

hard

A. terraform show -json | jq '.values.root_module.resources[] | select(.type=="aws_instance") | .values.id'

B. terraform show | grep aws_instance | awk '{print $2}'

C. terraform state list aws_instance

D. terraform output aws_instance_ids

Solution

1. Step 1: Understand the need for programmatic extraction

   You want to get instance IDs from the state in a machine-readable way.

2. Step 2: Evaluate command options

   terraform show -json outputs JSON, which can be filtered with jq to select AWS instances and extract their IDs. Other options either do not output JSON or do not extract IDs directly.

3. Final Answer:

   terraform show -json | jq '.values.root_module.resources[] | select(.type=="aws_instance") | .values.id' -> Option A

4. Quick Check:

   Use JSON output with jq for precise extraction [OK]

Hint: Use -json with jq to filter state data easily [OK]

Common Mistakes:

• Using grep/awk on human-readable output (fragile)
• Using terraform state list which lists names, not IDs
• Assuming terraform output has instance IDs without explicit output