This module configures a system which responds to events by invoking a Cloud Functions function.

The root module configures a function sourced from a directory on localhost to respond to a given event trigger. The source directory is compressed and uploaded as a Cloud Storage bucket object which will be leveraged by the function.

Alternatively, the repository-function submodule configures a function sourced from a Cloud Source Repositories repository.

This module is meant for use with Terraform 0.13+ and tested using Terraform 1.0+. If you find incompatibilities using Terraform >=0.13, please open an issue.

If you haven't upgraded and need a Terraform 0.12.x-compatible version of this module, the last released version intended for Terraform 0.12.x is v1.6.0.

The automatic-labelling-from-localhost example is a tested reference of how to use the root module with the event-project-log-entry submodule.

If you have local_file Terraform resources that need to be included in the function's archive include them in the optional source_dependent_files.

This will tell the module to wait until those files exist before creating the archive.

Example can also be seen in examples/dynamic-files

resource "local_file" "file" {
  content  = "some content"
  filename = "${path.module}/function_source/terraform_created_file.txt"
}

module "localhost_function" {
  ...

  source_dependent_files = [local_file.file]
}

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

The following sections describe the requirements which must be met in order to invoke this module.

The following software dependencies must be installed on the system from which this module will be invoked:

• Terraform >= 0.13.0
• [Terraform Provider for Archive][terraform-provider-archive-site]
• Terraform Provider for Google Cloud Platform

The Service Account which will be used to invoke this module must have the following IAM roles:

• Cloud Functions Developer: roles/cloudfunctions.developer
• Storage Admin: roles/storage.admin
• Secret Manager Accessor: roles/secretmanager.secretAccessor

The project against which this module will be invoked must have the following APIs enabled:

• Cloud Functions API: cloudfunctions.googleapis.com
• Cloud Storage API: storage-component.googleapis.com
• Secret Manager API: secretmanager.googleapis.com

The Project Factory module can be used to provision projects with specific APIs activated.

Refer to the contribution guidelines for information on contributing to this module.