Terraform: Initialize a New Project

Introduction

Terraform is a popular open-source Infrastructure as Code (IaC) tool created by HashiCorp. It allows you to define and provision infrastructure resources using a declarative configuration language.

The first command you'll run in any new Terraform project is terraform init. This command is crucial as it prepares your working directory for use with Terraform. It performs several key actions:

Backend Initialization: Configures the state storage backend.
Provider Plugin Installation: Scans your configuration files, determines which providers are needed, and downloads them from the Terraform Registry.
Module Installation: Downloads any modules referenced in your configuration.

In this lab, you will learn the fundamental process of initializing a new Terraform project. You will create a project directory, define a simple configuration file, and use terraform init to download the required provider plugin.

Create a new directory for Terraform project

In this step, you will create a dedicated directory for your new Terraform project. It is a best practice to keep each Terraform project in its own directory to avoid conflicts and keep configurations organized. All your operations will be within the ~/project directory.

First, create a new directory named terraform-init-lab.

mkdir terraform-init-lab

Next, navigate into the newly created directory. This will be your working directory for the rest of the lab.

cd terraform-init-lab

Your terminal prompt should now indicate that you are inside the ~/project/terraform-init-lab directory.

Create main.tf file in the project directory

In this step, you will create the main configuration file for your project. Terraform configuration files use the .tf extension and are written in HashiCorp Configuration Language (HCL). By convention, the primary configuration file is often named main.tf.

From within your terraform-init-lab directory, create an empty file named main.tf using the touch command.

touch main.tf

You can verify that the file has been created by listing the contents of the directory.

ls

You should see the main.tf file in the output.

main.tf

Define local provider configuration in main.tf

In this step, you will add configuration code to your main.tf file. This code will tell Terraform which provider it needs to download and use. A provider is a plugin that allows Terraform to interact with a specific API, such as a cloud provider or a SaaS service.

For this lab, we will use the local provider, which allows you to manage local files. It's a great provider for learning because it doesn't require any cloud credentials.

Open the main.tf file using the nano text editor.

nano main.tf

Now, copy and paste the following code block into the nano editor. This terraform block specifies the required providers for the project.

terraform {
  required_providers {
    local = {
      source  = "hashicorp/local"
      version = "2.4.0"
    }
  }
}

This configuration tells Terraform:

required_providers: We are declaring the providers this project needs.
local: The local name we are giving to the provider.
source: The global address of the provider in the Terraform Registry, which is hashicorp/local.
version: The specific version of the provider to use.

After pasting the code, save the file and exit nano by pressing Ctrl+O, then Enter, and finally Ctrl+X.

Run terraform init to initialize the project

In this step, you will run the terraform init command. With the provider configuration in place, Terraform now knows what it needs to do to initialize the project. It will read the main.tf file, find the required_providers block, and download the specified version of the hashicorp/local provider from the Terraform Registry.

Make sure you are still in the terraform-init-lab directory, and then run the initialization command.

terraform init

You will see output indicating that Terraform is initializing the backend and the provider plugins. A successful initialization will end with a success message.

Initializing the backend...

Initializing provider plugins...
- Finding hashicorp/local versions matching "2.4.0"...
- Installing hashicorp/local v2.4.0...
- Installed hashicorp/local v2.4.0 (signed by HashiCorp)

Terraform has created a lock file .terraform.lock.hcl to record the provider
selections it made above. Include this file in your version control repository
so that Terraform can guarantee to make the same selections by default when
you run "terraform init" in the future.

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 for Terraform,
rerun this command to reinitialize your working directory. If you forget, other
commands will detect it and remind you to do so if necessary.

Check .terraform directory for downloaded plugins

In this step, you will verify that terraform init has successfully downloaded the provider plugin. The command creates a hidden directory named .terraform in your project folder to store these plugins and other initialization data.

First, list all files and directories, including hidden ones, to see the new artifacts created by the init command.

ls -a

You should see the .terraform directory and a .terraform.lock.hcl file in the output. The lock file records the provider versions selected during initialization.

.  ..  main.tf  .terraform  .terraform.lock.hcl

Now, let's inspect the contents of the .terraform directory to see the downloaded provider. You can use the tree command for a clear, hierarchical view.

tree .terraform

The output will show the directory structure where the provider plugin is stored. You can see the executable file for the local provider downloaded from the registry.

.terraform
└── providers
    └── registry.terraform.io
        └── hashicorp
            └── local
                └── 2.4.0
                    └── linux_amd64
                        └── terraform-provider-local_v2.4.0_x5

6 directories, 1 file

This confirms that terraform init has successfully set up your project with the necessary provider.

Summary

Congratulations! You have successfully completed this lab on Terraform project initialization.

In this lab, you learned the essential first steps of starting a new Terraform project. You have practiced:

Creating a dedicated directory for a Terraform project.
Defining required providers in a main.tf configuration file.
Running the terraform init command to prepare the project.
Verifying that the provider plugins were downloaded into the .terraform directory.

With your project initialized, you are now ready to move on to the next steps in the Terraform workflow, such as writing resource definitions and using terraform plan and terraform apply to manage your infrastructure.

Terraform Project Initialization