Outputs as documentation in Terraform - Step-by-Step Execution

Process Flow - Outputs as documentation

Define output block

↓

Assign value and description

↓

Run terraform apply

↓

Terraform stores output

↓

Run terraform output

↓

Display output value and description

Outputs are defined in Terraform to show important info after deployment, helping document what was created.

Execution Sample

Terraform

output "instance_ip" {
  value       = aws_instance.web.public_ip
  description = "The public IP of the web server instance"
}

This output block shows the public IP of a created AWS instance with a helpful description.

Process Table

Step	Action	Evaluation	Result
1	Terraform reads output block	Parses value and description	Output 'instance_ip' defined with value and description
2	terraform apply runs	Creates aws_instance.web	Instance created with public IP assigned
3	Terraform stores output value	Captures aws_instance.web.public_ip	Output value saved
4	User runs 'terraform output'	Fetches stored outputs	Displays 'instance_ip' value
5	User reads output	Sees IP and description	Understands what resource IP is for
6	End	No more outputs	Execution stops

💡 All outputs displayed after apply; no further outputs to show

Status Tracker

Variable	Start	After Apply	After Output Command
instance_ip	undefined	54.123.45.67	54.123.45.67

Key Moments - 3 Insights

Why do we add a description to an output?

The description helps users understand what the output value means, as shown in step 4 of the execution_table where the output is displayed with its description.

When is the output value available to see?

The output value is only available after 'terraform apply' runs successfully and creates the resource, as shown in step 3 where the value is stored.

Can outputs show values before resources are created?

No, outputs depend on resource values created during apply, so before apply the output value is undefined, as shown in variable_tracker start state.

Visual Quiz - 3 Questions

Look at the execution_table, at which step does Terraform store the output value?

A Step 4

B Step 2

C Step 3

D Step 1

💡 Hint

Check the 'Evaluation' column in step 3 where it says 'Captures aws_instance.web.public_ip'

According to variable_tracker, what is the value of 'instance_ip' before 'terraform apply'?

A 54.123.45.67

B undefined

C null

D 0.0.0.0

💡 Hint

Look at the 'Start' column for 'instance_ip' in variable_tracker

If the description was missing from the output block, what would change in the execution_table output display?

A The output value would show but without description

B The output value would not be shown

C Terraform apply would fail

D The output would show an error

💡 Hint

Step 4 shows output value and description; description is optional but helps users

Concept Snapshot

Terraform outputs show important info after deployment.
Define with 'output' block: value and optional description.
Run 'terraform apply' to create resources.
Run 'terraform output' to see values.
Descriptions help document outputs for users.

Full Transcript

Terraform outputs are blocks that let you show key information after your infrastructure is created. You define an output with a name, a value (usually from a resource), and an optional description to explain what it means. When you run 'terraform apply', Terraform creates the resources and captures the output values. Later, running 'terraform output' displays these values along with their descriptions. This helps users understand what was created and how to use the outputs. Outputs are only available after resources exist, so before apply they are undefined. Adding descriptions is a best practice to document your infrastructure clearly.

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