Update generated documentation after changes

Author: Pawan Kumar Senapati

README.md

@@ -57,7 +57,6 @@ module "cloud_run" {
 | container\_concurrency | Concurrent request limits to the service | `number` | `null` | no |
 | domain\_map\_annotations | Annotations to the domain map | `map(string)` | `{}` | no |
 | domain\_map\_labels | A set of key/value label pairs to assign to the Domain mapping | `map(string)` | `{}` | no |
-| build\_config | Optional Cloud Build Configuration for building a Cloud Run function | `object({ source_location = optional(string), function_target = optional(string), image_uri = optional(string), base_image = optional(string), enable_automatic_updates = optional(bool), worker_pool = optional(string), environment_variables = optional(map(string)), service_account = optional(string) })` | `{}` | no |
 | encryption\_key | CMEK encryption key self-link expected in the format projects/PROJECT/locations/LOCATION/keyRings/KEY-RING/cryptoKeys/CRYPTO-KEY. | `string` | `null` | no |
 | env\_secret\_vars | [Beta] Environment variables (Secret Manager) | <pre>list(object({<br>    name = string<br>    value_from = set(object({<br>      secret_key_ref = map(string)<br>    }))<br>  }))</pre> | `[]` | no |
 | env\_vars | Environment variables (cleartext) | <pre>list(object({<br>    value = string<br>    name  = string<br>  }))</pre> | `[]` | no |
@@ -99,8 +98,6 @@ module "cloud_run" {
 | service\_status | Status of the created service |
 | service\_url | The URL on which the deployed service is available |
 | verified\_domain\_name | List of Custom Domain Name |
-| build\_name | The Cloud Build name of the latest successful deployment of the Service. |
-
 
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 

examples/v2/README.md

@@ -18,6 +18,7 @@ This example assumes that below mentioned prerequisites are in place before cons
 
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
+| build\_config | Optional Cloud Build configuration for Cloud Run. This block enables building a container image from source using Cloud Build instead of specifying a prebuilt container image. | <pre>object({<br>    source_location          = optional(string)<br>    function_target          = optional(string)<br>    image_uri                = optional(string)<br>    base_image               = optional(string)<br>    enable_automatic_updates = optional(bool)<br>    worker_pool              = optional(string)<br>    environment_variables    = optional(map(string))<br>    service_account          = optional(string)<br>  })</pre> | `null` | no |
 | cloud\_run\_deletion\_protection | This field prevents Terraform from destroying or recreating the Cloud Run v2 Jobs and Services | `bool` | `true` | no |
 | project\_id | The project ID to deploy to | `string` | n/a | yes |
 

metadata.yaml

@@ -94,13 +94,7 @@ spec:
         defaultValue: true
       - name: traffic_split
         description: Managing traffic routing to the service
-        varType: |-
-          list(object({
-              latest_revision = bool
-              percent         = number
-              revision_name   = string
-              tag             = string
-            }))
+        varType: "list(object({\r\n    latest_revision = bool\r\n    percent         = number\r\n    revision_name   = string\r\n    tag             = string\r\n  }))"
         defaultValue:
           - latest_revision: true
             percent: 100
@@ -143,14 +137,7 @@ spec:
         defaultValue: ""
       - name: volumes
         description: "[Beta] Volumes needed for environment variables (when using secret)"
-        varType: |-
-          list(object({
-              name = string
-              secret = set(object({
-                secret_name = string
-                items       = map(string)
-              }))
-            }))
+        varType: "list(object({\r\n    name = string\r\n    secret = set(object({\r\n      secret_name = string\r\n      items       = map(string)\r\n    }))\r\n  }))"
         defaultValue: []
       - name: limits
         description: Resource limits to the container
@@ -161,11 +148,7 @@ spec:
         defaultValue: {}
       - name: ports
         description: Port which the container listens to (http1 or h2c)
-        varType: |-
-          object({
-              name = string
-              port = number
-            })
+        varType: "object({\r\n    name = string\r\n    port = number\r\n  })"
         defaultValue:
           name: http1
           port: 8080
@@ -178,79 +161,22 @@ spec:
         varType: list(string)
         defaultValue: []
       - name: startup_probe
-        description: |
-          Startup probe of application within the container.
-          All other probes are disabled if a startup probe is provided, until it succeeds.
-          Container will not be added to service endpoints if the probe fails.
-          More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
-        varType: |-
-          object({
-              failure_threshold     = optional(number, null)
-              initial_delay_seconds = optional(number, null)
-              timeout_seconds       = optional(number, null)
-              period_seconds        = optional(number, null)
-              http_get = optional(object({
-                path = optional(string)
-                http_headers = optional(list(object({
-                  name  = string
-                  value = string
-                })), null)
-              }), null)
-              tcp_socket = optional(object({
-                port = optional(number)
-              }), null)
-              grpc = optional(object({
-                port    = optional(number)
-                service = optional(string)
-              }), null)
-            })
+        description: "Startup probe of application within the container.\r\nAll other probes are disabled if a startup probe is provided, until it succeeds.\r\nContainer will not be added to service endpoints if the probe fails.\r\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\r\n"
+        varType: "object({\r\n    failure_threshold     = optional(number, null)\r\n    initial_delay_seconds = optional(number, null)\r\n    timeout_seconds       = optional(number, null)\r\n    period_seconds        = optional(number, null)\r\n    http_get = optional(object({\r\n      path = optional(string)\r\n      http_headers = optional(list(object({\r\n        name  = string\r\n        value = string\r\n      })), null)\r\n    }), null)\r\n    tcp_socket = optional(object({\r\n      port = optional(number)\r\n    }), null)\r\n    grpc = optional(object({\r\n      port    = optional(number)\r\n      service = optional(string)\r\n    }), null)\r\n  })"
       - name: liveness_probe
-        description: |
-          Periodic probe of container liveness. Container will be restarted if the probe fails.
-          More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
-        varType: |-
-          object({
-              failure_threshold     = optional(number, null)
-              initial_delay_seconds = optional(number, null)
-              timeout_seconds       = optional(number, null)
-              period_seconds        = optional(number, null)
-              http_get = optional(object({
-                path = optional(string)
-                http_headers = optional(list(object({
-                  name  = string
-                  value = string
-                })), null)
-              }), null)
-              grpc = optional(object({
-                port    = optional(number)
-                service = optional(string)
-              }), null)
-            })
+        description: "Periodic probe of container liveness. Container will be restarted if the probe fails.\r\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes\r\n"
+        varType: "object({\r\n    failure_threshold     = optional(number, null)\r\n    initial_delay_seconds = optional(number, null)\r\n    timeout_seconds       = optional(number, null)\r\n    period_seconds        = optional(number, null)\r\n    http_get = optional(object({\r\n      path = optional(string)\r\n      http_headers = optional(list(object({\r\n        name  = string\r\n        value = string\r\n      })), null)\r\n    }), null)\r\n    grpc = optional(object({\r\n      port    = optional(number)\r\n      service = optional(string)\r\n    }), null)\r\n  })"
       - name: env_vars
         description: Environment variables (cleartext)
-        varType: |-
-          list(object({
-              value = string
-              name  = string
-            }))
+        varType: "list(object({\r\n    value = string\r\n    name  = string\r\n  }))"
         defaultValue: []
       - name: env_secret_vars
         description: "[Beta] Environment variables (Secret Manager)"
-        varType: |-
-          list(object({
-              name = string
-              value_from = set(object({
-                secret_key_ref = map(string)
-              }))
-            }))
+        varType: "list(object({\r\n    name = string\r\n    value_from = set(object({\r\n      secret_key_ref = map(string)\r\n    }))\r\n  }))"
         defaultValue: []
       - name: volume_mounts
         description: "[Beta] Volume Mounts to be attached to the container (when using secret)"
-        varType: |-
-          list(object({
-              mount_path = string
-              name       = string
-            }))
+        varType: "list(object({\r\n    mount_path = string\r\n    name       = string\r\n  }))"
         defaultValue: []
       - name: verified_domain_name
         description: List of Custom Domain Name
@@ -323,13 +249,13 @@ spec:
     roles:
       - level: Project
         roles:
-          - roles/cloudkms.admin
-          - roles/resourcemanager.projectIamAdmin
           - roles/run.admin
           - roles/iam.serviceAccountAdmin
           - roles/artifactregistry.admin
           - roles/iam.serviceAccountUser
           - roles/serviceusage.serviceUsageViewer
+          - roles/cloudkms.admin
+          - roles/resourcemanager.projectIamAdmin
     services:
       - accesscontextmanager.googleapis.com
       - cloudbilling.googleapis.com

modules/job-exec/metadata.yaml

@@ -104,24 +104,11 @@ spec:
         defaultValue: []
       - name: env_vars
         description: Environment variables (cleartext)
-        varType: |-
-          list(object({
-              value = string
-              name  = string
-            }))
+        varType: "list(object({\r\n    value = string\r\n    name  = string\r\n  }))"
         defaultValue: []
       - name: env_secret_vars
         description: Environment variables (Secret Manager)
-        varType: |-
-          list(object({
-              name = string
-              value_source = set(object({
-                secret_key_ref = object({
-                  secret  = string
-                  version = optional(string, "latest")
-                })
-              }))
-            }))
+        varType: "list(object({\r\n    name = string\r\n    value_source = set(object({\r\n      secret_key_ref = object({\r\n        secret  = string\r\n        version = optional(string, \"latest\")\r\n      })\r\n    }))\r\n  }))"
         defaultValue: []
       - name: launch_stage
         description: The launch stage. (see https://cloud.google.com/products#product-launch-stages). Defaults to GA.
@@ -142,18 +129,7 @@ spec:
         varType: number
       - name: volumes
         description: A list of Volumes to make available to containers.
-        varType: |-
-          list(object({
-              name = string
-              cloud_sql_instance = optional(object({
-                instances = list(string)
-              }))
-              gcs = optional(object({
-                bucket        = string
-                read_only     = optional(bool)
-                mount_options = optional(list(string))
-              }))
-            }))
+        varType: "list(object({\r\n    name = string\r\n    cloud_sql_instance = optional(object({\r\n      instances = list(string)\r\n    }))\r\n    gcs = optional(object({\r\n      bucket        = string\r\n      read_only     = optional(bool)\r\n      mount_options = optional(list(string))\r\n    }))\r\n  }))"
         defaultValue: []
         connections:
           - source:
@@ -175,27 +151,15 @@ spec:
               outputExpr: "{\"name\": \"gcs-bucket-vol\", \"gcs\": { \"bucket\": name}}"
       - name: volume_mounts
         description: Volume to mount into the container's filesystem.
-        varType: |-
-          list(object({
-              name       = string
-              mount_path = string
-            }))
+        varType: "list(object({\r\n    name       = string\r\n    mount_path = string\r\n  }))"
         defaultValue: []
       - name: vpc_access
         description: VPC Access configuration to use for this Task.
-        varType: |-
-          list(object({
-              connector = string
-              egress    = string
-            }))
+        varType: "list(object({\r\n    connector = string\r\n    egress    = string\r\n  }))"
         defaultValue: []
       - name: limits
         description: Resource limits to the container
-        varType: |-
-          object({
-              cpu    = optional(string)
-              memory = optional(string)
-            })
+        varType: "object({\r\n    cpu    = optional(string)\r\n    memory = optional(string)\r\n  })"
       - name: timeout
         description: Max allowed time duration the Task may be active before the system will actively try to mark it failed and kill associated containers.
         varType: string
@@ -219,13 +183,13 @@ spec:
     roles:
       - level: Project
         roles:
-          - roles/run.admin
           - roles/iam.serviceAccountAdmin
           - roles/artifactregistry.admin
           - roles/iam.serviceAccountUser
           - roles/serviceusage.serviceUsageViewer
           - roles/cloudkms.admin
           - roles/resourcemanager.projectIamAdmin
+          - roles/run.admin
     services:
       - accesscontextmanager.googleapis.com
       - cloudbilling.googleapis.com

modules/secure-cloud-run-core/metadata.yaml

@@ -90,14 +90,7 @@ spec:
         required: true
       - name: default_rules
         description: Default rule for Cloud Armor.
-        varType: |-
-          map(object({
-              action         = string
-              priority       = string
-              versioned_expr = string
-              src_ip_ranges  = list(string)
-              description    = string
-            }))
+        varType: "map(object({\r\n    action         = string\r\n    priority       = string\r\n    versioned_expr = string\r\n    src_ip_ranges  = list(string)\r\n    description    = string\r\n  }))"
         defaultValue:
           default_rule:
             action: allow
@@ -108,12 +101,7 @@ spec:
             versioned_expr: SRC_IPS_V1
       - name: owasp_rules
         description: These are additional Cloud Armor rules for SQLi, XSS, LFI, RCE, RFI, Scannerdetection, Protocolattack and Sessionfixation (requires Cloud Armor default_rule).
-        varType: |-
-          map(object({
-              action     = string
-              priority   = string
-              expression = string
-            }))
+        varType: "map(object({\r\n    action     = string\r\n    priority   = string\r\n    expression = string\r\n  }))"
         defaultValue:
           rule_canary:
             action: deny(403)
@@ -153,11 +141,7 @@ spec:
         defaultValue: tf-cr-lb
       - name: env_vars
         description: Environment variables.
-        varType: |-
-          list(object({
-              value = string
-              name  = string
-            }))
+        varType: "list(object({\r\n    value = string\r\n    name  = string\r\n  }))"
         defaultValue: []
       - name: members
         description: Users/SAs to be given invoker access to the service with the prefix `serviceAccount:' for SAs and `user:` for users.
@@ -169,13 +153,7 @@ spec:
         defaultValue: true
       - name: traffic_split
         description: Managing traffic routing to the service.
-        varType: |-
-          list(object({
-              latest_revision = bool
-              percent         = number
-              revision_name   = string
-              tag             = string
-            }))
+        varType: "list(object({\r\n    latest_revision = bool\r\n    percent         = number\r\n    revision_name   = string\r\n    tag             = string\r\n  }))"
         defaultValue:
           - latest_revision: true
             percent: 100
@@ -198,14 +176,7 @@ spec:
         defaultValue: 120
       - name: volumes
         description: "[Beta] Volumes needed for environment variables (when using secret)."
-        varType: |-
-          list(object({
-              name = string
-              secret = set(object({
-                secret_name = string
-                items       = map(string)
-              }))
-            }))
+        varType: "list(object({\r\n    name = string\r\n    secret = set(object({\r\n      secret_name = string\r\n      items       = map(string)\r\n    }))\r\n  }))"
         defaultValue: []
       - name: limits
         description: Resource limits to the container.
@@ -216,11 +187,7 @@ spec:
         defaultValue: {}
       - name: ports
         description: Port which the container listens to (http1 or h2c).
-        varType: |-
-          object({
-              name = string
-              port = number
-            })
+        varType: "object({\r\n    name = string\r\n    port = number\r\n  })"
         defaultValue:
           name: http1
           port: 8080
@@ -234,11 +201,7 @@ spec:
         defaultValue: []
       - name: volume_mounts
         description: "[Beta] Volume Mounts to be attached to the container (when using secret)."
-        varType: |-
-          list(object({
-              mount_path = string
-              name       = string
-            }))
+        varType: "list(object({\r\n    mount_path = string\r\n    name       = string\r\n  }))"
         defaultValue: []
       - name: verified_domain_name
         description: List of custom Domain Name.
@@ -281,11 +244,7 @@ spec:
         defaultValue: private-ranges-only
       - name: ssl_certificates
         description: A object with a list of domains to auto-generate SSL certificates or a list of SSL Certificates self-links in the pattern `projects/<PROJECT-ID>/global/sslCertificates/<CERT-NAME>` to be used by Load Balancer.
-        varType: |-
-          object({
-              ssl_certificates_self_links       = list(string)
-              generate_certificates_for_domains = list(string)
-            })
+        varType: "object({\r\n    ssl_certificates_self_links       = list(string)\r\n    generate_certificates_for_domains = list(string)\r\n  })"
         required: true
     outputs:
       - name: domain_map_id
@@ -306,13 +265,13 @@ spec:
     roles:
       - level: Project
         roles:
-          - roles/cloudkms.admin
-          - roles/resourcemanager.projectIamAdmin
           - roles/run.admin
           - roles/iam.serviceAccountAdmin
           - roles/artifactregistry.admin
           - roles/iam.serviceAccountUser
           - roles/serviceusage.serviceUsageViewer
+          - roles/cloudkms.admin
+          - roles/resourcemanager.projectIamAdmin
     services:
       - accesscontextmanager.googleapis.com
       - cloudbilling.googleapis.com