Provision infrastructure with Cloud-Init

5min
|
Terraform

When you create a generic compute resource in Terraform, your virtual machine (VM) may not have much capability because it is a "fresh" install and needs to be provisioned with the software you want to use. Manually installing the necessary software and its respective dependencies on each VM is time consuming and difficult to maintain at scale.

cloud-init is a standard configuration support tool available on most Linux distributions and all major cloud providers. cloud-init allows you to pass a shell script to your instance that installs or configures the machine to your specifications.

In this tutorial, you will create a Terraform instance with the user_data to deploy a Go web app and SSH key to the newly created device, allowing you to SSH into the machine without a password and start the app with that user.

Prerequisites

For this tutorial, you will need the following:

Terraform v1.1+ installed locally.
An AWS account

Clone the example repository here.

$ git clone -b cloudinit https://github.com/hashicorp/learn-terraform-provisioning

Change into your cloned repo directory.

$ cd learn-terraform-provisioning

Create a local SSH key

For this tutorial, create a local SSH key to pair with the new terraform user you create on this instance.

Generate a new SSH key in your terminal called tf-cloud-init. The argument provided with the -f flag creates the key in the current directory and creates two files called tf-cloud-init and tf-cloud-init.pub. Change the placeholder email address to your email address.

$ ssh-keygen -t rsa -C "your_email@example.com" -f ./tf-cloud-init

When prompted, press enter to leave the passphrase blank on this key.

Add your public SSH key to your cloud-init script

Open the scripts/add-ssh-web-app.yaml file and paste the contents of tf-cloud-init.pub into the user data ssh_authorized_keys section. You will pass this cloud-init script to your instance resource's user_data attribute.

##...
users:
  - default
  - name: terraform
    gecos: terraform
    primary_group: hashicorp
    sudo: ALL=(ALL) NOPASSWD:ALL
    groups: users, admin
    ssh_import_id:
    lock_passwd: false
    ssh_authorized_keys:
      -  # Paste your created SSH key here
##...

For more information on creating a cloud-init script, refer to the cloud-init documentation.

Review the cloud-init script in the Terraform configuration

Open the main.tf file located in the instances directory. Notice how the file function loads the contents of the add-ssh-web-app.yaml file. Then, the configuration passes the contents of the file into aws_instance.web as a user_data value to be initialized when the instance is created.

main.tf

resource "aws_instance" "web" {
  ami                         = data.aws_ami.ubuntu.id
  instance_type               = "t2.micro"
  subnet_id                   = aws_subnet.subnet_public.id
  vpc_security_group_ids      = [aws_security_group.sg_22_80.id]
  associate_public_ip_address = true
  user_data                   = file("../scripts/add-ssh-web-app.yaml")

  tags = {
    Name = "Learn-CloudInit"
  }
}

Next, change into the directory containing your configuration.

$ cd instances

Initialize your configuration.

$ terraform init

Apply your configuration. Enter yes when prompted to create your instance.

$ terraform apply

When the apply run completes, your terminal will display your instance's IP address.

You have successfully provisioned your AWS instance with cloud-init. This instance should already be configured with the SSH key, allowing you to connect to it. Your instance should also contain the GoLang demo app.

In the next section, you will SSH into this instance with your local key and start the demo app.

Verify your instance

Connect to your instance via SSH by piping the aws_instance.web.public_ip resource attribute to the terraform console command.

Note

Cloud-Init runs after the instance is provisioned, and may take a few minutes to complete. If you receive a "Connection refused" or similar error from the next few commands, wait a few minutes and try again.

$ ssh terraform@$(terraform output -raw public_ip) -i ../tf-cloud-init
The authenticity of host '54.196.121.30 (54.196.121.30)' can't be established.
ED25519 key fingerprint is SHA256:wCXmWHhTiGwmZ0V2IhNMXgEwx/lSyDRH7JHMHrT8Jb4.
This key is not known by any other names.
Are you sure you want to continue connecting (yes/no/[fingerprint])? yes
Warning: Permanently added '54.196.121.30' (ED25519) to the list of known hosts.
Welcome to Ubuntu 24.04 LTS (GNU/Linux 6.8.0-1008-aws x86_64)
##...
terraform@ip-10-1-0-100:~$

Respond to the confirmation prompt with a yes, and SSH will connect to the instance.

Now you have SSH access to your AWS instances without creating SSH keys in AWS. This is useful if your organization maintains keypairs outside of AWS.

While still connected to the instance, launch the demo application.

$ ~/go/bin/learn-go-webapp-demo
54.196.121.30

Note

The application will print out your instance's public IP address and continue running. Press Ctrl-C to exit the application.

In your web browser, navigate to the IP address of your instance and port 8080 to see the app you deployed.

Destroy your image

Avoid unnecessary charges in your AWS account by destroying your instance in Terraform.

$ terraform destroy

Type yes when you are prompted in your terminal to delete your infrastructure.

Next Steps

In this tutorial, you deployed a webapp and configured an instance with cloud-init.

To learn about creating images with Packer for Terraform deployments, check out the Provision Infrastructure with Packer tutorial.
For more information about creating templates with cloud-init, visit the data provider documentation.

Collection Overview

Provision

Packer