237 lines
11 KiB
Markdown
237 lines
11 KiB
Markdown
# Cloud Function Module (V1)
|
|
|
|
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" {
|
|
source = "./fabric/modules/cloud-function-v1"
|
|
project_id = "my-project"
|
|
name = "test-cf-http"
|
|
bucket_name = "test-cf-bundles"
|
|
bundle_config = {
|
|
source_dir = "fabric/assets/"
|
|
output_path = "bundle.zip"
|
|
}
|
|
}
|
|
# tftest modules=1 resources=2
|
|
```
|
|
|
|
### PubSub and non-HTTP triggers
|
|
|
|
Other trigger types other than HTTP are configured via the `trigger_config` variable. This example shows a PubSub trigger.
|
|
|
|
```hcl
|
|
module "cf-http" {
|
|
source = "./fabric/modules/cloud-function-v1"
|
|
project_id = "my-project"
|
|
name = "test-cf-http"
|
|
bucket_name = "test-cf-bundles"
|
|
bundle_config = {
|
|
source_dir = "fabric/assets/"
|
|
output_path = "bundle.zip"
|
|
}
|
|
trigger_config = {
|
|
event = "google.pubsub.topic.publish"
|
|
resource = "local.my-topic"
|
|
}
|
|
}
|
|
# tftest modules=1 resources=2
|
|
```
|
|
|
|
### 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" {
|
|
source = "./fabric/modules/cloud-function-v1"
|
|
project_id = "my-project"
|
|
name = "test-cf-http"
|
|
bucket_name = "test-cf-bundles"
|
|
bundle_config = {
|
|
source_dir = "fabric/assets/"
|
|
output_path = "bundle.zip"
|
|
}
|
|
iam = {
|
|
"roles/cloudfunctions.invoker" = ["allUsers"]
|
|
}
|
|
}
|
|
# tftest modules=1 resources=3 inventory=iam.yaml
|
|
```
|
|
|
|
### 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" {
|
|
source = "./fabric/modules/cloud-function-v1"
|
|
project_id = "my-project"
|
|
name = "test-cf-http"
|
|
bucket_name = "test-cf-bundles"
|
|
bucket_config = {
|
|
lifecycle_delete_age_days = 1
|
|
}
|
|
bundle_config = {
|
|
source_dir = "fabric/assets/"
|
|
}
|
|
}
|
|
# tftest modules=1 resources=3
|
|
```
|
|
|
|
### 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" {
|
|
source = "./fabric/modules/cloud-function-v1"
|
|
project_id = "my-project"
|
|
name = "test-cf-http"
|
|
bucket_name = "test-cf-bundles"
|
|
bundle_config = {
|
|
source_dir = "fabric/assets/"
|
|
output_path = "bundle.zip"
|
|
}
|
|
service_account_create = true
|
|
}
|
|
# tftest modules=1 resources=3
|
|
```
|
|
|
|
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" {
|
|
source = "./fabric/modules/cloud-function-v1"
|
|
project_id = "my-project"
|
|
name = "test-cf-http"
|
|
bucket_name = "test-cf-bundles"
|
|
bundle_config = {
|
|
source_dir = "fabric/assets/"
|
|
output_path = "bundle.zip"
|
|
}
|
|
service_account = "non-existent@serice.account.email"
|
|
}
|
|
# tftest modules=1 resources=2
|
|
```
|
|
|
|
### Custom bundle config
|
|
|
|
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.
|
|
|
|
```hcl
|
|
module "cf-http" {
|
|
source = "./fabric/modules/cloud-function-v1"
|
|
project_id = "my-project"
|
|
name = "test-cf-http"
|
|
bucket_name = "test-cf-bundles"
|
|
bundle_config = {
|
|
source_dir = "fabric/assets"
|
|
output_path = "bundle.zip"
|
|
excludes = ["__pycache__"]
|
|
}
|
|
}
|
|
# tftest modules=1 resources=2
|
|
```
|
|
|
|
### Private Cloud Build Pool
|
|
|
|
This deploys a Cloud Function with an HTTP endpoint, using a pre-existing GCS bucket for deployment using a pre existing private Cloud Build worker pool.
|
|
|
|
```hcl
|
|
module "cf-http" {
|
|
source = "./fabric/modules/cloud-function-v1"
|
|
project_id = "my-project"
|
|
name = "test-cf-http"
|
|
bucket_name = "test-cf-bundles"
|
|
build_worker_pool = "projects/my-project/locations/europe-west1/workerPools/my_build_worker_pool"
|
|
bundle_config = {
|
|
source_dir = "fabric/assets"
|
|
output_path = "bundle.zip"
|
|
}
|
|
}
|
|
# tftest modules=1 resources=2
|
|
```
|
|
|
|
### Multiple Cloud Functions within project
|
|
|
|
When deploying multiple functions do not reuse `bundle_config.output_path` between instances as the result is undefined. Default `output_path` creates file in `/tmp` folder using project Id and function name to avoid name conflicts.
|
|
|
|
```hcl
|
|
module "cf-http-one" {
|
|
source = "./fabric/modules/cloud-function-v1"
|
|
project_id = "my-project"
|
|
name = "test-cf-http-one"
|
|
bucket_name = "test-cf-bundles"
|
|
bundle_config = {
|
|
source_dir = "fabric/assets"
|
|
}
|
|
}
|
|
|
|
module "cf-http-two" {
|
|
source = "./fabric/modules/cloud-function-v1"
|
|
project_id = "my-project"
|
|
name = "test-cf-http-two"
|
|
bucket_name = "test-cf-bundles"
|
|
bundle_config = {
|
|
source_dir = "fabric/assets"
|
|
}
|
|
}
|
|
# tftest modules=2 resources=4 inventory=multiple_functions.yaml
|
|
```
|
|
|
|
<!-- BEGIN TFDOC -->
|
|
|
|
## Variables
|
|
|
|
| name | description | type | required | default |
|
|
|---|---|:---:|:---:|:---:|
|
|
| [bucket_name](variables.tf#L26) | 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>string</code> | ✓ | |
|
|
| [bundle_config](variables.tf#L37) | 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 = optional(string) excludes = optional(list(string)) })">object({…})</code> | ✓ | |
|
|
| [name](variables.tf#L96) | Name used for cloud function and associated resources. | <code>string</code> | ✓ | |
|
|
| [project_id](variables.tf#L111) | Project id used for all resources. | <code>string</code> | ✓ | |
|
|
| [bucket_config](variables.tf#L17) | Enable and configure auto-created bucket. Set fields to null to use defaults. | <code title="object({ location = optional(string) lifecycle_delete_age_days = optional(number) })">object({…})</code> | | <code>null</code> |
|
|
| [build_worker_pool](variables.tf#L31) | Build worker pool, in projects/<PROJECT-ID>/locations/<REGION>/workerPools/<POOL_NAME> format. | <code>string</code> | | <code>null</code> |
|
|
| [description](variables.tf#L46) | Optional description. | <code>string</code> | | <code>"Terraform managed."</code> |
|
|
| [environment_variables](variables.tf#L52) | Cloud function environment variables. | <code>map(string)</code> | | <code>{}</code> |
|
|
| [function_config](variables.tf#L58) | Cloud function configuration. Defaults to using main as entrypoint, 1 instance with 256MiB of memory, and 180 second timeout. | <code title="object({ entry_point = optional(string, "main") instance_count = optional(number, 1) memory_mb = optional(number, 256) # Memory in MB cpu = optional(string, "0.166") runtime = optional(string, "python310") timeout_seconds = optional(number, 180) })">object({…})</code> | | <code title="{ entry_point = "main" instance_count = 1 memory_mb = 256 cpu = "0.166" runtime = "python310" timeout_seconds = 180 }">{…}</code> |
|
|
| [iam](variables.tf#L78) | IAM bindings for topic in {ROLE => [MEMBERS]} format. | <code>map(list(string))</code> | | <code>{}</code> |
|
|
| [ingress_settings](variables.tf#L84) | Control traffic that reaches the cloud function. Allowed values are ALLOW_ALL, ALLOW_INTERNAL_AND_GCLB and ALLOW_INTERNAL_ONLY . | <code>string</code> | | <code>null</code> |
|
|
| [labels](variables.tf#L90) | Resource labels. | <code>map(string)</code> | | <code>{}</code> |
|
|
| [prefix](variables.tf#L101) | Optional prefix used for resource names. | <code>string</code> | | <code>null</code> |
|
|
| [region](variables.tf#L116) | Region used for all resources. | <code>string</code> | | <code>"europe-west1"</code> |
|
|
| [secrets](variables.tf#L122) | Secret Manager secrets. Key is the variable name or mountpoint, volume versions are in version:path format. | <code title="map(object({ is_volume = bool project_id = number secret = string versions = list(string) }))">map(object({…}))</code> | | <code>{}</code> |
|
|
| [service_account](variables.tf#L134) | Service account email. Unused if service account is auto-created. | <code>string</code> | | <code>null</code> |
|
|
| [service_account_create](variables.tf#L140) | Auto-create service account. | <code>bool</code> | | <code>false</code> |
|
|
| [trigger_config](variables.tf#L146) | Function trigger configuration. Leave null for HTTP trigger. | <code title="object({ event = string resource = string retry = optional(bool) })">object({…})</code> | | <code>null</code> |
|
|
| [vpc_connector](variables.tf#L156) | VPC connector configuration. Set create to 'true' if a new connector needs to be created. | <code title="object({ create = bool name = string egress_settings = string })">object({…})</code> | | <code>null</code> |
|
|
| [vpc_connector_config](variables.tf#L166) | VPC connector network configuration. Must be provided if new VPC connector is being created. | <code title="object({ ip_cidr_range = string network = string })">object({…})</code> | | <code>null</code> |
|
|
|
|
## Outputs
|
|
|
|
| name | description | sensitive |
|
|
|---|---|:---:|
|
|
| [bucket](outputs.tf#L17) | Bucket resource (only if auto-created). | |
|
|
| [bucket_name](outputs.tf#L24) | Bucket name. | |
|
|
| [function](outputs.tf#L29) | Cloud function resources. | |
|
|
| [function_name](outputs.tf#L34) | Cloud function name. | |
|
|
| [id](outputs.tf#L39) | Fully qualified function id. | |
|
|
| [service_account](outputs.tf#L44) | Service account resource. | |
|
|
| [service_account_email](outputs.tf#L49) | Service account email. | |
|
|
| [service_account_iam_email](outputs.tf#L54) | Service account email. | |
|
|
| [vpc_connector](outputs.tf#L62) | VPC connector resource if created. | |
|
|
|
|
<!-- END TFDOC -->
|