Repository files navigation

This modules makes it easy to set up a scheduled job to trigger events/run functions.

This module is meant for use with Terraform v1.3+ and tested using Terraform v1.10+.If you haven'tupgraded and need a Terraform0.12.x-compatible version of this module, the last released versionintended for Terraform 0.12.x isv1.6.0.

You can go to the examples folder, however the usage of the module could be like this in your own main.tf file:

module"scheduled-function" {source="terraform-google-modules/scheduled-function/google"version="0.1.0"project_id="<PROJECT ID>"job_name="<NAME_OF_JOB>"job_schedule="<CRON_SYNTAX_SCHEDULE>"function_entry_point="<NAME_OF_FUNCTION>"function_source_directory="<DIRECTORY_OF_FUNCTION_SOURCE>"function_name="<RESOURCE_NAMES>"region="<REGION>"}

Then perform the following commands on the root folder:

• terraform init to get the plugins
• terraform plan to see the infrastructure plan
• terraform apply to apply the infrastructure build
• terraform destroy to destroy the built infrastructure

list(object({
    filename = string
    id       = string
  }))

These sections describe requirements for using this module.

The following dependencies must be available:

• Terraform >= 1.3
• Terraform Provider for GCP plugin v4.23

Note that this module requires App Engine being configured in the specified project/region.This is because Google Cloud Scheduler is dependent on the project being configured with App Engine.Refer to theGoogle Cloud Scheduler documentationinformation on the App Engine dependency.

The recommended way to create projects with App Engine enabled is via theProject Factory module.There is an example of how to create the projectwithin that module

A service account with the following roles must be used to provisionthe resources of this module:

• Storage Admin:roles/storage.admin
• PubSub Editor:roles/pubsub.editor
• Cloudscheduler Admin:roles/cloudscheduler.admin
• Cloudfunctions Developer:roles/cloudfunctions.developer
• IAM ServiceAccount User:roles/iam.serviceAccountUser

TheProject Factory module and theIAM module may be used in combination to provision aservice account with the necessary roles applied.

A project with the following APIs enabled must be used to host theresources of this module:

• Cloud Scheduler API:cloudscheduler.googleapis.com
• Cloud PubSub API:pubsub.googleapis.com
• Cloud Functions API:cloudfunctions.googleapis.com
• Cloud Build API:cloudbuild.googleapis.com
• App Engine Admin API:appengine.googleapis.com

TheProject Factory module can be used toprovision a project with the necessary APIs enabled.

Refer to thecontribution guidelines forinformation on contributing to this module.