File provisioner in Terraform - Commands & Configuration

Introduction

Sometimes you need to copy files from your computer to a server when creating infrastructure. The file provisioner in Terraform helps you do this automatically during resource creation.

When you want to copy a configuration file to a new virtual machine during setup.

When you need to upload a script to a server to run later.

When you want to place a certificate or key file on a remote machine securely.

When you want to automate copying files instead of doing it manually after deployment.

When you want to ensure files are present on a server as part of your infrastructure code.

Config File - main.tf

main.tf

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

resource "aws_instance" "example" {
  ami           = "ami-0c55b159cbfafe1f0"
  instance_type = "t2.micro"

  connection {
    type        = "ssh"
    user        = "ec2-user"
    private_key = file("~/.ssh/id_rsa")
    host        = self.public_ip
  }

  provisioner "file" {
    source      = "app.conf"
    destination = "/tmp/app.conf"
  }

  provisioner "remote-exec" {
    inline = ["cat /tmp/app.conf"]
  }
}

This Terraform file creates an AWS EC2 instance.

The file provisioner copies a local file named app.conf to the remote instance at /tmp/app.conf.

The remote-exec provisioner runs a command on the instance to show the copied file content.

The connection block defines how Terraform connects to the instance using SSH.

Commands

This command initializes Terraform in the current directory. It downloads the AWS provider plugin needed to create resources.

Terminal

terraform init

Expected Output

Initializing the backend...



Initializing provider plugins...

- Finding latest version of hashicorp/aws...

- 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 required for your infrastructure.

This command creates the AWS EC2 instance and copies the file using the file provisioner automatically without asking for confirmation.

Terminal

terraform apply -auto-approve

Expected Output

aws_instance.example: Creating...

aws_instance.example: Still creating... [10s elapsed]

aws_instance.example: Creation complete after 20s [id=i-0abcd1234efgh5678]



Apply complete! Resources: 1 added, 0 changed, 0 destroyed.

→

-auto-approve - Skips the interactive approval prompt to apply changes immediately.

This command removes the created EC2 instance and cleans up all resources automatically.

Terminal

terraform destroy -auto-approve

Expected Output

aws_instance.example: Refreshing state... [id=i-0abcd1234efgh5678]



aws_instance.example: Destroying... [id=i-0abcd1234efgh5678]

aws_instance.example: Destruction complete after 10s



Destroy complete! Resources: 1 destroyed.

→

-auto-approve - Skips the confirmation prompt to destroy resources immediately.

Key Concept

If you remember nothing else from this pattern, remember: the file provisioner copies files from your computer to a remote machine during resource creation to automate setup.

Common Mistakes

Not defining the connection block when using the file provisioner.

Terraform needs connection details like SSH user and key to copy files; without it, the provisioner fails.

Always include a connection block with correct SSH details when using file or remote-exec provisioners.

Using a local file path that does not exist or is incorrect in the source field.

Terraform cannot find the file to copy, causing the apply to fail.

Ensure the source file path is correct and the file exists before running terraform apply.

Expecting the file provisioner to update files on existing resources without recreating them.

Provisioners run only during resource creation or replacement, so changes to files won't apply on existing resources.

To update files, recreate the resource or use configuration management tools after deployment.

Summary

Use terraform init to prepare Terraform and download providers.

Use the file provisioner inside a resource to copy files from local to remote during creation.

Use terraform apply to create resources and copy files automatically.

Always define connection details for SSH access when using file provisioner.

Use terraform destroy to clean up resources when done.

Practice

1. What is the main purpose of the file provisioner in Terraform?

easy

A. To execute shell commands on a remote server

B. To destroy resources after use

C. To create new cloud resources like virtual machines

D. To copy files from your local machine to a remote server during resource creation

Solution

1. Step 1: Understand the role of the file provisioner

   The file provisioner is designed to transfer files from your local computer to a remote machine during Terraform resource setup.

2. Step 2: Differentiate from other provisioners

   Unlike remote-exec which runs commands, file provisioner only copies files, not executes commands or manages resource lifecycle.

3. Final Answer:

   To copy files from your local machine to a remote server during resource creation -> Option D

4. Quick Check:

   File provisioner copies files = B [OK]

Hint: File provisioner = copy files to server [OK]

Common Mistakes:

• Confusing file provisioner with remote-exec
• Thinking it creates or destroys resources
• Assuming it runs commands on the server

2. Which of the following is the correct syntax to use the file provisioner in a Terraform resource block?

easy

A. provisioner file { source = "./app.conf" destination = "/etc/app.conf" }

