Skip to content

Latest commit

 

History

History
81 lines (54 loc) · 3.69 KB

README.md

File metadata and controls

81 lines (54 loc) · 3.69 KB
Raw

gcpvmsnap

Google App Engine Node.js project that creates periodic (cron-based) snapshots of VM's persistent disks. Periodic purges of old snapshots is also supported.

Cloud Run is another deployment option in conjunction with Cloud Scheduler, which would need to be set up manually.

Note: This project was initially created in 2018 when scheduled snapshots were not natively avalable in GCP. Now this capability is provided natively (see Creating scheduled snapshots for persistent disk). As such, this project is no longer relevant. I keep it as an example of how App Engine or Cloud Run can be used in conjunction with Cloud Scheduler to automate tasks using GCP's Cloud SDK.

Description

cron.yaml is used to set the cron schedule. Documentation can be found here.

/create_snapshots can take a "tag" query parameter

  • If ommitted, all VMs in the project are processed
  • If included, only VMs with custom metadata defined with an entry with key="gcpvmsnapfilter" and value equal to value passed in "tag" query parameter

The snapshots will have the following name convention: s-{GCP Instance Id}-{Source Disk Name}-{yyyyMMddHHmmss} Note: If the disk name is longer than 24 characters, only the first 24 characters will be used in order to fall within the 62 character limit for snapshot names.

Examples:

  • /create_snapshots - all VMs will be processed
  • /create_snapshots?tag=backup - only VMs with a custom metadata entry with key and value of "gcpvmsnapfilter" and "backup" respectively will be processed

/purge_snapshots can take a "days" query parameter

  • If ommitted, snapshots older than 7 days are purged. Snapshots are tested against the following regex expression to ensure only snapshots created by this tool are affected: /s-\d+-.{1,24}-\d{14}/
  • If included, only snapshots (that meet the regex expression) that are older than "days" are purged

Examples:

  • /purge_snapshots - purges snapshots older than 7 days
  • /purge_snapshots?days=2 - purges snapshots older than 2 days

Prerequisites

  • Access to a Google Cloud Platform (GCP) project with sufficient permissions to deploy to Google App Engine Flexible Environment and/or Cloud Run.

  • Google Cloud SDK.

Installing

  • Download project

  • Modify cron.yaml according to your needs (only if using App Engine)

  • Optionally tag your VMs according to your needs

To deploy to App Engine (GAE):

gcloud app deploy

To deploy or modify the App Engine schedule (deploys only cron.yaml):

gcloud app deploy cron.yaml

To deploy to Cloud Run:

gcloud run deploy --source . --set-env-vars=HTTP_HEADER=X-CloudScheduler

Notes:

  • When you are prompted for the service name, press Enter to accept the default name, gcpvmsnap
  • If you are prompted to enable the Artifact Registry API, respond by pressing y.
  • When you are prompted for region: select the region of your choice.
  • You will be prompted to allow unauthenticated invocations: respond y. The existence of the 'X-CloudScheduler' HTTP header will be checked to ensure only requests from Cloud Scheduler are allowed.
  • Cloud Scheduler can be used as the scheduling engine and needs to be set up manually.

Testing

All testing artifacts are in the ./test directory.

Mocha, Chai and Mockery are used for unit testing (access to Google Cloud is mocked).

Included curl-based shell scripts can be used for local integration testing (accessing Google Cloud).

Included Google Cloud SDK-based shell scripts can be used to prepare an environment for end-to-end testing.

License

This project is licensed under the Apache 2.0 license.

Enjoy!