fix!: Making Cloud Functions ADC Compliant (#194)

Author: anshukaira

Makefile

@@ -18,7 +18,7 @@
 # Make will use bash instead of sh
 SHELL := /usr/bin/env bash
 
-DOCKER_TAG_VERSION_DEVELOPER_TOOLS := 1.24
+DOCKER_TAG_VERSION_DEVELOPER_TOOLS := 1.25
 DOCKER_IMAGE_DEVELOPER_TOOLS := cft/developer-tools
 REGISTRY_URL := gcr.io/cloud-foundation-cicd
 
@@ -77,9 +77,10 @@ docker_test_lint:
 .PHONY: docker_generate_docs
 docker_generate_docs:
 	docker run --rm -it \
+		-e ENABLE_BPMETADATA=1 \
 		-v "$(CURDIR)":/workspace \
 		$(REGISTRY_URL)/${DOCKER_IMAGE_DEVELOPER_TOOLS}:${DOCKER_TAG_VERSION_DEVELOPER_TOOLS} \
-		/bin/bash -c 'source /usr/local/bin/task_helper_functions.sh && generate_docs'
+		/bin/bash -c 'source /usr/local/bin/task_helper_functions.sh && generate_docs display'
 
 # Alias for backwards compatibility
 .PHONY: generate_docs

README.md

@@ -31,7 +31,7 @@ module "cloud_functions2" {
   # Required variables
   function_name      = "<FUNCTION_NAME>"
   project_id         = "<PROJECT_ID>"
-  function_location  = "<LOCATION>"
+  location  = "<LOCATION>"
   runtime            = "<RUNTIME>"
   entrypoint         = "<ENTRYPOINT>"
   storage_source = {
@@ -56,9 +56,10 @@ Functional examples are included in the
 | docker\_repository | User managed repository created in Artifact Registry optionally with a customer managed encryption key. | `string` | `null` | no |
 | entrypoint | The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix, if not specified | `string` | n/a | yes |
 | event\_trigger | Event triggers for the function | <pre>object({<br>    trigger_region        = optional(string)<br>    event_type            = string<br>    service_account_email = string<br>    pubsub_topic          = optional(string)<br>    retry_policy          = string<br>    event_filters = optional(set(object({<br>      attribute       = string<br>      attribute_value = string<br>      operator        = optional(string)<br>    })))<br>  })</pre> | `null` | no |
-| function\_location | The location of this cloud function | `string` | n/a | yes |
+| function\_location | DEPRECATED: Please use the 'location' variable instead. This will be removed in a future version. | `string` | `null` | no |
 | function\_name | A user-defined name of the function | `string` | n/a | yes |
 | labels | A set of key/value label pairs associated with this Cloud Function | `map(string)` | `null` | no |
+| location | The location of this cloud function | `string` | n/a | yes |
 | members | Cloud Function Invoker and Developer roles for Users/SAs. Key names must be developers and/or invokers | `map(list(string))` | `{}` | no |
 | project\_id | Project ID to create Cloud Function | `string` | n/a | yes |
 | repo\_source | Get the source from this location in a Cloud Source Repository | <pre>object({<br>    project_id   = optional(string)<br>    repo_name    = string<br>    branch_name  = string<br>    dir          = optional(string)<br>    tag_name     = optional(string)<br>    commit_sha   = optional(string)<br>    invert_regex = optional(bool, false)<br>  })</pre> | `null` | no |

examples/cloud_function2_gcs_source/README.md

@@ -7,16 +7,16 @@ This example illustrates how to use the `cloud-functions` module.
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
-| function\_location | The location of this cloud function | `string` | `"us-central1"` | no |
+| location | The location of this cloud function | `string` | `"us-central1"` | no |
 | project\_id | The ID of the project in which to provision resources. | `string` | n/a | yes |
 
 ## Outputs
 
 | Name | Description |
 |------|-------------|
-| function\_location | Location of the Cloud Function (Gen 2) |
 | function\_name | Name of the Cloud Function (Gen 2) |
 | function\_uri | URI of the Cloud Function (Gen 2) |
+| location | Location of the Cloud Function (Gen 2) |
 | project\_id | The project ID |
 
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->

examples/cloud_function2_gcs_source/main.tf

@@ -28,14 +28,13 @@ resource "google_storage_bucket_object" "function-source" {
 }
 
 module "cloud_functions2" {
-  source  = "GoogleCloudPlatform/cloud-functions/google"
-  version = "~> 0.6"
+  source = "../../"
 
-  project_id        = var.project_id
-  function_name     = "function2-gcs-source-py"
-  function_location = var.function_location
-  runtime           = "python38"
-  entrypoint        = "hello_http"
+  project_id    = var.project_id
+  function_name = "function2-gcs-source-py"
+  location      = var.location
+  runtime       = "python310"
+  entrypoint    = "hello_http"
   storage_source = {
     bucket     = google_storage_bucket.bucket.name
     object     = google_storage_bucket_object.function-source.name

examples/cloud_function2_gcs_source/outputs.tf

@@ -24,9 +24,9 @@ output "function_name" {
   value       = module.cloud_functions2.function_name
 }
 
-output "function_location" {
+output "location" {
   description = "Location of the Cloud Function (Gen 2)"
-  value       = var.function_location
+  value       = var.location
 }
 
 output "project_id" {

examples/cloud_function2_gcs_source/variables.tf

@@ -19,7 +19,7 @@ variable "project_id" {
   type        = string
 }
 
-variable "function_location" {
+variable "location" {
   description = "The location of this cloud function"
   type        = string
   default     = "us-central1"

examples/cloud_function2_pubsub_trigger/README.md

@@ -7,16 +7,16 @@ This example illustrates how to use the `cloud-functions` module.
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
-| function\_location | The location of this cloud function | `string` | `"us-central1"` | no |
+| location | The location of this cloud function | `string` | `"us-central1"` | no |
 | project\_id | The ID of the project in which to provision resources. | `string` | n/a | yes |
 
 ## Outputs
 
 | Name | Description |
 |------|-------------|
-| function\_location | Location of the Cloud Function (Gen 2) |
 | function\_name | Name of the Cloud Function (Gen 2) |
 | function\_uri | URI of the Cloud Function (Gen 2) |
+| location | Location of the Cloud Function (Gen 2) |
 | project\_id | The project ID |
 | pubsub\_topic | Name of the PubSub Topic |
 

examples/cloud_function2_pubsub_trigger/main.tf

@@ -36,14 +36,13 @@ module "pubsub" {
 }
 
 module "cloud_functions2" {
-  source  = "GoogleCloudPlatform/cloud-functions/google"
-  version = "~> 0.6"
+  source = "../../"
 
-  project_id        = var.project_id
-  function_name     = "function2-pubsub-trigger-py"
-  function_location = var.function_location
-  runtime           = "python38"
-  entrypoint        = "hello_http"
+  project_id    = var.project_id
+  function_name = "function2-pubsub-trigger-py"
+  location      = var.location
+  runtime       = "python310"
+  entrypoint    = "hello_http"
   storage_source = {
     bucket     = google_storage_bucket.bucket.name
     object     = google_storage_bucket_object.function-source.name

examples/cloud_function2_pubsub_trigger/outputs.tf

@@ -24,9 +24,9 @@ output "function_name" {
   value       = module.cloud_functions2.function_name
 }
 
-output "function_location" {
+output "location" {
   description = "Location of the Cloud Function (Gen 2)"
-  value       = var.function_location
+  value       = var.location
 }
 
 output "pubsub_topic" {

examples/cloud_function2_pubsub_trigger/variables.tf

@@ -19,7 +19,7 @@ variable "project_id" {
   type        = string
 }
 
-variable "function_location" {
+variable "location" {
   description = "The location of this cloud function"
   type        = string
   default     = "us-central1"