Add deletion_protection to v2 cloud run service resource (#11318)

Co-authored-by: Thomas Rodgers <[email protected]>
GoogleCloudPlatform · Aug 6, 2024 · 1c7aa4d · 1c7aa4d
1 parent 40c0cc6
commit 1c7aa4d
Show file tree

Hide file tree

Showing 47 changed files with 185 additions and 29 deletions.
diff --git a/mmv1/products/cloudrunv2/Job.yaml b/mmv1/products/cloudrunv2/Job.yaml
@@ -50,6 +50,19 @@ iam_policy: !ruby/object:Api::Resource::IamPolicy
 id_format: 'projects/{{project}}/locations/{{location}}/jobs/{{name}}'
 import_format: ['projects/{{project}}/locations/{{location}}/jobs/{{name}}']
 autogen_async: true
+virtual_fields:
+  - !ruby/object:Api::Type::Boolean
+    name: 'deletion_protection'
+    default_value: true
+    description: |
+      Whether Terraform will be prevented from destroying the job. Defaults to true.
+      When a`terraform destroy` or `terraform apply` would delete the job,
+      the command will fail if this field is not set to false in Terraform state.
+      When the field is set to true or unset in Terraform state, a `terraform apply`
+      or `terraform destroy` that would delete the job will fail.
+      When the field is set to false, deleting the job is allowed.
+custom_code: !ruby/object:Provider::Terraform::CustomCode
+  pre_delete: 'templates/terraform/pre_delete/cloudrunv2_job_deletion_policy.go.erb'
 examples:
   - !ruby/object:Provider::Terraform::Examples
     name: 'cloudrunv2_job_basic'
@@ -59,11 +72,15 @@ examples:
       ])"
     vars:
       cloud_run_job_name: 'cloudrun-job'
+    ignore_read_extra:
+      - 'deletion_protection'
   - !ruby/object:Provider::Terraform::Examples
     name: 'cloudrunv2_job_limits'
     primary_resource_id: 'default'
     vars:
       cloud_run_job_name: 'cloudrun-job'
+    ignore_read_extra:
+      - 'deletion_protection'
   - !ruby/object:Provider::Terraform::Examples
     name: 'cloudrunv2_job_sql'
     primary_resource_id: 'default'
@@ -79,6 +96,8 @@ examples:
       deletion_protection: 'false'
     oics_vars_overrides:
       deletion_protection: 'false'
+    ignore_read_extra:
+      - 'deletion_protection'
   - !ruby/object:Provider::Terraform::Examples
     name: 'cloudrunv2_job_vpcaccess'
     primary_resource_id: 'default'
@@ -90,13 +109,17 @@ examples:
       vpc_access_connector_name: 'run-vpc'
       vpc_compute_subnetwork_name: 'run-subnetwork'
       compute_network_name: 'run-network'
+    ignore_read_extra:
+      - 'deletion_protection'
   - !ruby/object:Provider::Terraform::Examples
     name: 'cloudrunv2_job_directvpc'
     primary_resource_id: 'default'
     primary_resource_name: "fmt.Sprintf(\"tf-test-cloudrun-job%s\", context[\"random_suffix\"\
       ])"
     vars:
       cloud_run_job_name: 'cloudrun-job'
+    ignore_read_extra:
+      - 'deletion_protection'
   - !ruby/object:Provider::Terraform::Examples
     name: 'cloudrunv2_job_secret'
     primary_resource_id: 'default'
@@ -106,6 +129,8 @@ examples:
     vars:
       cloud_run_job_name: 'cloudrun-job'
       secret_id: 'secret'
+    ignore_read_extra:
+      - 'deletion_protection'
   - !ruby/object:Provider::Terraform::Examples
     name: 'cloudrunv2_job_emptydir'
     min_version: 'beta'
@@ -114,6 +139,8 @@ examples:
       ])"
     vars:
       cloud_run_job_name: 'cloudrun-job'
+    ignore_read_extra:
+      - 'deletion_protection'
   - !ruby/object:Provider::Terraform::Examples
     name: 'cloudrunv2_job_run_job'
     min_version: beta
@@ -122,6 +149,8 @@ examples:
       ])"
     vars:
       cloud_run_job_name: 'cloudrun-job'
+    ignore_read_extra:
+      - 'deletion_protection'
 parameters:
   - !ruby/object:Api::Type::String
     name: 'location'

