diff --git a/modules/cloud-function/README.md b/modules/cloud-function/README.md index daaaccfa..e38cbb65 100644 --- a/modules/cloud-function/README.md +++ b/modules/cloud-function/README.md @@ -174,7 +174,6 @@ module "cf-http" { } # tftest skip ``` - ## Variables @@ -182,26 +181,26 @@ module "cf-http" { | 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. | string | ✓ | | -| [build_worker_pool](variables.tf#L31) | Build worker pool, in projects//locations//workerPools/ format | string | ✓ | | -| [bundle_config](variables.tf#L36) | Cloud function source folder and generated zip bundle paths. Output path defaults to '/tmp/bundle.zip' if null. | object({…}) | ✓ | | -| [name](variables.tf#L93) | Name used for cloud function and associated resources. | string | ✓ | | -| [project_id](variables.tf#L104) | Project id used for all resources. | string | ✓ | | +| [bundle_config](variables.tf#L37) | Cloud function source folder and generated zip bundle paths. Output path defaults to '/tmp/bundle.zip' if null. | object({…}) | ✓ | | +| [name](variables.tf#L94) | Name used for cloud function and associated resources. | string | ✓ | | +| [project_id](variables.tf#L105) | Project id used for all resources. | string | ✓ | | | [bucket_config](variables.tf#L17) | Enable and configure auto-created bucket. Set fields to null to use defaults. | object({…}) | | null | -| [description](variables.tf#L45) | Optional description. | string | | "Terraform managed." | -| [environment_variables](variables.tf#L51) | Cloud function environment variables. | map(string) | | {} | -| [function_config](variables.tf#L57) | Cloud function configuration. | object({…}) | | {…} | -| [iam](variables.tf#L75) | IAM bindings for topic in {ROLE => [MEMBERS]} format. | map(list(string)) | | {} | -| [ingress_settings](variables.tf#L81) | Control traffic that reaches the cloud function. Allowed values are ALLOW_ALL, ALLOW_INTERNAL_AND_GCLB and ALLOW_INTERNAL_ONLY . | string | | null | -| [labels](variables.tf#L87) | Resource labels. | map(string) | | {} | -| [prefix](variables.tf#L98) | Optional prefix used for resource names. | string | | null | -| [region](variables.tf#L109) | Region used for all resources. | string | | "europe-west1" | -| [secrets](variables.tf#L115) | Secret Manager secrets. Key is the variable name or mountpoint, volume versions are in version:path format. | map(object({…})) | | {} | -| [service_account](variables.tf#L127) | Service account email. Unused if service account is auto-created. | string | | null | -| [service_account_create](variables.tf#L133) | Auto-create service account. | bool | | false | -| [trigger_config](variables.tf#L139) | Function trigger configuration. Leave null for HTTP trigger. | object({…}) | | null | -| [v2](variables.tf#L168) | Whether to use Cloud Function version 2nd Gen or 1st Gen. | bool | | false | -| [vpc_connector](variables.tf#L149) | VPC connector configuration. Set create to 'true' if a new connector needs to be created. | object({…}) | | null | -| [vpc_connector_config](variables.tf#L159) | VPC connector network configuration. Must be provided if new VPC connector is being created. | object({…}) | | null | +| [build_worker_pool](variables.tf#L31) | Build worker pool, in projects//locations//workerPools/ format | string | | null | +| [description](variables.tf#L46) | Optional description. | string | | "Terraform managed." | +| [environment_variables](variables.tf#L52) | Cloud function environment variables. | map(string) | | {} | +| [function_config](variables.tf#L58) | Cloud function configuration. | object({…}) | | {…} | +| [iam](variables.tf#L76) | IAM bindings for topic in {ROLE => [MEMBERS]} format. | map(list(string)) | | {} | +| [ingress_settings](variables.tf#L82) | Control traffic that reaches the cloud function. Allowed values are ALLOW_ALL, ALLOW_INTERNAL_AND_GCLB and ALLOW_INTERNAL_ONLY . | string | | null | +| [labels](variables.tf#L88) | Resource labels. | map(string) | | {} | +| [prefix](variables.tf#L99) | Optional prefix used for resource names. | string | | null | +| [region](variables.tf#L110) | Region used for all resources. | string | | "europe-west1" | +| [secrets](variables.tf#L116) | Secret Manager secrets. Key is the variable name or mountpoint, volume versions are in version:path format. | map(object({…})) | | {} | +| [service_account](variables.tf#L128) | Service account email. Unused if service account is auto-created. | string | | null | +| [service_account_create](variables.tf#L134) | Auto-create service account. | bool | | false | +| [trigger_config](variables.tf#L140) | Function trigger configuration. Leave null for HTTP trigger. | object({…}) | | null | +| [v2](variables.tf#L169) | Whether to use Cloud Function version 2nd Gen or 1st Gen. | bool | | false | +| [vpc_connector](variables.tf#L150) | VPC connector configuration. Set create to 'true' if a new connector needs to be created. | object({…}) | | null | +| [vpc_connector_config](variables.tf#L160) | VPC connector network configuration. Must be provided if new VPC connector is being created. | object({…}) | | null | ## Outputs