Outputs as documentation in Terraform - Commands & Configuration

Introduction

When you create infrastructure with Terraform, you often want to see important information after it finishes. Outputs let you show key details like IP addresses or URLs. This helps you understand what was created without searching through all the resources.

When you want to see the public IP address of a server after deployment.

When you need to share the URL of a load balancer with your team.

When you want to confirm the ID of a created database instance.

When you want to pass information from one Terraform module to another.

When you want to document important values for future reference.

Config File - main.tf

main.tf

provider "aws" {
  region = "us-east-1"
}

resource "aws_instance" "example" {
  ami           = "ami-0c55b159cbfafe1f0"
  instance_type = "t2.micro"

  tags = {
    Name = "example-instance"
  }
}

output "instance_id" {
  description = "The ID of the example instance"
  value       = aws_instance.example.id
}

output "instance_public_ip" {
  description = "The public IP address of the example instance"
  value       = aws_instance.example.public_ip
}

This Terraform file creates a simple AWS EC2 instance.

The output blocks define values to show after deployment:

• instance_id shows the unique ID of the instance.
• instance_public_ip shows the public IP address assigned.

These outputs help you quickly find important info without digging into the AWS console.

Commands

This command sets up Terraform in the current folder. It downloads the AWS provider plugin needed to create resources.

Terminal

terraform init

Expected Output

Initializing the backend...



Initializing provider plugins...

- Finding latest version of hashicorp/aws...

- Installing hashicorp/aws v4.0.0...

- Installed hashicorp/aws v4.0.0 (signed by HashiCorp)



Terraform has been successfully initialized!



You may now begin working with Terraform. Try running "terraform plan" to see any changes that are required for your infrastructure.

This command creates the resources defined in the configuration. The -auto-approve flag skips the confirmation prompt to speed up deployment.

Terminal

terraform apply -auto-approve

Expected Output

aws_instance.example: Creating...

aws_instance.example: Still creating... [10s elapsed]

aws_instance.example: Creation complete after 15s [id=i-0abcd1234efgh5678]



Apply complete! Resources: 1 added, 0 changed, 0 destroyed.



Outputs:



instance_id = "i-0abcd1234efgh5678"

instance_public_ip = "54.210.123.45"

→

-auto-approve - Automatically approve the apply without asking for confirmation

This command shows the output values defined in the configuration. It helps you quickly see important information about your deployed resources.

Terminal

terraform output

Expected Output

instance_id = "i-0abcd1234efgh5678"

instance_public_ip = "54.210.123.45"

Key Concept

If you remember nothing else from this pattern, remember: Terraform outputs let you easily see and share important details about your infrastructure after deployment.

Common Mistakes

Not defining output blocks for important resource attributes.

Without outputs, you have to search through resource details or cloud consoles to find key info.

Always add output blocks for values you want to see or share after deployment.

Trying to access output values before running terraform apply.

Outputs depend on created resources, so they don't exist until after apply.

Run terraform apply first, then use terraform output to see values.

Summary

Use terraform init to prepare your working folder and download providers.

Run terraform apply to create resources and see output values immediately.

Use terraform output anytime to view important information about your deployed infrastructure.

Practice

1. What is the main purpose of output blocks in Terraform?

easy

A. To write resource creation logic

B. To define variables for input values

C. To display important information after infrastructure is created

D. To configure provider settings

Solution

1. Step 1: Understand output block role

   Output blocks are used to show key information after Terraform finishes applying changes.

2. Step 2: Differentiate from other blocks

   Variables define inputs, providers configure cloud access, and resources create infrastructure, so outputs are for displaying results.

3. Final Answer:

   To display important information after infrastructure is created -> Option C

4. Quick Check:

   Outputs = display info [OK]

Hint: Outputs show info after apply, not inputs or configs [OK]

Common Mistakes:

• Confusing outputs with variables
• Thinking outputs create resources
• Assuming outputs configure providers

2. Which of the following is the correct syntax to define an output with a description in Terraform?

easy

A. output ip_address { value = aws_instance.web.public_ip description = "Public IP address" }

