Terraform file organization - Mini Project: Build & Apply

Terraform File Organization

📖 Scenario: You are working on a cloud project where you need to organize your Terraform files properly. Good file organization helps you and your team understand and manage your infrastructure code easily.

🎯 Goal: Build a simple Terraform project with multiple files organized by purpose: one file for provider setup, one for variables, one for resources, and one for outputs.

📋 What You'll Learn

Create a provider.tf file with AWS provider configuration

Create a variables.tf file defining a variable for AWS region

Create a main.tf file with an AWS S3 bucket resource using the variable

Create an outputs.tf file that outputs the S3 bucket name

💡 Why This Matters

🌍 Real World

Organizing Terraform files is a common practice in real cloud projects to improve readability and collaboration.

💼 Career

Cloud engineers and DevOps professionals use Terraform file organization to manage infrastructure code efficiently in teams.

1

Create provider.tf with AWS provider

Create a file named provider.tf and write the AWS provider configuration with region set to us-east-1.

Terraform

# Your code here

Hint

The AWS provider block starts with provider "aws" { and you set the region inside it.

2

Create variables.tf with AWS region variable

Create a file named variables.tf and define a variable called aws_region with default value us-east-1.

Terraform

# Your code here

Hint

Use variable "aws_region" {} block and set default = "us-east-1".

3

Create main.tf with an S3 bucket resource

Create a file named main.tf and add an AWS S3 bucket resource named my_bucket. Use the variable aws_region for the bucket's region tag.

Terraform

# Your code here

Hint

Use resource "aws_s3_bucket" "my_bucket" {} and set bucket and tags with Region = var.aws_region.

4

Create outputs.tf to output the bucket name

Create a file named outputs.tf and define an output called bucket_name that outputs the name of the S3 bucket resource my_bucket.

Terraform

# Your code here

Hint

Use output "bucket_name" {} block and set value = aws_s3_bucket.my_bucket.bucket.

Practice

1. What is the main purpose of organizing Terraform files into separate files like main.tf, variables.tf, and outputs.tf?

easy

A. To avoid using variables in the configuration

B. To reduce the number of resources created

C. To speed up Terraform apply operations

D. To make the code easier to read and maintain

Solution

1. Step 1: Understand file separation purpose

   Separating files by purpose helps organize code logically, making it easier to find and update parts.

2. Step 2: Recognize benefits of organization

   This organization improves readability and maintainability but does not affect resource count or speed directly.

3. Final Answer:

   To make the code easier to read and maintain -> Option D

4. Quick Check:

   File organization = easier maintenance [OK]

Hint: Think about how folders help organize papers [OK]

Common Mistakes:

• Confusing file organization with resource optimization
• Thinking it speeds up Terraform operations
• Believing variables are avoided by file separation

2. Which of the following is the correct way to declare a variable in a separate variables.tf file?

easy

A. variable "instance_type" { default = "t2.micro" }

B. var instance_type = "t2.micro"

C. variable instance_type = "t2.micro"

D. var "instance_type" { default = "t2.micro" }

Solution

1. Step 1: Recall Terraform variable syntax

   Terraform variables are declared with the keyword variable followed by the variable name in quotes and a block with attributes.

2. Step 2: Match correct syntax

   variable "instance_type" { default = "t2.micro" } matches the correct syntax: variable "name" { default = "value" }. Other options use invalid syntax.

3. Final Answer:

   variable "instance_type" { default = "t2.micro" } -> Option A

4. Quick Check:

   Correct variable syntax = variable "instance_type" { default = "t2.micro" } [OK]

Hint: Variables use 'variable' keyword with quotes and braces [OK]

Common Mistakes:

• Omitting quotes around variable name
• Using 'var' instead of 'variable' keyword
• Assigning variable like a normal programming variable

3. Given these files:

main.tf:
resource "aws_instance" "web" {
  ami           = var.ami_id
  instance_type = var.instance_type
}

variables.tf:
variable "ami_id" {}
variable "instance_type" {}

outputs.tf:
output "instance_id" {
  value = aws_instance.web.id
}

What will Terraform output after apply if the instance ID is i-1234567890abcdef0?

medium

A. "instance_id" = "i-1234567890abcdef0"

B. "instance_type" = "i-1234567890abcdef0"

C. "ami_id" = "i-1234567890abcdef0"

D. No output will be shown

Solution

1. Step 1: Identify output block purpose

   The outputs.tf file defines an output named instance_id that returns the ID of the AWS instance resource.

2. Step 2: Match output value with resource ID

   After apply, Terraform shows outputs with their names and values. The output will show instance_id with the instance's actual ID.

3. Final Answer:

   "instance_id" = "i-1234567890abcdef0" -> Option A

4. Quick Check:

   Output name matches resource ID [OK]

Hint: Outputs show resource values by their output names [OK]

Common Mistakes:

• Confusing variable names with output names
• Expecting variables to show as outputs automatically
• Thinking no output is shown without explicit output block

4. You have a variables.tf file with:

variable "region" {
  default = "us-east-1"
}

But Terraform apply fails with an error about missing provider configuration. What is the likely cause?

medium

A. Variables cannot have default values

B. The variable region must be declared in main.tf

C. The provider block is missing or not configured

D. Terraform requires region to be set in outputs.tf

Solution

1. Step 1: Understand provider role

   Terraform needs a provider block to know which cloud and region to use. Variables alone do not configure providers.

2. Step 2: Identify missing provider configuration

   If the provider block is missing or lacks region setting, Terraform cannot connect to the cloud, causing errors.

3. Final Answer:

   The provider block is missing or not configured -> Option C

4. Quick Check:

   Provider block required for cloud access [OK]

Hint: Always check provider block for cloud setup [OK]

Common Mistakes:

• Assuming variables configure providers automatically
• Placing variables in wrong files to fix provider errors
• Expecting outputs to fix provider configuration

5. You want to organize a Terraform project with multiple environments (dev, prod). Which file organization approach is best practice?

hard

A. Use one main.tf and switch environment by changing variable defaults

B. Create separate folders for each environment, each with its own main.tf, variables.tf, and outputs.tf

C. Put all environments in one folder using different variable names

D. Store environment configs only in terraform.tfvars without separate folders

Solution

1. Step 1: Understand environment isolation

   Separate folders per environment keep configurations isolated, avoiding accidental resource overlap.

2. Step 2: Recognize best practice for clarity and safety

   Each folder having its own files allows independent management and clear separation of dev and prod.

3. Final Answer:

   Create separate folders for each environment, each with its own main.tf, variables.tf, and outputs.tf -> Option B

4. Quick Check:

   Separate folders = safer multi-env management [OK]

Hint: Use folders to separate environments clearly [OK]

Common Mistakes:

• Mixing environments in one folder causing conflicts
• Relying only on variable changes without folder separation
• Not isolating state files per environment