diff --git a/mmv1/products/cloudrunv2/Service.yaml b/mmv1/products/cloudrunv2/Service.yaml
@@ -49,18 +49,35 @@ async: !ruby/object:Api::OpAsync
 id_format: 'projects/{{project}}/locations/{{location}}/services/{{name}}'
 import_format: ['projects/{{project}}/locations/{{location}}/services/{{name}}']
 autogen_async: true
+virtual_fields:
+  - !ruby/object:Api::Type::Boolean
+    name: 'deletion_protection'
+    default_value: true
+    description: |
+      Whether Terraform will be prevented from destroying the service. Defaults to true.
+      When a`terraform destroy` or `terraform apply` would delete the service,
+      the command will fail if this field is not set to false in Terraform state.
+      When the field is set to true or unset in Terraform state, a `terraform apply`
+      or `terraform destroy` that would delete the service will fail.
+      When the field is set to false, deleting the service is allowed.
+custom_code: !ruby/object:Provider::Terraform::CustomCode
+  pre_delete: 'templates/terraform/pre_delete/cloudrunv2_service_deletion_policy.go.erb'
 examples:
   - !ruby/object:Provider::Terraform::Examples
     name: 'cloudrunv2_service_basic'
     primary_resource_id: 'default'
     primary_resource_name: "fmt.Sprintf(\"tf-test-cloudrun-service%s\", context[\"random_suffix\"])"
     vars:
       cloud_run_service_name: 'cloudrun-service'
+    ignore_read_extra:
+      - 'deletion_protection'
   - !ruby/object:Provider::Terraform::Examples
     name: 'cloudrunv2_service_limits'
     primary_resource_id: 'default'
     vars:
       cloud_run_service_name: 'cloudrun-service'
+    ignore_read_extra:
+      - 'deletion_protection'
   - !ruby/object:Provider::Terraform::Examples
     name: 'cloudrunv2_service_sql'
     primary_resource_id: 'default'
@@ -74,6 +91,8 @@ examples:
       deletion_protection: 'false'
     oics_vars_overrides:
       deletion_protection: 'false'
+    ignore_read_extra:
+      - 'deletion_protection'
   - !ruby/object:Provider::Terraform::Examples
     name: 'cloudrunv2_service_vpcaccess'
     primary_resource_id: 'default'
@@ -83,25 +102,33 @@ examples:
       vpc_access_connector_name: 'run-vpc'
       vpc_compute_subnetwork_name: 'run-subnetwork'
       compute_network_name: 'run-network'
+    ignore_read_extra:
+      - 'deletion_protection'
   - !ruby/object:Provider::Terraform::Examples
     name: 'cloudrunv2_service_directvpc'
     primary_resource_id: 'default'
     primary_resource_name: "fmt.Sprintf(\"tf-test-cloudrun-srv%s\", context[\"random_suffix\"])"
     vars:
       cloud_run_service_name: 'cloudrun-service'
+    ignore_read_extra:
+      - 'deletion_protection'
   - !ruby/object:Provider::Terraform::Examples
     name: 'cloudrunv2_service_probes'
     primary_resource_id: 'default'
     primary_resource_name: "fmt.Sprintf(\"tf-test-cloudrun-srv%s\", context[\"random_suffix\"])"
     vars:
       cloud_run_service_name: 'cloudrun-service'
+    ignore_read_extra:
+      - 'deletion_protection'
   - !ruby/object:Provider::Terraform::Examples
     name: 'cloudrunv2_service_secret'
     primary_resource_id: 'default'
     primary_resource_name: "fmt.Sprintf(\"tf-test-cloudrun-srv%s\", context[\"random_suffix\"])"
     vars:
       cloud_run_service_name: 'cloudrun-service'
       secret_id: 'secret-1'
+    ignore_read_extra:
+      - 'deletion_protection'
   - !ruby/object:Provider::Terraform::Examples
     name: 'cloudrunv2_service_multicontainer'
     min_version: 'beta'
@@ -110,20 +137,24 @@ examples:
       random_suffix\"])"
     vars:
       cloud_run_service_name: 'cloudrun-service'
-
+    ignore_read_extra:
+      - 'deletion_protection'
   - !ruby/object:Provider::Terraform::Examples
     name: 'cloudrunv2_service_mount_gcs'
     primary_resource_id: 'default'
     primary_resource_name: "fmt.Sprintf(\"tf-test-cloudrun-service-%s\", context[\"random_suffix\"])"
     vars:
       cloud_run_service_name: 'cloudrun-service'
