arrow_back

Clean Up Unused IP Addresses

Join Sign in

Clean Up Unused IP Addresses

1 hour 5 Credits

GSP646

Google Cloud selp-paced labs logo

Overview

In this lab, you use Cloud Functions and Cloud Scheduler to identify and clean up wasted cloud resources. On Google Cloud, static IP addresses are a free resource when they’re attached to a load balancer or virtual machine (VM) instance. When a static IP address is reserved, but not used, it accumulates an hourly charge. In apps that heavily depend on static IP addresses and large-scale dynamic provisioning, this waste can become significant over time.

What you'll do

  • Create a Compute Engine VM with a static external IP address and a separate unused static external IP address

  • Deploy a Cloud Function to identify unused addresses

  • Create a Cloud Scheduler job to schedule the function to run by using an HTTP trigger

Architecture

The following diagram describes the architecture used in the first section of this lab, where you schedule a Cloud Function to identify and clean up unused IP addresses.

Architecture diagram

Setup and requirements

In this section, you configure the infrastructure and identities required to complete the lab.

Before you click the Start Lab button

Read these instructions. Labs are timed and you cannot pause them. The timer, which starts when you click Start Lab, shows how long Google Cloud resources will be made available to you.

This hands-on lab lets you do the lab activities yourself in a real cloud environment, not in a simulation or demo environment. It does so by giving you new, temporary credentials that you use to sign in and access Google Cloud for the duration of the lab.

To complete this lab, you need:

  • Access to a standard internet browser (Chrome browser recommended).
Note: Use an Incognito or private browser window to run this lab. This prevents any conflicts between your personal account and the Student account, which may cause extra charges incurred to your personal account.
  • Time to complete the lab---remember, once you start, you cannot pause a lab.
Note: If you already have your own personal Google Cloud account or project, do not use it for this lab to avoid extra charges to your account.

How to start your lab and sign in to the Google Cloud Console

  1. Click the Start Lab button. If you need to pay for the lab, a pop-up opens for you to select your payment method. On the left is the Lab Details panel with the following:

    • The Open Google Console button
    • Time remaining
    • The temporary credentials that you must use for this lab
    • Other information, if needed, to step through this lab
  2. Click Open Google Console. The lab spins up resources, and then opens another tab that shows the Sign in page.

    Tip: Arrange the tabs in separate windows, side-by-side.

    Note: If you see the Choose an account dialog, click Use Another Account.
  3. If necessary, copy the Username from the Lab Details panel and paste it into the Sign in dialog. Click Next.

  4. Copy the Password from the Lab Details panel and paste it into the Welcome dialog. Click Next.

    Important: You must use the credentials from the left panel. Do not use your Google Cloud Skills Boost credentials. Note: Using your own Google Cloud account for this lab may incur extra charges.
  5. Click through the subsequent pages:

    • Accept the terms and conditions.
    • Do not add recovery options or two-factor authentication (because this is a temporary account).
    • Do not sign up for free trials.

After a few moments, the Cloud Console opens in this tab.

Note: You can view the menu with a list of Google Cloud Products and Services by clicking the Navigation menu at the top-left. Navigation menu icon

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.

  2. Click Continue.

It takes a few moments to provision and connect to the environment. 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

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.

Task 1. Enable APIs and clone repository

  1. In Cloud Shell, enable the Cloud Scheduler API:

    gcloud services enable cloudscheduler.googleapis.com Note: It takes for a while to enable the Cloud Scheduler API.

Click Check my progress to verify the objective.

Enable the Cloud Scheduler API
  1. Clone the repository:

    git clone https://github.com/GoogleCloudPlatform/gcf-automated-resource-cleanup.git && cd gcf-automated-resource-cleanup/
  2. Set environment variables and make the repository folder your $WORKDIR where you run all commands related to this lab:

    export PROJECT_ID=$(gcloud config list --format 'value(core.project)' 2>/dev/null) export region=us-central1 WORKDIR=$(pwd)

Task 2. Create IP addresses

  1. In Cloud Shell, navigate to the unused-ip directory:

    cd $WORKDIR/unused-ip
  2. Export the names of the IP addresses as variables:

    export USED_IP=used-ip-address export UNUSED_IP=unused-ip-address
  3. Create two static IP addresses:

    gcloud compute addresses create $USED_IP --project=$PROJECT_ID --region=us-central1 gcloud compute addresses create $UNUSED_IP --project=$PROJECT_ID --region=us-central1

    This lab uses the us-central1 region, but you can choose a different region and refer to it consistently throughout the rest of the lab.

  4. Confirm that two addresses were created:

    gcloud compute addresses list --filter="region:(us-central1)"

    In the output, a status of RESERVED means that the IP addresses aren’t in use:

    NAME ADDRESS/RANGE TYPE PURPOSE NETWORK REGION SUBNET STATUS unused-ip-address 35.232.144.85 EXTERNAL us-central1 RESERVED used-ip-address 104.197.56.87 EXTERNAL us-central1 RESERVED

Click Check my progress to verify the objective.

Create two static IP addresses
  1. Set the used IP address as an environment variable:

    export USED_IP_ADDRESS=$(gcloud compute addresses describe $USED_IP --region=us-central1 --format=json | jq -r '.address')

Task 3. Create a VM

  1. In Cloud Shell, create an instance:

    gcloud compute instances create static-ip-instance \ --zone=us-central1-a \ --machine-type=n1-standard-1 \ --subnet=default \ --address=$USED_IP_ADDRESS

