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.