B. output "ip_address" { value = aws_instance.web.public_ip description = "Public IP address" }

C. output "ip_address" { value = aws_instance.web.public_ip } description = "Public IP address"

D. output "ip_address" { value = aws_instance.web.public_ip desc = "Public IP address" }

Solution

1. Step 1: Check output block structure

   An output block requires a name, a value, and optionally a description inside curly braces.

2. Step 2: Verify correct syntax

   The correct syntax places each attribute on its own line or separated properly; output "ip_address" { value = aws_instance.web.public_ip description = "Public IP address" } shows the correct format with value and description.

3. Final Answer:

   output "ip_address" { value = aws_instance.web.public_ip description = "Public IP address" } -> Option B

4. Quick Check:

   Output syntax = name, value, description [OK]

Hint: Output blocks need name, value, description inside braces [OK]

Common Mistakes:

• Missing quotes around output name
• Placing description outside the block
• Using incorrect attribute names

3. Given this Terraform output block:

output "db_password" {
  value       = aws_db_instance.main.password
  sensitive   = true
  description = "The database password"
}

What will happen when you run terraform apply?

medium

A. The password will not be shown in the output because it is marked sensitive

B. Terraform will throw a syntax error due to sensitive attribute

C. The password will be shown in the output after apply

D. The password will be printed in plain text in the logs

Solution

1. Step 1: Understand sensitive attribute effect

   Marking an output as sensitive hides its value from the standard output to protect secrets.

2. Step 2: Predict terraform apply behavior

   Terraform will apply changes but will not display the sensitive value in the output summary.

3. Final Answer:

   The password will not be shown in the output because it is marked sensitive -> Option A

4. Quick Check:

   sensitive output hides value [OK]

Hint: Sensitive outputs hide values after apply [OK]

Common Mistakes:

• Assuming sensitive outputs print values
• Thinking sensitive causes errors
• Confusing sensitive with encryption

4. You wrote this output block:

output "instance_ip" {
value = aws_instance.web.public_ip
}

Terraform shows a warning about missing description. How do you fix it?

medium

A. Rename the output to "instance_ip_address"

B. Remove the output block completely

C. Change value to a string literal

D. Add a description attribute inside the output block

Solution

1. Step 1: Identify missing description

   Terraform recommends adding descriptions to outputs for clarity and documentation.

2. Step 2: Add description attribute

   Include a line like description = "Public IP of the instance" inside the output block to fix the warning.

3. Final Answer:

   Add a description attribute inside the output block -> Option D

4. Quick Check:

   Outputs need descriptions for docs [OK]

Hint: Add description attribute to output blocks [OK]

Common Mistakes:

• Ignoring description warnings
• Changing output name unnecessarily
• Removing output instead of fixing

5. You want to output a list of public IPs from multiple instances created with a for_each in Terraform. Which output block correctly documents and outputs this list?

hard

A. output "instance_ips" {
value = [for inst in aws_instance.web : inst.public_ip]
description = "List of public IPs for all web instances"
}

B. output "instance_ips" {
value = aws_instance.web.public_ip
description = "List of public IPs for all web instances"
}

C. output "instance_ips" {
value = tolist(aws_instance.web.public_ip)
description = "List of public IPs for all web instances"
}

D. output "instance_ips" {
value = aws_instance.web.public_ip[0]
description = "List of public IPs for all web instances"
}

Solution

1. Step 1: Understand for_each resource outputs

   When using for_each, resources are a map, so to get all public IPs, a for expression is needed to collect them.

2. Step 2: Check output value expression

   output "instance_ips" { value = [for inst in aws_instance.web : inst.public_ip] description = "List of public IPs for all web instances" } uses a for expression to iterate over all instances and extract public_ip, which is correct and documented with description.

3. Final Answer:

   output "instance_ips" { value = [for inst in aws_instance.web : inst.public_ip] description = "List of public IPs for all web instances" } -> Option A

4. Quick Check:

   Use for expression to output list from for_each [OK]

Hint: Use for expression to collect values from for_each resources [OK]

Common Mistakes:

• Using direct attribute without iteration
• Accessing only first element
• Using incorrect syntax for list extraction