Module sources (local, registry, git) in Terraform - Commands & Configuration

Introduction

Sometimes you want to reuse code in Terraform projects stored in a local Git repository. This helps keep your infrastructure code organized and consistent without copying files around.

When you have multiple Terraform projects that share common modules stored in a local Git repository.

When you want to track changes in your modules using Git version control locally.

When you want to test module changes locally before pushing them to a remote Git server.

When you want to avoid duplicating module code by referencing a single source in Git.

When you want to use specific versions or branches of your modules stored in Git.

Config File - main.tf

main.tf

terraform {
  required_version = ">= 1.0"
}

module "example_module" {
  source = "git::file:///home/user/terraform-modules/example-module.git"
  # Add module input variables here
  example_variable = "Hello from local Git module"
}

This Terraform configuration uses a module stored in a local Git repository.

terraform block sets the required Terraform version.

module "example_module" block declares the module usage.

source uses the git::file:// prefix to point to the local Git repository path.

You can pass variables to the module as usual.

Commands

This command initializes the Terraform working directory. It downloads the module from the local Git repository and prepares the environment.

Terminal

terraform init

Expected Output

Initializing the backend...



Initializing provider plugins...



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. All Terraform commands

should now work.



If you ever set or change modules or backend configuration, rerun this command

to reinitialize your working directory. If you forget, other commands will

detect it and remind you to do so if necessary.

This command shows what Terraform will do based on the module code and variables. It helps verify the module is loaded and working.

Terminal

terraform plan

Expected Output

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



No changes. Infrastructure is up-to-date.



This means that Terraform did not detect any differences between your

configuration and real physical resources that exist. As a result, no

actions are needed.

Key Concept

If you remember nothing else from this pattern, remember: use the git::file:// prefix in the module source to load modules from a local Git repository.

Common Mistakes

Using a local file path without the git::file:// prefix in the module source.

Terraform treats it as a normal file path and does not use Git features like versioning or branches.

Always prefix the local Git repository path with git::file:// to tell Terraform to use Git.

Using a relative path without the full absolute path for the local Git repository.

Terraform may not find the repository correctly if the path is relative and the working directory changes.

Use the full absolute path starting with git::file:/// for local Git module sources.

Summary

Declare modules with source using git::file:/// followed by the local Git repo path.

Run terraform init to download and prepare the module from the local Git repository.

Use terraform plan to verify the module loads and shows planned infrastructure changes.

Practice

1. What does the source argument specify in a Terraform module block?

easy

A. The location where Terraform finds the module code

B. The version of Terraform to use

C. The cloud provider for the module

D. The output variables of the module

Solution

1. Step 1: Understand the role of source in a module

   The source argument tells Terraform where to get the module code from, such as a local folder, registry, or Git repo.

2. Step 2: Identify what source does not specify

   It does not specify Terraform version, cloud provider, or outputs; those are separate configurations.

3. Final Answer:

   The location where Terraform finds the module code -> Option A

4. Quick Check:

   Module source = module location [OK]

Hint: Remember: source means 'where to get the module' [OK]

Common Mistakes:

• Confusing source with Terraform version
• Thinking source defines outputs
• Assuming source sets cloud provider

2. Which of the following is the correct syntax to use a local module located in a folder named modules/network?

easy

A. module "net" { source = "modules/network" }

B. module "net" { source = "registry/modules/network" }

C. module "net" { source = "git::https://example.com/network.git" }

D. module "net" { source = "network" }

Solution

1. Step 1: Identify local module source syntax

   Local modules use a relative or absolute path as the source. Here, "modules/network" is a relative path.

2. Step 2: Check other options for correctness

   module "net" { source = "registry/modules/network" } uses registry syntax incorrectly; module "net" { source = "git::https://example.com/network.git" } is for Git sources; module "net" { source = "network" } lacks the folder path.

3. Final Answer:

   module "net" { source = "modules/network" } -> Option A

