fix: trim main module outputs (#174)

* clean main module outputs * remove depends on from outputs not used in the examples.
GoogleCloudPlatform · Oct 13, 2021 · 1abe7c1 · 1abe7c1
1 parent d5bfa74
commit 1abe7c1
Show file tree

Hide file tree

Showing 7 changed files with 93 additions and 212 deletions.
diff --git a/README.md b/README.md
@@ -80,15 +80,9 @@ module "secured_data_warehouse" {
 | Name | Description |
 |------|-------------|
 | cmek\_bigquery\_crypto\_key | The Customer Managed Crypto Key for the BigQuery service. |
-| cmek\_bigquery\_crypto\_key\_name | The Customer Managed Crypto Key name for the BigQuery service. |
 | cmek\_confidential\_bigquery\_crypto\_key | The Customer Managed Crypto Key for the confidential BigQuery service. |
-| cmek\_confidential\_bigquery\_crypto\_key\_name | The Customer Managed Crypto Key name for the confidential BigQuery service. |
 | cmek\_ingestion\_crypto\_key | The Customer Managed Crypto Key for the Ingestion crypto boundary. |
-| cmek\_ingestion\_crypto\_key\_name | The Customer Managed Crypto Key name for the Ingestion crypto boundary. |
-| cmek\_keyring\_full\_name | The Keyring full name for the KMS Customer Managed Encryption Keys. |
-| cmek\_keyring\_name | The Keyring name for the KMS Customer Managed Encryption Keys. |
 | cmek\_reidentification\_crypto\_key | The Customer Managed Crypto Key for the Confidential crypto boundary. |
-| cmek\_reidentification\_crypto\_key\_name | The Customer Managed Crypto Key name for the reidentification crypto boundary. |
 | confidential\_access\_level\_name | Access context manager access level name. |
 | confidential\_data\_dataflow\_bucket\_name | The name of the bucket created for dataflow in the confidential data pipeline. |
 | confidential\_dataflow\_controller\_service\_account\_email | The confidential Dataflow controller service account email. See https://cloud.google.com/dataflow/docs/concepts/security-and-permissions#specifying_a_user-managed_controller_service_account. |

diff --git a/examples/simple_example/README.md b/examples/simple_example/README.md
@@ -23,13 +23,9 @@ This example illustrates how to use the `secured-data-warehouse` module.
 | Name | Description |
 |------|-------------|
 | cmek\_bigquery\_crypto\_key | The Customer Managed Crypto Key for the BigQuery service. |
-| cmek\_bigquery\_crypto\_key\_name | The Customer Managed Crypto Key name for the BigQuery service. |
-| cmek\_confidential\_bigquery\_crypto\_key\_name | The Customer Managed Crypto Key name for the confidential BigQuery service. |
+| cmek\_confidential\_bigquery\_crypto\_key | The Customer Managed Crypto Key for the confidential BigQuery service. |
 | cmek\_ingestion\_crypto\_key | The Customer Managed Crypto Key for the Ingestion crypto boundary. |
-| cmek\_ingestion\_crypto\_key\_name | The Customer Managed Crypto Key name for the Ingestion crypto boundary. |
-| cmek\_keyring\_full\_name | The Keyring full name for the KMS Customer Managed Encryption Keys. |
-| cmek\_keyring\_name | The Keyring name for the KMS Customer Managed Encryption Keys. |
-| cmek\_reidentification\_crypto\_key\_name | The Customer Managed Crypto Key name for the reidentification crypto boundary. |
+| cmek\_reidentification\_crypto\_key | The Customer Managed Crypto Key for the reidentification crypto boundary. |
 | data\_ingest\_bigquery\_dataset | The bigquery dataset created for data ingest pipeline. |
 | data\_ingest\_bucket\_name | The name of the bucket created for data ingest pipeline. |
 | data\_ingest\_topic\_name | The topic created for data ingest pipeline. |

diff --git a/examples/simple_example/outputs.tf b/examples/simple_example/outputs.tf
@@ -54,16 +54,6 @@ output "data_ingestion_service_perimeter_name" {
   value       = module.secured_data_warehouse.data_ingestion_service_perimeter_name
 }
 
-output "cmek_keyring_full_name" {
-  description = "The Keyring full name for the KMS Customer Managed Encryption Keys."
-  value       = module.secured_data_warehouse.cmek_keyring_full_name
-}
-
-output "cmek_keyring_name" {
-  description = "The Keyring name for the KMS Customer Managed Encryption Keys."
-  value       = module.secured_data_warehouse.cmek_keyring_name
-}
-
 output "cmek_ingestion_crypto_key" {
   description = "The Customer Managed Crypto Key for the Ingestion crypto boundary."
   value       = module.secured_data_warehouse.cmek_ingestion_crypto_key
@@ -74,22 +64,13 @@ output "cmek_bigquery_crypto_key" {
   value       = module.secured_data_warehouse.cmek_bigquery_crypto_key
 }
 
-output "cmek_ingestion_crypto_key_name" {
-  description = "The Customer Managed Crypto Key name for the Ingestion crypto boundary."
-  value       = module.secured_data_warehouse.cmek_ingestion_crypto_key_name
-}
-
-output "cmek_bigquery_crypto_key_name" {
-  description = "The Customer Managed Crypto Key name for the BigQuery service."
-  value       = module.secured_data_warehouse.cmek_bigquery_crypto_key_name
-}
 
-output "cmek_reidentification_crypto_key_name" {
-  description = "The Customer Managed Crypto Key name for the reidentification crypto boundary."
-  value       = module.secured_data_warehouse.cmek_reidentification_crypto_key_name
+output "cmek_reidentification_crypto_key" {
+  description = "The Customer Managed Crypto Key for the reidentification crypto boundary."
+  value       = module.secured_data_warehouse.cmek_reidentification_crypto_key
 }
 
-output "cmek_confidential_bigquery_crypto_key_name" {
-  description = "The Customer Managed Crypto Key name for the confidential BigQuery service."
-  value       = module.secured_data_warehouse.cmek_confidential_bigquery_crypto_key_name
+output "cmek_confidential_bigquery_crypto_key" {
+  description = "The Customer Managed Crypto Key for the confidential BigQuery service."
+  value       = module.secured_data_warehouse.cmek_confidential_bigquery_crypto_key
 }
diff --git a/outputs.tf b/outputs.tf
@@ -23,22 +23,23 @@ output "dataflow_controller_service_account_email" {
   ]
 }
 
-output "storage_writer_service_account_email" {
-  description = "The Storage writer service account email. Should be used to write data to the buckets the ingestion pipeline reads from."
-  value       = module.data_ingestion.storage_writer_service_account_email
+output "confidential_dataflow_controller_service_account_email" {
+  description = "The confidential Dataflow controller service account email. See https://cloud.google.com/dataflow/docs/concepts/security-and-permissions#specifying_a_user-managed_controller_service_account."
+  value       = module.bigquery_confidential_data.confidential_dataflow_controller_service_account_email
 
   depends_on = [
     time_sleep.wait_for_bridge_propagation
   ]
 }
 
+output "storage_writer_service_account_email" {
+  description = "The Storage writer service account email. Should be used to write data to the buckets the ingestion pipeline reads from."
+  value       = module.data_ingestion.storage_writer_service_account_email
+}
+
 output "pubsub_writer_service_account_email" {
   description = "The PubSub writer service account email. Should be used to write data to the PubSub topics the ingestion pipeline reads from."
   value       = module.data_ingestion.pubsub_writer_service_account_email
-
-  depends_on = [
-    time_sleep.wait_for_bridge_propagation
-  ]
 }
 
 output "data_ingest_bucket_name" {
@@ -89,73 +90,31 @@ output "data_ingest_bigquery_dataset" {
 output "data_ingestion_access_level_name" {
   description = "Access context manager access level name."
   value       = module.data_ingestion_vpc_sc.access_level_name
-
-  depends_on = [
-    time_sleep.wait_for_bridge_propagation
-  ]
 }
 
 output "data_ingestion_service_perimeter_name" {
   description = "Access context manager service perimeter name."
   value       = module.data_ingestion_vpc_sc.service_perimeter_name
-
-  depends_on = [
-    time_sleep.wait_for_bridge_propagation
-  ]
 }
 
 output "data_governance_access_level_name" {
   description = "Access context manager access level name."
   value       = module.data_governance_vpc_sc.access_level_name
-
-  depends_on = [
-    time_sleep.wait_for_bridge_propagation
-  ]
 }
 
 output "data_governance_service_perimeter_name" {
   description = "Access context manager service perimeter name."
   value       = module.data_governance_vpc_sc.service_perimeter_name
-
-  depends_on = [
-    time_sleep.wait_for_bridge_propagation
-  ]
 }
 
 output "confidential_access_level_name" {
   description = "Access context manager access level name."
   value       = module.confidential_data_vpc_sc.access_level_name
-
-  depends_on = [
-    time_sleep.wait_for_bridge_propagation
-  ]
 }
 
 output "confidential_service_perimeter_name" {
   description = "Access context manager service perimeter name."
   value       = module.confidential_data_vpc_sc.service_perimeter_name
-
-  depends_on = [
-    time_sleep.wait_for_bridge_propagation
-  ]
-}
-
-output "cmek_keyring_full_name" {
-  description = "The Keyring full name for the KMS Customer Managed Encryption Keys."
-  value       = module.data_governance.cmek_keyring_full_name
-
-  depends_on = [
-    time_sleep.wait_for_bridge_propagation
-  ]
-}
-
-output "cmek_keyring_name" {
-  description = "The Keyring name for the KMS Customer Managed Encryption Keys."
-  value       = module.data_governance.cmek_keyring_name
-
-  depends_on = [
-    time_sleep.wait_for_bridge_propagation
-  ]
 }
 
 output "cmek_ingestion_crypto_key" {
@@ -193,48 +152,3 @@ output "cmek_confidential_bigquery_crypto_key" {
     time_sleep.wait_for_bridge_propagation
   ]
 }
-
-output "cmek_ingestion_crypto_key_name" {
-  description = "The Customer Managed Crypto Key name for the Ingestion crypto boundary."
-  value       = module.data_governance.cmek_ingestion_crypto_key_name
-
-  depends_on = [
-    time_sleep.wait_for_bridge_propagation
-  ]
-}
-
-output "cmek_bigquery_crypto_key_name" {
-  description = "The Customer Managed Crypto Key name for the BigQuery service."
-  value       = module.data_governance.cmek_bigquery_crypto_key_name
-
-  depends_on = [
-    time_sleep.wait_for_bridge_propagation
-  ]
-}
-
-output "cmek_reidentification_crypto_key_name" {
-  description = "The Customer Managed Crypto Key name for the reidentification crypto boundary."
-  value       = module.data_governance.cmek_reidentification_crypto_key_name
-
-  depends_on = [
-    time_sleep.wait_for_bridge_propagation
-  ]
-}
-
-output "cmek_confidential_bigquery_crypto_key_name" {
-  description = "The Customer Managed Crypto Key name for the confidential BigQuery service."
-  value       = module.data_governance.cmek_confidential_bigquery_crypto_key_name
-
-  depends_on = [
-    time_sleep.wait_for_bridge_propagation
-  ]
-}
-
-output "confidential_dataflow_controller_service_account_email" {
-  description = "The confidential Dataflow controller service account email. See https://cloud.google.com/dataflow/docs/concepts/security-and-permissions#specifying_a_user-managed_controller_service_account."
-  value       = module.bigquery_confidential_data.confidential_dataflow_controller_service_account_email
-
-  depends_on = [
-    time_sleep.wait_for_bridge_propagation
-  ]
-}
diff --git a/test/fixtures/simple_example/outputs.tf b/test/fixtures/simple_example/outputs.tf
@@ -80,32 +80,22 @@ output "service_perimeter_name" {
   value       = module.simple_example.data_ingestion_service_perimeter_name
 }
 
-output "cmek_keyring_name" {
-  description = "The Keyring name for the KMS Customer Managed Encryption Keys."
-  value       = module.simple_example.cmek_keyring_name
+output "cmek_ingestion_crypto_key" {
+  description = "The Customer Managed Crypto Key for the Ingestion crypto boundary."
+  value       = module.simple_example.cmek_ingestion_crypto_key
 }
 
-output "cmek_keyring_full_name" {
-  description = "The Keyring full name for the KMS Customer Managed Encryption Keys."
-  value       = module.simple_example.cmek_keyring_full_name
+output "cmek_bigquery_crypto_key" {
+  description = "The Customer Managed Crypto Key for the BigQuery service."
+  value       = module.simple_example.cmek_bigquery_crypto_key
 }
 
-output "cmek_ingestion_crypto_key_name" {
-  description = "The Customer Managed Crypto Key name for the Ingestion crypto boundary."
-  value       = module.simple_example.cmek_ingestion_crypto_key_name
+output "cmek_reidentification_crypto_key" {
+  description = "The Customer Managed Crypto Key for the reidentification crypto boundary."
+  value       = module.simple_example.cmek_reidentification_crypto_key
 }
 
-output "cmek_bigquery_crypto_key_name" {
-  description = "The Customer Managed Crypto Key name for the BigQuery service."
-  value       = module.simple_example.cmek_bigquery_crypto_key_name
-}
-
-output "cmek_reidentification_crypto_key_name" {
-  description = "The Customer Managed Crypto Key name for the reidentification crypto boundary."
-  value       = module.simple_example.cmek_reidentification_crypto_key_name
-}
-
-output "cmek_confidential_bigquery_crypto_key_name" {
-  description = "The Customer Managed Crypto Key name for the confidential BigQuery service."
-  value       = module.simple_example.cmek_confidential_bigquery_crypto_key_name
+output "cmek_confidential_bigquery_crypto_key" {
+  description = "The Customer Managed Crypto Key for the confidential BigQuery service."
+  value       = module.simple_example.cmek_confidential_bigquery_crypto_key
 }