B. provisioner "file" { source = "./app.conf" destination = "/etc/app.conf" }

C. provisioner "copy" { src = "./app.conf" dest = "/etc/app.conf" }

D. provisioner "file" { src = "./app.conf" dst = "/etc/app.conf" }

Solution

1. Step 1: Recall correct provisioner block syntax

   The provisioner block requires the provisioner type in quotes, e.g., "file", and uses source and destination keys.

2. Step 2: Identify correct attribute names

   The file provisioner uses source and destination, not src/dest or unquoted provisioner type.

3. Final Answer:

   provisioner "file" { source = "./app.conf" destination = "/etc/app.conf" } -> Option B

4. Quick Check:

   Use quotes and source/destination keys = A [OK]

Hint: Use quotes and source/destination keys for file provisioner [OK]

Common Mistakes:

• Omitting quotes around provisioner type
• Using incorrect attribute names like src/dest
• Using wrong provisioner type like "copy"

3. Given this Terraform snippet inside a resource:

provisioner "file" {
  source      = "./setup.sh"
  destination = "/tmp/setup.sh"
}
provisioner "remote-exec" {
  inline = ["chmod +x /tmp/setup.sh", "/tmp/setup.sh"]
}

What will happen after Terraform applies this resource?

medium

A. The setup.sh script is copied to /tmp and then executed with execute permission

B. The setup.sh script is copied but not executed

C. Terraform will fail because file and remote-exec cannot be used together

D. The script is executed locally but not copied to the server

Solution

1. Step 1: Understand file provisioner behavior

   The file provisioner copies the local file setup.sh to the remote path /tmp/setup.sh.

2. Step 2: Understand remote-exec provisioner behavior

   The remote-exec provisioner runs commands on the remote server, here changing permissions and executing the script.

3. Final Answer:

   The setup.sh script is copied to /tmp and then executed with execute permission -> Option A

4. Quick Check:

   File copies + remote-exec runs commands = A [OK]

Hint: File copies, remote-exec runs commands after [OK]

Common Mistakes:

• Thinking file provisioner runs commands
• Believing file and remote-exec cannot be combined
• Assuming script runs locally instead of remotely

4. You wrote this provisioner block:

provisioner "file" {
  source = "./config.yaml"
  destination = "/etc/config.yaml"
  connection {
    type     = "ssh"
    user     = "ubuntu"
    password = "mypassword"
  }
}

Terraform apply fails with a connection error. What is the most likely cause?

medium

A. The destination path must be a directory, not a file

B. The password authentication is not supported; use private_key instead

C. The connection block is inside the provisioner block, but it should be at the resource level

D. The source file path is incorrect

Solution

1. Step 1: Check connection block placement

   In Terraform, the connection block must be defined at the resource level, not inside the provisioner block.

2. Step 2: Understand connection block scope

   Placing connection inside provisioner causes Terraform to not find connection details, leading to connection errors.

3. Final Answer:

   The connection block is inside the provisioner block, but it should be at the resource level -> Option C

4. Quick Check:

   Connection block at resource level, not inside provisioner = D [OK]

Hint: Place connection block outside provisioner, inside resource [OK]

Common Mistakes:

• Putting connection block inside provisioner
• Assuming password auth is always unsupported
• Mistaking file path or destination format as cause

5. You want to copy multiple files from your local ./scripts folder to the remote server's /usr/local/bin directory using the file provisioner. Which approach is best to achieve this efficiently?

hard

A. Use a single file provisioner with source = "./scripts" and destination = "/usr/local/bin" to copy the whole folder

B. Write multiple file provisioner blocks, one for each file inside ./scripts

C. Compress the folder into a zip file, copy it with file provisioner, then unzip remotely with remote-exec

D. Use a remote-exec provisioner to download files from a public URL instead

Solution

1. Step 1: Understand file provisioner folder copying

   The file provisioner natively supports copying entire folders recursively by specifying a folder as source and a directory as destination.

2. Step 2: Differentiate efficiency of approaches

   Use a single file provisioner with source = "./scripts" and destination = "/usr/local/bin" to copy the whole folder directly copies the directory contents to /usr/local/bin efficiently without extra compression or multiple blocks.

3. Final Answer:

   Use a single file provisioner with source = "./scripts" and destination = "/usr/local/bin" to copy the whole folder -> Option A

4. Quick Check:

   File provisioner copies dir recursively = A [OK]

Hint: File provisioner copies dir recursively with source=dir destination=dir [OK]

Common Mistakes:

• Thinking file provisioner cannot copy folders recursively
• Using multiple provisioner blocks unnecessarily
• Resorting to compression when direct recursive copy works