2020-06-28 23:05:44 -07:00
# Cloud Function Module
Cloud Function management, with support for IAM roles and optional bucket creation.
The GCS object used for deployment uses a hash of the bundle zip contents in its name, which ensures change tracking and avoids recreating the function if the GCS object is deleted and needs recreating.
## TODO
- [ ] add support for `source_repository`
## Examples
### HTTP trigger
This deploys a Cloud Function with an HTTP endpoint, using a pre-existing GCS bucket for deployment, setting the service account to the Cloud Function default one, and delegating access control to the containing project.
```hcl
module "cf-http" {
2020-11-07 01:28:33 -08:00
source = "./modules/cloud-function"
2020-06-28 23:05:44 -07:00
project_id = "my-project"
name = "test-cf-http"
bucket_name = "test-cf-bundles"
bundle_config = {
2021-11-07 01:46:22 -08:00
source_dir = "my-cf-source-folder"
output_path = "bundle.zip"
excludes = null
2020-06-28 23:05:44 -07:00
}
}
2020-11-07 01:28:33 -08:00
# tftest:skip
2020-06-28 23:05:44 -07:00
```
2020-07-04 01:04:53 -07:00
### PubSub and non-HTTP triggers
2020-06-28 23:05:44 -07:00
Other trigger types other than HTTP are configured via the `trigger_config` variable. This example shows a PubSub trigger.
```hcl
module "cf-http" {
2020-11-07 01:28:33 -08:00
source = "./modules/cloud-function"
2020-06-28 23:05:44 -07:00
project_id = "my-project"
name = "test-cf-http"
bucket_name = "test-cf-bundles"
bundle_config = {
2021-11-07 01:46:22 -08:00
source_dir = "my-cf-source-folder"
output_path = "bundle.zip"
excludes = null
2020-06-28 23:05:44 -07:00
}
trigger_config = {
event = "google.pubsub.topic.publish"
resource = local.my-topic
retry = null
}
}
2020-11-07 01:28:33 -08:00
# tftest:skip
2020-06-28 23:05:44 -07:00
```
### Controlling HTTP access
To allow anonymous access to the function, grant the `roles/cloudfunctions.invoker` role to the special `allUsers` identifier. Use specific identities (service accounts, groups, etc.) instead of `allUsers` to only allow selective access.
```hcl
module "cf-http" {
2020-11-07 01:28:33 -08:00
source = "./modules/cloud-function"
2020-06-28 23:05:44 -07:00
project_id = "my-project"
name = "test-cf-http"
bucket_name = "test-cf-bundles"
bundle_config = {
2021-11-07 01:46:22 -08:00
source_dir = "my-cf-source-folder"
output_path = "bundle.zip"
excludes = null
2020-06-28 23:05:44 -07:00
}
2020-11-05 23:37:44 -08:00
iam = {
2020-06-28 23:05:44 -07:00
"roles/cloudfunctions.invoker" = ["allUsers"]
}
}
2020-11-07 01:28:33 -08:00
# tftest:skip
2020-06-28 23:05:44 -07:00
```
### GCS bucket creation
You can have the module auto-create the GCS bucket used for deployment via the `bucket_config` variable. Setting `bucket_config.location` to `null` will also use the function region for GCS.
```hcl
module "cf-http" {
2020-11-07 01:28:33 -08:00
source = "./modules/cloud-function"
2020-06-28 23:05:44 -07:00
project_id = "my-project"
name = "test-cf-http"
bucket_name = "test-cf-bundles"
bucket_config = {
location = null
lifecycle_delete_age = 1
}
bundle_config = {
2021-11-07 01:46:22 -08:00
source_dir = "my-cf-source-folder"
output_path = "bundle.zip"
excludes = null
2020-06-28 23:05:44 -07:00
}
}
2020-11-07 01:28:33 -08:00
# tftest:skip
2020-06-28 23:05:44 -07:00
```
### Service account management
To use a custom service account managed by the module, set `service_account_create` to `true` and leave `service_account` set to `null` value (default).
```hcl
module "cf-http" {
2020-11-07 01:28:33 -08:00
source = "./modules/cloud-function"
2020-06-28 23:05:44 -07:00
project_id = "my-project"
name = "test-cf-http"
bucket_name = "test-cf-bundles"
bundle_config = {
2021-11-07 01:46:22 -08:00
source_dir = "my-cf-source-folder"
output_path = "bundle.zip"
excludes = null
2020-06-28 23:05:44 -07:00
}
service_account_create = true
}
2020-11-07 01:28:33 -08:00
# tftest:skip
2020-06-28 23:05:44 -07:00
```
To use an externally managed service account, pass its email in `service_account` and leave `service_account_create` to `false` (the default).
```hcl
module "cf-http" {
2020-11-07 01:28:33 -08:00
source = "./modules/cloud-function"
2020-06-28 23:05:44 -07:00
project_id = "my-project"
name = "test-cf-http"
bucket_name = "test-cf-bundles"
bundle_config = {
2021-11-07 01:46:22 -08:00
source_dir = "my-cf-source-folder"
output_path = "bundle.zip"
excludes = null
2020-06-28 23:05:44 -07:00
}
service_account = local.service_account_email
}
2020-11-07 01:28:33 -08:00
# tftest:skip
2020-06-28 23:05:44 -07:00
```
2021-11-06 06:48:22 -07:00
### Custom bundle config
2021-11-07 01:46:22 -08:00
In order to help prevent `archive_zip.output_md5` from changing cross platform (e.g. Cloud Build vs your local development environment), you'll have to make sure that the files included in the zip are always the same.
2021-11-06 06:48:22 -07:00
```hcl
module "cf-http" {
source = "./modules/cloud-function"
project_id = "my-project"
name = "test-cf-http"
bucket_name = "test-cf-bundles"
bundle_config = {
2021-11-07 01:46:22 -08:00
source_dir = "my-cf-source-folder"
output_path = "bundle.zip"
excludes = ["__pycache__"]
2021-11-06 06:48:22 -07:00
}
}
# tftest:skip
```
2020-06-28 23:05:44 -07:00
<!-- BEGIN TFDOC -->
## Variables
| name | description | type | required | default |
|---|---|:---: |:---:|:---:|
| bucket_name | Name of the bucket that will be used for the function code. It will be created with prefix prepended if bucket_config is not null. | < code title = "" > string< / code > | ✓ | |
2021-11-07 01:46:22 -08:00
| bundle_config | Cloud function source folder and generated zip bundle paths. Output path defaults to '/tmp/bundle.zip' if null. | < code title = "object({ source_dir = string output_path = string excludes = list(string) })" > object({...})< / code > | ✓ | |
2020-06-28 23:05:44 -07:00
| name | Name used for cloud function and associated resources. | < code title = "" > string< / code > | ✓ | |
| project_id | Project id used for all resources. | < code title = "" > string< / code > | ✓ | |
| *bucket_config* | Enable and configure auto-created bucket. Set fields to null to use defaults. | < code title = "object({ location = string lifecycle_delete_age = number })" > object({...})</ code > | | < code title = "" > null</ code > |
2021-10-19 12:10:43 -07:00
| *description* | Optional description. | < code title = "" > string</ code > | | < code title = "" > Terraform managed.</ code > |
2020-06-28 23:05:44 -07:00
| *environment_variables* | Cloud function environment variables. | < code title = "map(string)" > map(string)</ code > | | < code title = "" > {}</ code > |
2020-07-23 23:55:58 -07:00
| *function_config* | Cloud function configuration. | < code title = "object({ entry_point = string ingress_settings = string instances = number memory = number runtime = string timeout = number })" > object({...})</ code > | | < code title = "{ entry_point = "main" ingress_settings = null instances = 1 memory = 256 runtime = "python37" timeout = 180 }" > ...</ code > |
2020-11-05 23:37:44 -08:00
| *iam* | IAM bindings for topic in {ROLE => [MEMBERS]} format. | < code title = "map(list(string))" > map(list(string))</ code > | | < code title = "" > {}</ code > |
2020-07-23 23:55:58 -07:00
| *ingress_settings* | Control traffic that reaches the cloud function. Allowed values are ALLOW_ALL and ALLOW_INTERNAL_ONLY. | < code title = "" > string</ code > | | < code title = "" > null</ code > |
2020-06-28 23:05:44 -07:00
| *labels* | Resource labels | < code title = "map(string)" > map(string)</ code > | | < code title = "" > {}</ code > |
| *prefix* | Optional prefix used for resource names. | < code title = "" > string</ code > | | < code title = "" > null</ code > |
2020-07-01 23:29:38 -07:00
| *region* | Region used for all resources. | < code title = "" > string</ code > | | < code title = "" > europe-west1</ code > |
2020-06-28 23:05:44 -07:00
| *service_account* | Service account email. Unused if service account is auto-created. | < code title = "" > string</ code > | | < code title = "" > null</ code > |
| *service_account_create* | Auto-create service account. | < code title = "" > bool</ code > | | < code title = "" > false</ code > |
| *trigger_config* | Function trigger configuration. Leave null for HTTP trigger. | < code title = "object({ event = string resource = string retry = bool })" > object({...})</ code > | | < code title = "" > null</ code > |
2020-07-23 23:55:58 -07:00
| *vpc_connector_config* | VPC connector configuration. Set `create_config` attributes to trigger creation. | < code title = "object({ egress_settings = string name = string create_config = object({ ip_cidr_range = string network = string }) })" > object({...})</ code > | | < code title = "" > null</ code > |
2020-06-28 23:05:44 -07:00
## Outputs
| name | description | sensitive |
|---|---|:---:|
| bucket | Bucket resource (only if auto-created). | |
| bucket_name | Bucket name. | |
| function | Cloud function resources. | |
| function_name | Cloud function name. | |
| service_account | Service account resource. | |
| service_account_email | Service account email. | |
| service_account_iam_email | Service account email. | |
2020-07-23 23:55:58 -07:00
| vpc_connector | VPC connector resource if created. | |
2020-06-28 23:05:44 -07:00
<!-- END TFDOC -->