Why File naming conventions (.tf files) in Terraform? - Purpose & Use Cases

The Big Idea

What if a simple file name could save you hours of frustration and errors?

The Scenario

Imagine you have many Terraform files named randomly like config1.tf, stuff.tf, or mainfile.tf. When you want to update or fix something, you waste time searching through unclear file names.

The Problem

Without clear file names, it's easy to get confused, make mistakes, or overwrite important settings. This slows down your work and can cause errors in your cloud setup.

The Solution

Using consistent file naming rules helps you quickly find and understand each file's purpose. It keeps your project organized and reduces mistakes.

Before vs After

✗ Before

config1.tf
stuff.tf
mainfile.tf

✓ After

variables.tf
main.tf
outputs.tf
provider.tf

What It Enables

Clear file names make managing cloud infrastructure faster, safer, and easier for everyone on the team.

Real Life Example

A team working on a cloud project can quickly spot where variables are defined or where outputs are set just by looking at file names, saving hours of confusion.

Key Takeaways

Random file names cause confusion and errors.

Consistent naming organizes your Terraform files clearly.

Clear names speed up teamwork and reduce mistakes.

Practice

1. Which of the following is the most common file name used to define the main Terraform configuration?

easy

A. terraform.tf

B. config.tf

C. setup.tf

D. main.tf

Solution

1. Step 1: Understand common Terraform file names

   The main Terraform configuration is typically placed in a file named main.tf to keep it clear and standard.

2. Step 2: Compare options with common practice

   Among the options, only main.tf is widely recognized and recommended for the main configuration.

3. Final Answer:

   main.tf -> Option D

4. Quick Check:

   Main configuration file = main.tf [OK]

Hint: Main config file is usually named main.tf [OK]

Common Mistakes:

• Choosing uncommon names like config.tf
• Using generic names like terraform.tf
• Confusing setup files with main config

2. Which file name is conventionally used to declare input variables in Terraform?

easy

A. variables.tf

B. inputs.tf

C. vars.tf

D. params.tf

Solution

1. Step 1: Identify the standard file for input variables

   Terraform commonly uses variables.tf to declare input variables for clarity and consistency.

2. Step 2: Check other options for correctness

   Other names like inputs.tf, vars.tf, and params.tf are not standard and may confuse team members.

3. Final Answer:

   variables.tf -> Option A

4. Quick Check:

   Input variables file = variables.tf [OK]

Hint: Input variables go in variables.tf file [OK]

Common Mistakes:

• Using inputs.tf instead of variables.tf
• Shortening to vars.tf which is non-standard
• Naming it params.tf which is unclear

3. Given these files in a Terraform project: main.tf, variables.tf, and outputs.tf, what is the purpose of outputs.tf?

medium

A. To define the resources to create

B. To declare input variables

C. To specify values to show after apply

D. To configure backend storage

Solution

1. Step 1: Understand the role of outputs.tf

   The outputs.tf file is used to declare output values that Terraform will display after applying the configuration.

2. Step 2: Differentiate from other files

   main.tf defines resources, variables.tf declares inputs, and backend configuration is usually in backend.tf or inside main.tf.

3. Final Answer:

   To specify values to show after apply -> Option C

4. Quick Check:

   outputs.tf shows output values [OK]

Hint: Outputs.tf shows results after apply [OK]

Common Mistakes:

• Confusing outputs.tf with variables.tf
• Thinking outputs.tf defines resources
• Assuming outputs.tf configures backend

4. You have a Terraform project with files named main.tf, variables.tf, and output.tf. Why might this violate standard conventions?

medium

A. Because main.tf must contain outputs

B. Because the outputs file is misnamed; it should be outputs.tf

C. Because variables.tf is missing output declarations

D. Because Terraform requires outputs in a .json file

Solution

1. Step 1: Check file naming conventions for outputs

   The conventional file name for outputs is outputs.tf (plural). Naming it output.tf (singular) violates standard conventions.

2. Step 2: Understand Terraform file loading

   Terraform loads all .tf files regardless of name for functionality, but standard names improve clarity and teamwork.

3. Final Answer:

   Because the outputs file is misnamed; it should be outputs.tf -> Option B

4. Quick Check:

   outputs file = outputs.tf [OK]

Hint: Outputs file should be named outputs.tf [OK]

Common Mistakes:

• Assuming outputs can be in variables.tf
• Thinking main.tf must have outputs
• Expecting outputs in JSON files

5. You want to organize a large Terraform project by splitting configurations into multiple files. Which naming approach best supports teamwork and maintenance?

hard

A. Use descriptive names like network.tf, compute.tf, variables.tf, outputs.tf

B. Name all files config1.tf, config2.tf, config3.tf for simplicity

C. Put all code in main.tf to avoid confusion

D. Use random names to avoid predictable patterns

Solution

1. Step 1: Consider clarity and teamwork in file naming

   Descriptive file names like network.tf and compute.tf help team members quickly find and understand code sections.

2. Step 2: Evaluate other naming options

   Generic names like config1.tf or random names cause confusion and make maintenance harder. Putting all code in one file reduces clarity.

3. Final Answer:

   Use descriptive names like network.tf, compute.tf, variables.tf, outputs.tf -> Option A

4. Quick Check:

   Descriptive file names improve teamwork [OK]

Hint: Use clear, descriptive file names for easier teamwork [OK]

Common Mistakes:

• Using numbered or random file names
• Putting all code in one file
• Ignoring naming conventions for clarity