Replace "Pubsub Subscription Different Project" example with making a…

…ll examples cross-project-friendly (#9637) * Fix "Pubsub Subscription Different Project" example PR #2342 changed this example from using `id` to `name`, which removed the project ID from the topic. However, the point of this example is to show how to set up a cross-project subscription, so the example no longer works. This change reverts that change from PR #2342. Fixes hashicorp/terraform-provider-google#11642. Fixes hashicorp/terraform-provider-google#6024. * Make all examples cross-project-friendly and update topic description * Fix typo --------- Co-authored-by: Stephen Lewis (Burrows) <[email protected]>
GoogleCloudPlatform · Dec 14, 2023 · b3ae8dc · b3ae8dc
1 parent a080fd3
commit b3ae8dc
Show file tree

Hide file tree

Showing 8 changed files with 9 additions and 26 deletions.
diff --git a/mmv1/products/pubsub/Subscription.yaml b/mmv1/products/pubsub/Subscription.yaml
@@ -42,15 +42,6 @@ examples:
     vars:
       topic_name: 'example-topic'
       subscription_name: 'example-subscription'
-  - !ruby/object:Provider::Terraform::Examples
-    name: 'pubsub_subscription_different_project'
-    primary_resource_id: 'example'
-    skip_test: true
-    vars:
-      topic_name: 'example-topic'
-      topic_project: 'topic-project'
-      subscription_name: 'example-subscription'
-      subscription_project: 'subscription-project'
   - !ruby/object:Provider::Terraform::Examples
     name: 'pubsub_subscription_dead_letter'
     primary_resource_id: 'example'
@@ -101,7 +92,9 @@ properties:
     resource: 'Topic'
     imports: 'name'
     description: |
-      A reference to a Topic resource.
+      A reference to a Topic resource, of the form projects/{project}/topics/{{name}}
+      (as in the id property of a google_pubsub_topic), or just a topic name if
+      the topic is in the same project as the subscription.
     required: true
     immutable: true
     pattern: 'projects/{{project}}/topics/{{topic}}'

diff --git a/mmv1/templates/terraform/examples/pubsub_subscription_dead_letter.tf.erb b/mmv1/templates/terraform/examples/pubsub_subscription_dead_letter.tf.erb
@@ -8,7 +8,7 @@ resource "google_pubsub_topic" "<%= ctx[:primary_resource_id] %>_dead_letter" {
 
 resource "google_pubsub_subscription" "<%= ctx[:primary_resource_id] %>" {
   name  = "<%= ctx[:vars]['subscription_name'] %>"
-  topic = google_pubsub_topic.<%= ctx[:primary_resource_id] %>.name
+  topic = google_pubsub_topic.<%= ctx[:primary_resource_id] %>.id
 
   dead_letter_policy {
     dead_letter_topic = google_pubsub_topic.<%= ctx[:primary_resource_id] %>_dead_letter.id

diff --git a/mmv1/templates/terraform/examples/pubsub_subscription_different_project.tf.erb b/mmv1/templates/terraform/examples/pubsub_subscription_different_project.tf.erb
diff --git a/mmv1/templates/terraform/examples/pubsub_subscription_pull.tf.erb b/mmv1/templates/terraform/examples/pubsub_subscription_pull.tf.erb
@@ -4,7 +4,7 @@ resource "google_pubsub_topic" "<%= ctx[:primary_resource_id] %>" {
 
 resource "google_pubsub_subscription" "<%= ctx[:primary_resource_id] %>" {
   name  = "<%= ctx[:vars]['subscription_name'] %>"
-  topic = google_pubsub_topic.<%= ctx[:primary_resource_id] %>.name
+  topic = google_pubsub_topic.<%= ctx[:primary_resource_id] %>.id
 
   labels = {
     foo = "bar"

diff --git a/mmv1/templates/terraform/examples/pubsub_subscription_push.tf.erb b/mmv1/templates/terraform/examples/pubsub_subscription_push.tf.erb
@@ -4,7 +4,7 @@ resource "google_pubsub_topic" "<%= ctx[:primary_resource_id] %>" {
 
 resource "google_pubsub_subscription" "<%= ctx[:primary_resource_id] %>" {
   name  = "<%= ctx[:vars]['subscription_name'] %>"
-  topic = google_pubsub_topic.<%= ctx[:primary_resource_id] %>.name
+  topic = google_pubsub_topic.<%= ctx[:primary_resource_id] %>.id
 
   ack_deadline_seconds = 20
 

diff --git a/mmv1/templates/terraform/examples/pubsub_subscription_push_bq.tf.erb b/mmv1/templates/terraform/examples/pubsub_subscription_push_bq.tf.erb
@@ -4,7 +4,7 @@ resource "google_pubsub_topic" "<%= ctx[:primary_resource_id] %>" {
 
 resource "google_pubsub_subscription" "<%= ctx[:primary_resource_id] %>" {
   name  = "<%= ctx[:vars]['subscription_name'] %>"
-  topic = google_pubsub_topic.<%= ctx[:primary_resource_id] %>.name
+  topic = google_pubsub_topic.<%= ctx[:primary_resource_id] %>.id
 
   bigquery_config {
     table = "${google_bigquery_table.test.project}.${google_bigquery_table.test.dataset_id}.${google_bigquery_table.test.table_id}"

diff --git a/mmv1/templates/terraform/examples/pubsub_subscription_push_cloudstorage.tf.erb b/mmv1/templates/terraform/examples/pubsub_subscription_push_cloudstorage.tf.erb
@@ -10,7 +10,7 @@ resource "google_pubsub_topic" "<%= ctx[:primary_resource_id] %>" {
 
 resource "google_pubsub_subscription" "<%= ctx[:primary_resource_id] %>" {
   name  = "<%= ctx[:vars]['subscription_name'] %>"
-  topic = google_pubsub_topic.<%= ctx[:primary_resource_id] %>.name
+  topic = google_pubsub_topic.<%= ctx[:primary_resource_id] %>.id
 
   cloud_storage_config {
     bucket = google_storage_bucket.<%= ctx[:primary_resource_id] %>.name

diff --git a/mmv1/templates/terraform/examples/pubsub_subscription_push_cloudstorage_avro.tf.erb b/mmv1/templates/terraform/examples/pubsub_subscription_push_cloudstorage_avro.tf.erb
@@ -10,7 +10,7 @@ resource "google_pubsub_topic" "<%= ctx[:primary_resource_id] %>" {
 
 resource "google_pubsub_subscription" "<%= ctx[:primary_resource_id] %>" {
   name  = "<%= ctx[:vars]['subscription_name'] %>"
-  topic = google_pubsub_topic.<%= ctx[:primary_resource_id] %>.name
+  topic = google_pubsub_topic.<%= ctx[:primary_resource_id] %>.id
 
   cloud_storage_config {
     bucket = google_storage_bucket.<%= ctx[:primary_resource_id] %>.name