-
+    ignore_read_extra:
+      - 'deletion_protection'
   - !ruby/object:Provider::Terraform::Examples
     name: 'cloudrunv2_service_mount_nfs'
     primary_resource_id: 'default'
     primary_resource_name: "fmt.Sprintf(\"tf-test-cloudrun-service-%s\", context[\"random_suffix\"])"
     vars:
       cloud_run_service_name: 'cloudrun-service'
+    ignore_read_extra:
+      - 'deletion_protection'
 
 parameters:
   - !ruby/object:Api::Type::String

diff --git a/mmv1/templates/terraform/examples/cloudrunv2_job_basic.tf.erb b/mmv1/templates/terraform/examples/cloudrunv2_job_basic.tf.erb
@@ -1,6 +1,7 @@
 resource "google_cloud_run_v2_job" "<%= ctx[:primary_resource_id] %>" {
   name     = "<%= ctx[:vars]['cloud_run_job_name'] %>"
   location = "us-central1"
+  deletion_protection = false
 
   template {
     template {

diff --git a/mmv1/templates/terraform/examples/cloudrunv2_job_directvpc.tf.erb b/mmv1/templates/terraform/examples/cloudrunv2_job_directvpc.tf.erb
@@ -1,6 +1,7 @@
 resource "google_cloud_run_v2_job" "<%= ctx[:primary_resource_id] %>" {
   name     = "<%= ctx[:vars]['cloud_run_job_name'] %>"
   location = "us-central1"
+  deletion_protection = false
   launch_stage = "GA"
   template {
     template{

diff --git a/mmv1/templates/terraform/examples/cloudrunv2_job_emptydir.tf.erb b/mmv1/templates/terraform/examples/cloudrunv2_job_emptydir.tf.erb
@@ -2,6 +2,7 @@ resource "google_cloud_run_v2_job" "<%= ctx[:primary_resource_id] %>" {
   provider = google-beta
   name     = "<%= ctx[:vars]['cloud_run_job_name'] %>"
   location = "us-central1"
+  deletion_protection = false
   launch_stage = "BETA"
   template {
     template {

diff --git a/mmv1/templates/terraform/examples/cloudrunv2_job_limits.tf.erb b/mmv1/templates/terraform/examples/cloudrunv2_job_limits.tf.erb
@@ -1,6 +1,7 @@
 resource "google_cloud_run_v2_job" "<%= ctx[:primary_resource_id] %>" {
   name     = "<%= ctx[:vars]['cloud_run_job_name'] %>"
   location = "us-central1"
+  deletion_protection = false
 
   template {
     template {

diff --git a/mmv1/templates/terraform/examples/cloudrunv2_job_run_job.tf.erb b/mmv1/templates/terraform/examples/cloudrunv2_job_run_job.tf.erb
@@ -2,6 +2,7 @@ resource "google_cloud_run_v2_job" "<%= ctx[:primary_resource_id] %>" {
   provider = google-beta
   name     = "<%= ctx[:vars]['cloud_run_job_name'] %>"
   location = "us-central1"
+  deletion_protection = false
   start_execution_token = "start-once-created"
   template {
     template {

diff --git a/mmv1/templates/terraform/examples/cloudrunv2_job_secret.tf.erb b/mmv1/templates/terraform/examples/cloudrunv2_job_secret.tf.erb
@@ -1,6 +1,7 @@
 resource "google_cloud_run_v2_job" "<%= ctx[:primary_resource_id] %>" {
   name     = "<%= ctx[:vars]['cloud_run_job_name'] %>"
   location = "us-central1"
+  deletion_protection = false
 
   template {
     template {

diff --git a/mmv1/templates/terraform/examples/cloudrunv2_job_sql.tf.erb b/mmv1/templates/terraform/examples/cloudrunv2_job_sql.tf.erb
@@ -1,7 +1,7 @@
 resource "google_cloud_run_v2_job" "<%= ctx[:primary_resource_id] %>" {
   name     = "<%= ctx[:vars]['cloud_run_job_name'] %>"
   location = "us-central1"
-
+  deletion_protection = false
   template {
     template{
       volumes {

diff --git a/mmv1/templates/terraform/examples/cloudrunv2_job_vpcaccess.tf.erb b/mmv1/templates/terraform/examples/cloudrunv2_job_vpcaccess.tf.erb
@@ -1,6 +1,7 @@
 resource "google_cloud_run_v2_job" "<%= ctx[:primary_resource_id] %>" {
   name     = "<%= ctx[:vars]['cloud_run_job_name'] %>"
   location = "us-central1"
+  deletion_protection = false
 
   template {
     template{

diff --git a/mmv1/templates/terraform/examples/cloudrunv2_service_basic.tf.erb b/mmv1/templates/terraform/examples/cloudrunv2_service_basic.tf.erb
@@ -1,6 +1,7 @@
 resource "google_cloud_run_v2_service" "<%= ctx[:primary_resource_id] %>" {
   name     = "<%= ctx[:vars]['cloud_run_service_name'] %>"
   location = "us-central1"
+  deletion_protection = false
   ingress = "INGRESS_TRAFFIC_ALL"
 
   template {

diff --git a/mmv1/templates/terraform/examples/cloudrunv2_service_custom_audiences.tf.erb b/mmv1/templates/terraform/examples/cloudrunv2_service_custom_audiences.tf.erb
@@ -2,6 +2,7 @@ resource "google_cloud_run_v2_service" "<%= ctx[:primary_resource_id] %>" {
   provider = google-beta
   name     = "<%= ctx[:vars]['cloud_run_service_name'] %>"
   location = "us-central1"
+  deletion_protection = false
   launch_stage = "BETA"
   ingress = "INGRESS_TRAFFIC_ALL"
 

diff --git a/mmv1/templates/terraform/examples/cloudrunv2_service_directvpc.tf.erb b/mmv1/templates/terraform/examples/cloudrunv2_service_directvpc.tf.erb
@@ -1,6 +1,7 @@
 resource "google_cloud_run_v2_service" "<%= ctx[:primary_resource_id] %>" {
   name     = "<%= ctx[:vars]['cloud_run_service_name'] %>"
   location = "us-central1"
+  deletion_protection = false
   launch_stage = "GA"
   template {
     containers {

diff --git a/mmv1/templates/terraform/examples/cloudrunv2_service_limits.tf.erb b/mmv1/templates/terraform/examples/cloudrunv2_service_limits.tf.erb
@@ -1,6 +1,7 @@
 resource "google_cloud_run_v2_service" "<%= ctx[:primary_resource_id] %>" {
   name     = "<%= ctx[:vars]['cloud_run_service_name'] %>"
   location = "us-central1"
+  deletion_protection = false
   ingress = "INGRESS_TRAFFIC_ALL"
 
   template {

diff --git a/mmv1/templates/terraform/examples/cloudrunv2_service_mount_gcs.tf.erb b/mmv1/templates/terraform/examples/cloudrunv2_service_mount_gcs.tf.erb
@@ -2,6 +2,7 @@ resource "google_cloud_run_v2_service" "<%= ctx[:primary_resource_id] %>" {
   name     = "<%= ctx[:vars]['cloud_run_service_name'] %>"
 
   location     = "us-central1"
+  deletion_protection = false
   launch_stage = "BETA"
 
   template {

diff --git a/mmv1/templates/terraform/examples/cloudrunv2_service_mount_nfs.tf.erb b/mmv1/templates/terraform/examples/cloudrunv2_service_mount_nfs.tf.erb
@@ -2,6 +2,7 @@ resource "google_cloud_run_v2_service" "<%= ctx[:primary_resource_id] %>" {
   name     = "<%= ctx[:vars]['cloud_run_service_name'] %>"
 
   location     = "us-central1"
+  deletion_protection = false
   ingress      = "INGRESS_TRAFFIC_ALL"
   launch_stage = "BETA"
 

diff --git a/mmv1/templates/terraform/examples/cloudrunv2_service_multicontainer.tf.erb b/mmv1/templates/terraform/examples/cloudrunv2_service_multicontainer.tf.erb
@@ -2,6 +2,7 @@ resource "google_cloud_run_v2_service" "<%= ctx[:primary_resource_id] %>" {
   provider = google-beta
   name     = "<%= ctx[:vars]['cloud_run_service_name'] %>"
   location = "us-central1"
+  deletion_protection = false
   launch_stage = "BETA"
   ingress = "INGRESS_TRAFFIC_ALL"
   template {

diff --git a/mmv1/templates/terraform/examples/cloudrunv2_service_probes.tf.erb b/mmv1/templates/terraform/examples/cloudrunv2_service_probes.tf.erb
@@ -1,6 +1,7 @@
 resource "google_cloud_run_v2_service" "<%= ctx[:primary_resource_id] %>" {
   name     = "<%= ctx[:vars]['cloud_run_service_name'] %>"
   location = "us-central1"
+  deletion_protection = false
 
   template {
     containers {

diff --git a/mmv1/templates/terraform/examples/cloudrunv2_service_secret.tf.erb b/mmv1/templates/terraform/examples/cloudrunv2_service_secret.tf.erb
@@ -1,6 +1,7 @@
 resource "google_cloud_run_v2_service" "<%= ctx[:primary_resource_id] %>" {
   name     = "<%= ctx[:vars]['cloud_run_service_name'] %>"
   location = "us-central1"
+  deletion_protection = false
   ingress = "INGRESS_TRAFFIC_ALL"
 
   template {

diff --git a/mmv1/templates/terraform/examples/cloudrunv2_service_sql.tf.erb b/mmv1/templates/terraform/examples/cloudrunv2_service_sql.tf.erb
@@ -1,6 +1,7 @@
 resource "google_cloud_run_v2_service" "<%= ctx[:primary_resource_id] %>" {
   name     = "<%= ctx[:vars]['cloud_run_service_name'] %>"
   location = "us-central1"
+  deletion_protection = false
   ingress = "INGRESS_TRAFFIC_ALL"
 
   template {

diff --git a/mmv1/templates/terraform/examples/cloudrunv2_service_vpcaccess.tf.erb b/mmv1/templates/terraform/examples/cloudrunv2_service_vpcaccess.tf.erb
@@ -1,6 +1,7 @@
 resource "google_cloud_run_v2_service" "<%= ctx[:primary_resource_id] %>" {
   name     = "<%= ctx[:vars]['cloud_run_service_name'] %>"
   location = "us-central1"
+  deletion_protection = false
 
   template {
     containers {

diff --git a/mmv1/templates/terraform/examples/go/cloudrunv2_job_basic.tf.tmpl b/mmv1/templates/terraform/examples/go/cloudrunv2_job_basic.tf.tmpl
@@ -1,6 +1,7 @@
 resource "google_cloud_run_v2_job" "{{$.PrimaryResourceId}}" {
   name     = "{{index $.Vars "cloud_run_job_name"}}"
   location = "us-central1"
+  deletion_protection = false
 
   template {
     template {

diff --git a/mmv1/templates/terraform/examples/go/cloudrunv2_job_directvpc.tf.tmpl b/mmv1/templates/terraform/examples/go/cloudrunv2_job_directvpc.tf.tmpl
@@ -1,6 +1,7 @@
 resource "google_cloud_run_v2_job" "{{$.PrimaryResourceId}}" {
   name     = "{{index $.Vars "cloud_run_job_name"}}"
   location = "us-central1"
+  deletion_protection = false
   launch_stage = "GA"
   template {
     template{

diff --git a/mmv1/templates/terraform/examples/go/cloudrunv2_job_emptydir.tf.tmpl b/mmv1/templates/terraform/examples/go/cloudrunv2_job_emptydir.tf.tmpl
@@ -2,6 +2,7 @@ resource "google_cloud_run_v2_job" "{{$.PrimaryResourceId}}" {
   provider = google-beta
   name     = "{{index $.Vars "cloud_run_job_name"}}"
   location = "us-central1"
+  deletion_protection = false
   launch_stage = "BETA"
   template {
     template {

diff --git a/mmv1/templates/terraform/examples/go/cloudrunv2_job_limits.tf.tmpl b/mmv1/templates/terraform/examples/go/cloudrunv2_job_limits.tf.tmpl
@@ -1,6 +1,7 @@
 resource "google_cloud_run_v2_job" "{{$.PrimaryResourceId}}" {
   name     = "{{index $.Vars "cloud_run_job_name"}}"
   location = "us-central1"
+  deletion_protection = false
 
   template {
     template {

diff --git a/mmv1/templates/terraform/examples/go/cloudrunv2_job_run_job.tf.tmpl b/mmv1/templates/terraform/examples/go/cloudrunv2_job_run_job.tf.tmpl
@@ -2,6 +2,7 @@ resource "google_cloud_run_v2_job" "{{$.PrimaryResourceId}}" {
   provider = google-beta
   name     = "{{index $.Vars "cloud_run_job_name"}}"
   location = "us-central1"
+  deletion_protection = false
   start_execution_token = "start-once-created"
   template {
     template {

diff --git a/mmv1/templates/terraform/examples/go/cloudrunv2_job_secret.tf.tmpl b/mmv1/templates/terraform/examples/go/cloudrunv2_job_secret.tf.tmpl
@@ -1,6 +1,7 @@
 resource "google_cloud_run_v2_job" "{{$.PrimaryResourceId}}" {
   name     = "{{index $.Vars "cloud_run_job_name"}}"
   location = "us-central1"
+  deletion_protection = false
 
   template {
     template {