Terraform Essentials: Google Compute Engine Instance - gem-terraform-gce-create

David NguyenDavid Nguyen
5 min read

Activate Cloud Shell

Cloud Shell is a virtual machine that is loaded with development tools. It offers a persistent 5GB home directory and runs on the Google Cloud. Cloud Shell provides command-line access to your Google Cloud resources.

  1. Click Activate Cloud Shell

    Activate Cloud Shell icon

    at the top of the Google Cloud console.

When you are connected, you are already authenticated, and the project is set to your PROJECT_ID. The output contains a line that declares the PROJECT_ID for this session:

Your Cloud Platform project in this session is set to YOUR_PROJECT_ID

gcloud is the command-line tool for Google Cloud. It comes pre-installed on Cloud Shell and supports tab-completion.

  1. (Optional) You can list the active account name with this command:
gcloud auth list
  1. Click Authorize.

  2. Your output should now look like this:

Output:

ACTIVE: *
ACCOUNT: student-01-xxxxxxxxxxxx@qwiklabs.net

To set the active account, run:
    $ gcloud config set account `ACCOUNT`
  1. (Optional) You can list the project ID with this command:
gcloud config list project

Output:

[core]
project = <project_ID>

Example output:

[core]
project = qwiklabs-gcp-44776a13dea667a6

Note: For full documentation of gcloud, in Google Cloud, refer to the gcloud CLI overview guide.

Overview

This lab demonstrates how to use Terraform to create a Google Compute Engine (GCE) instance. You will define your infrastructure as code, allowing you to easily provision and manage your resources. This lab assumes you have basic knowledge of Google Cloud and Terraform.

Task 1. Prerequisites

Before you begin, ensure you have the following:

  1. A Google Cloud project with billing enabled. You will need the Project ID for subsequent steps. The project ID will be: qwiklabs-gcp-03-0bdcdbb5d2fc

     Your Project ID is: qwiklabs-gcp-03-0bdcdbb5d2fc
    

    Note:
    Make note of this ID; you will need it in the next steps.

  2. Terraform installed on your local machine or in Cloud Shell. If using Cloud Shell, Terraform is pre-installed.

     terraform version
    

    Note:
    Verify Terraform is installed.

  3. The Google Cloud SDK (gcloud) installed and configured. If using Cloud Shell, gcloud is pre-installed and authenticated.

     gcloud version
    

    Note:
    Verify gcloud is installed.

  4. Authenticate to your Google Cloud project. In Cloud Shell, this might be done automatically.

     gcloud auth login
    

    Note:
    Authenticate gcloud to access your Google Cloud resources.

  5. Set your Project ID to be: qwiklabs-gcp-03-0bdcdbb5d2fc

     gcloud config set project qwiklabs-gcp-03-0bdcdbb5d2fc
    

    Note:
    Set the current project.

Task 2. Create a Cloud Storage Bucket for Terraform State

Terraform uses a state file to track the resources it manages. For collaborative projects and increased reliability, it's best to store this state remotely in a Cloud Storage bucket.

  1. Create a Cloud Storage bucket. The bucket name must be globally unique and should include your project ID as a prefix.

     gsutil mb -l us-central1 gs://qwiklabs-gcp-03-0bdcdbb5d2fc-tf-state
    

    Note:
    Create the Cloud Storage bucket to store Terraform state.

  2. Enable versioning on the bucket. This allows you to revert to previous states if necessary.

     gsutil versioning set on gs://qwiklabs-gcp-03-0bdcdbb5d2fc-tf-state
    

    Note:
    Enable versioning for state file history.

Task 3. Create Terraform Configuration Files

Now, you will create the Terraform configuration files that define your GCE instance.

  1. Create a file named main.tf with the following content:

     terraform {
       required_providers {
         google = {
           source  = "hashicorp/google"
           version = "~> 4.0"
         }
       }
       backend "gcs" {
         bucket = "qwiklabs-gcp-03-0bdcdbb5d2fc-tf-state"
         prefix = "terraform/state"
       }
     }
    
     provider "google" {
       project = var.project_id
       region  = var.region
     }
    
     resource "google_compute_instance" "default" {
       name         = "terraform-instance"
       machine_type = "e2-micro"
       zone         = var.zone
    
       boot_disk {
         initialize_params {
           image = "debian-cloud/debian-12"
         }
       }
    
       network_interface {
         subnetwork = "default"
    
         access_config {
         }
       }
     }
    

    Note:
    This file defines the Terraform provider, backend, and the GCE instance resource. A variables.tf configuration will be used to define the PROJECT_ID and REGION.

  2. Create a file named variables.tf (optional, but recommended for defining variables):

     variable "project_id" {
       type        = string
       description = "The ID of the Google Cloud project"
       default = "qwiklabs-gcp-03-0bdcdbb5d2fc"
     }
    
     variable "region" {
       type        = string
       description = "The region to deploy resources in"
       default     = "us-central1"
     }
    
     variable "zone" {
       type        = string
       description = "The zone to deploy resources in"
       default     = "us-central1-c"
     }
    

    Note:
    This file defines variables for your project ID, region, and zone. Note that it contains defaults.

Task 4. Initialize, Plan, and Apply Terraform

With the configuration files created, you can now initialize, plan, and apply your Terraform configuration.

  1. Initialize Terraform. This downloads the necessary provider plugins.

     terraform init
    

    Note:
    Initialize Terraform to download plugins.

  2. Plan the changes. This shows you what Terraform will do before it makes any actual changes.

     terraform plan
    

    Note:
    Review the planned changes.

  3. Apply the changes. This creates the GCE instance.

     terraform apply -auto-approve
    

    Note:
    Apply the Terraform configuration to create the instance. The -auto-approve flag automatically approves the changes. Be cautious when using this flag in production environments.

Task 5. Verify the Instance

Once Terraform has finished, verify that the GCE instance has been created.

  1. In the Google Cloud Console, navigate to Compute Engine > VM instances. You should see an instance named 'terraform-instance'.

  2. Alternatively, use the gcloud command to list instances.

     gcloud compute instances list
    

    Note:
    Verify the instance using the gcloud CLI.

Task 6. Destroy the Infrastructure

When you are finished, destroy the infrastructure to avoid incurring unnecessary costs.

  1. Destroy the resources created by Terraform.

     terraform destroy -auto-approve
    

    Note:
    Destroy the resources created by Terraform.


Solution of Lab

curl -LO raw.githubusercontent.com/ePlus-DEV/storage/refs/heads/main/labs/gem-terraform-gce-create/lab.sh
sudo chmod +x lab.sh
./lab.sh

Script alternative

curl -LO raw.githubusercontent.com/quiccklabs/Labs_solutions/refs/heads/master/Terraform%20Essentials%20Google%20Compute%20Engine%20Instance/quicklab.sh
sudo chmod +x quicklab.sh
./quicklab.sh
0
Subscribe to my newsletter

Read articles from David Nguyen directly inside your inbox. Subscribe to the newsletter, and don't miss out.

Written by

David Nguyen
David Nguyen

A passionate full-stack developer from @ePlus.DEV