4. Quick Check:

   Local module source = folder path [OK]

Hint: Local modules use folder paths as source [OK]

Common Mistakes:

• Using registry or git syntax for local modules
• Omitting folder path in source
• Confusing source with module name

3. Given this module block:

module "web" {
  source = "git::https://github.com/example/terraform-web.git"
  version = "v1.0.0"
}

What will Terraform do when you run terraform init?

medium

A. Download the module from the local folder named terraform-web

B. Download the module from the Terraform Registry

C. Clone the Git repository at the given URL and checkout version v1.0.0

D. Fail because version is not supported for Git sources

Solution

1. Step 1: Understand Git source syntax in Terraform

   The source starting with "git::" tells Terraform to clone a Git repository from the URL.

2. Step 2: Interpret the version argument with Git sources

   The version here refers to a Git tag or branch to checkout, so Terraform will checkout "v1.0.0" after cloning.

3. Final Answer:

   Clone the Git repository at the given URL and checkout version v1.0.0 -> Option C

4. Quick Check:

   Git source + version = clone and checkout tag [OK]

Hint: Git source means clone repo; version is Git tag/branch [OK]

Common Mistakes:

• Thinking version is Terraform Registry version
• Assuming source is local folder
• Believing version is unsupported for Git

4. You wrote this module block:

module "db" {
  source = "git::https://github.com/example/terraform-db.git"
  version = "1.0.0"
}

When running terraform init, you get an error. What is the likely cause?

medium

A. The module name 'db' is invalid

B. The version should be prefixed with 'v' like 'v1.0.0' to match Git tags

C. The source URL must be a local path for modules

D. Git URLs cannot be used as module sources

Solution

1. Step 1: Check Git tag naming conventions

   Git tags often start with 'v' (e.g., 'v1.0.0'). If the tag is named with 'v', specifying '1.0.0' causes a mismatch.

2. Step 2: Verify other options for errors

   Git URLs are valid sources; local path is not required; module name 'db' is valid.

3. Final Answer:

   The version should be prefixed with 'v' like 'v1.0.0' to match Git tags -> Option B

4. Quick Check:

   Git version tag must match exact Git tag name [OK]

Hint: Match version exactly to Git tag name (often starts with 'v') [OK]

Common Mistakes:

• Omitting 'v' prefix in version for Git tags
• Thinking Git URLs are invalid module sources
• Assuming module names have strict rules

5. You want to reuse a module from the Terraform Registry named hashicorp/aws with version 4.0.0. Which is the correct module block to use?

hard

A. module "aws_module" {
source = "git::https://github.com/hashicorp/aws.git"
version = "4.0.0"
}

B. module "aws_module" {
source = "registry/hashicorp/aws"
version = "4.0.0"
}

C. module "aws_module" {
source = "./hashicorp/aws"
version = "4.0.0"
}

D. module "aws_module" {
source = "hashicorp/aws"
version = "4.0.0"
}

Solution

1. Step 1: Identify Terraform Registry module source syntax

   Modules from the Terraform Registry use the format "namespace/module" as the source, e.g., "hashicorp/aws".

2. Step 2: Check other options for correctness

   module "aws_module" { source = "git::https://github.com/hashicorp/aws.git" version = "4.0.0" } uses Git URL which is incorrect for Registry modules; module "aws_module" { source = "./hashicorp/aws" version = "4.0.0" } uses local path; module "aws_module" { source = "registry/hashicorp/aws" version = "4.0.0" } uses invalid prefix "registry/".

3. Final Answer:

   module "aws_module" { source = "hashicorp/aws" version = "4.0.0" } -> Option D

4. Quick Check:

   Registry modules use "namespace/module" source format [OK]

Hint: Registry modules use "namespace/module" as source [OK]

Common Mistakes:

• Using Git URL for Registry modules
• Adding extra prefixes like 'registry/'
• Using local paths for Registry modules