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

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>"
  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

• Terraform 0.11.x
• terraform-provider-google plugin v2.1

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 the Google Cloud Scheduler documentation for more information on the App Engine dependency.

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

In order to execute this module you must have a Service Account with the following roles.

• roles/storage.admin
• roles/pubsub.editor
• roles/cloudscheduler.admin
• roles/cloudfunctions.developer
• roles/iam.serviceAccountUser

In order to operate with the Service Account you must activate the following API on the project where the Service Account was created:

• Cloud Scheduler API - cloudscheduler.googleapis.com
• Cloud PubSub API - pubsub.googleapis.com
• Cloud Functions API - cloudfunctions.googleapis.com

Be sure you have the correct Terraform version (0.11.x), you can choose the binary here:

• https://releases.hashicorp.com/terraform/

• docker
• terraform-docs 0.6.0

It is recommended to to run the integration tests via docker. To do so, run make test_integration_docker. In containers, this will

• Perform terraform init command
• Perform terraform get command
• Perform terraform validate command
• Perform terraform apply -auto-approve command and check that it has created the appropriate resources
• Perform terraform destroy -force command and check that it has destroyed the appropriate resources

Run

make generate_docs

The makefile in this project will lint or sometimes just format any shell, Python, golang, Terraform, or Dockerfiles. The linters will only be run if the makefile finds files with the appropriate file extension.

All of the linter checks are in the default make target, so you just have to run

make -s

The -s is for 'silent'. Successful output looks like this

Running shellcheck
Running flake8
Running gofmt
Running terraform validate
Running hadolint on Dockerfiles
Test passed - Verified all file Apache 2 headers

The linters are as follows:

• Shell - shellcheck. Can be found in homebrew
• Python - flake8. Can be installed with 'pip install flake8'
• Golang - gofmt. gofmt comes with the standard golang installation. golang is a compiled language so there is no standard linter.
• Terraform - terraform has a built-in linter in the 'terraform validate' command.
• Dockerfiles - hadolint. Can be found in homebrew