Terraform file organization - Commands & Configuration

Introduction

When you build infrastructure with Terraform, organizing your files well helps you find things easily and avoid mistakes. Good file organization keeps your setup clear and simple to manage.

When your Terraform setup grows beyond a single file and you want to keep related resources grouped.

When you want to separate variables, outputs, and resource definitions for clarity.

When you work with a team and want everyone to understand the structure quickly.

When you plan to reuse parts of your configuration in different projects.

When you want to keep sensitive information separate from main resource files.

Config File - main.tf

main.tf

terraform {
  required_version = ">= 1.0"
  required_providers {
    aws = {
      source  = "hashicorp/aws"
      version = "~> 4.0"
    }
  }
}

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

resource "aws_instance" "example" {
  ami           = var.ami_id
  instance_type = var.instance_type
  tags = {
    Name = "example-instance"
  }
}

This file sets the Terraform version and AWS provider details. It also defines an AWS EC2 instance resource using variables for the AMI ID and instance type.

Separate files like variables.tf and outputs.tf would hold variable definitions and outputs respectively to keep things organized.

Commands

This command initializes the Terraform working directory. It downloads the provider plugins and prepares the environment to run Terraform commands.

Terminal

terraform init

Expected Output

Initializing the backend...



Initializing provider plugins...

- Finding hashicorp/aws versions matching "~> 4.0"...

- 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 checks your Terraform files for syntax errors and basic mistakes without making any changes to real infrastructure.

Terminal

terraform validate

Expected Output

Success! The configuration is valid.

This command shows what Terraform will do when you apply your configuration. It previews the changes without making them.

Terminal

terraform plan

Expected Output

Refreshing Terraform state in-memory prior to plan...



An execution plan has been generated and is shown below.

Resource actions are indicated with the following symbols:

  + create



Terraform will perform the following actions:



  # aws_instance.example will be created

  + resource "aws_instance" "example" {

      + ami           = "ami-0c55b159cbfafe1f0"

      + instance_type = "t2.micro"

      + tags          = {

          + "Name" = "example-instance"

        }

    }



Plan: 1 to add, 0 to change, 0 to destroy.

This command applies the planned changes to create or update your infrastructure. The flag skips the confirmation prompt to make it faster.

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.

→

-auto-approve - Skips the manual approval step to apply changes immediately.

Key Concept

If you remember nothing else from this pattern, remember: organizing Terraform files by purpose (variables, resources, outputs) keeps your infrastructure code clear and easy to manage.

Common Mistakes

Putting all Terraform code in one big file.

It becomes hard to find and update parts of your setup, leading to mistakes and confusion.

Split your code into multiple files like variables.tf, main.tf, and outputs.tf to separate concerns.

Not running terraform validate before applying changes.

You might apply broken or invalid configurations that cause errors or unexpected results.

Always run terraform validate to catch syntax errors early.

Ignoring terraform init when starting a new project or after changing providers.

Terraform won't download necessary plugins, causing commands to fail.

Run terraform init to prepare your working directory before other commands.

Summary

Use separate Terraform files to organize variables, resources, and outputs clearly.

Run terraform init to set up your environment before planning or applying changes.

Use terraform validate to check your files for errors before applying.

Use terraform plan to preview changes and terraform apply to make them happen.

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