Click Check my progress to verify the objective.

Create an instance with static IP address created earlier.
  1. Confirm that one of the IP addresses is now in use:

    gcloud compute addresses list --filter="region:(us-central1)"

    The output is similar to the following:

    NAME ADDRESS/RANGE TYPE PURPOSE NETWORK REGION SUBNET STATUS unused-ip-address 35.232.144.85 EXTERNAL us-central1 RESERVED used-ip-address 104.197.56.87 EXTERNAL us-central1 IN_USE

Task 4. Review the Cloud Function code

  • In Cloud Shell, output the main section of the code:

    cat $WORKDIR/unused-ip/function.js | grep "const compute" -A 31

The output is as follows:

const compute = new Compute(); compute.getAddresses(function(err, addresses){ // gets all addresses across regions if(err){ console.log("there was an error: " + err); } if (addresses == null) { console.log("no addresses found"); return; } console.log("there are " + addresses.length + " addresses"); // iterate through addresses for (let item of addresses){ // get metadata for each address item.getMetadata(function(err, metadata, apiResponse) { // if the address is not used: if (metadata.status=='RESERVED'){ // compute age by convering ISO 8601 timestamps to Date var creationDate = new Date(metadata.creationTimestamp); var currDate = new Date(); var addressAge = Math.floor((currDate - creationDate)/86400e3);; // delete address item.delete(function(err, operation, apiResponse2){ if (err) { console.log("could not delete address: " + err); } }) }

In the preceding code sample, the following is important:

  • compute.getAddresses(function(err, addresses) uses the getAddresses method to retrieve IP addresses across all regions in the project.

  • item.getMetadata(function(err, metadata, apiResponse) gets the metadata for each IP address and checks its STATUS field.

  • if ((metadata.status=='RESERVED') & (calculateAge(metadata.creationTimestamp) >= ageToDelete)){ checks whether the IP address is in use, calculates its age by using a helper function, and compares its age against a constant (set to 0 for the purposes of the lab).

  • item.delete(function(err, operation, apiResponse2){ deletes the IP address.

Task 5. Deploy the Cloud Function

  1. In Cloud Shell, deploy the Cloud Function:

    gcloud functions deploy unused_ip_function --trigger-http --runtime=nodejs8 Note: If you get an error, wait a minute and try again.
    • If prompted, enter y to allow unauthenticated invocations.
    Note: Deploying a cloud function can take 2-5 minutes, depending on region.

Click Check my progress to verify the objective.

Deploy cloud function
  1. Set the trigger URL as an environment variable:

    export FUNCTION_URL=$(gcloud functions describe unused_ip_function --format=json | jq -r '.httpsTrigger.url')

Task 6. Schedule and test the Cloud Function

  1. In Cloud Shell, create an App Engine app to use Cloud Scheduler:

    gcloud app create --region us-central
  2. In Cloud Shell, create a Cloud Scheduler task to run the Cloud Function at 2 AM every night:

    gcloud scheduler jobs create http unused-ip-job \ --schedule="* 2 * * *" \ --uri=$FUNCTION_URL
    • When prompted, enter Y to create and App Engine app in your project, enter the respective numeric choice to deploy the application in us-central1, and then click Enter.

Click Check my progress to verify the objective.

Create App Engine Application
  1. Test the job by manually triggering it:

    gcloud scheduler jobs run unused-ip-job
  2. If you get a similar message:

    There is no App Engine app in project [qwiklabs-gcp-00-6384ad453ae0]. Would you like to create one (Y/n)?

    Hold CTRL+Z, wait a moment, and try running the command again. (You should receive no output.)

Click Check my progress to verify the objective.

Run a cloud schedular job
  1. Confirm that the unused IP address was deleted:

    gcloud compute addresses list --filter="region:(us-central1)"

The output is similar to the following:

NAME ADDRESS/RANGE TYPE PURPOSE NETWORK REGION SUBNET STATUS used-ip-address 104.197.56.87 EXTERNAL us-central1 IN_USE

Click Check my progress to verify the objective.

Confirm the deletion of unused IP address

Congratulations!

In this lab you completed the following tasks:

  • Created a Compute Engine VM with a static external IP address and a separate unused static external IP address

  • Deployed a Cloud Function to identify unused addresses

  • Created a Cloud Scheduler job to schedule the function to run by using an HTTP trigger

Finish your quest

This self-paced lab is part of the Qwiklabs Optimizing your Google Cloud Costs quest. A quest is a series of related labs that form a learning path. Completing this quest earns you a badge to recognize your achievement. You can make your badge or badges public and link to them in your online resume or social media account. Enroll in this Quest and get immediate completion credit. See the Google Cloud Skills Boost catalog to see all available quests.

Take your next lab

Continue your Quest with Optimizing Costs with Cloud Storage or check out these suggestions:

Google Cloud training and certification

...helps you make the most of Google Cloud technologies. Our classes include technical skills and best practices to help you get up to speed quickly and continue your learning journey. We offer fundamental to advanced level training, with on-demand, live, and virtual options to suit your busy schedule. Certifications help you validate and prove your skill and expertise in Google Cloud technologies.

Manual Last Updated July 19, 2022

Lab Last Tested December 20, 2022

Copyright 2022 Google LLC All rights reserved. Google and the Google logo are trademarks of Google LLC. All other company and product names may be trademarks of the respective companies with which they are associated.