From c7fe6da12e59d30ede80c6b7c14d526240aed516 Mon Sep 17 00:00:00 2001 From: Julio Castillo Date: Fri, 11 Nov 2022 19:24:18 +0100 Subject: [PATCH] Update READMEs --- modules/bigquery-dataset/README.md | 17 +++++++++-------- modules/gcs/README.md | 12 ++++++------ modules/logging-bucket/README.md | 3 ++- modules/pubsub/README.md | 9 +++++---- tests/modules/folder/test_plan_logging.py | 2 -- 5 files changed, 22 insertions(+), 21 deletions(-) diff --git a/modules/bigquery-dataset/README.md b/modules/bigquery-dataset/README.md index 29acba39c..ebca51e24 100644 --- a/modules/bigquery-dataset/README.md +++ b/modules/bigquery-dataset/README.md @@ -196,13 +196,14 @@ module "bigquery-dataset" { | name | description | sensitive | |---|---|:---:| -| [dataset](outputs.tf#L17) | Dataset resource. | | -| [dataset_id](outputs.tf#L22) | Dataset id. | | -| [id](outputs.tf#L34) | Fully qualified dataset id. | | -| [self_link](outputs.tf#L46) | Dataset self link. | | -| [table_ids](outputs.tf#L58) | Map of fully qualified table ids keyed by table ids. | | -| [tables](outputs.tf#L63) | Table resources. | | -| [view_ids](outputs.tf#L68) | Map of fully qualified view ids keyed by view ids. | | -| [views](outputs.tf#L73) | View resources. | | +| [as_logging_destination](outputs.tf#L17) | Parameters to use this dataset as a log sink destination. | | +| [dataset](outputs.tf#L32) | Dataset resource. | | +| [dataset_id](outputs.tf#L37) | Dataset id. | | +| [id](outputs.tf#L49) | Fully qualified dataset id. | | +| [self_link](outputs.tf#L61) | Dataset self link. | | +| [table_ids](outputs.tf#L73) | Map of fully qualified table ids keyed by table ids. | | +| [tables](outputs.tf#L78) | Table resources. | | +| [view_ids](outputs.tf#L83) | Map of fully qualified view ids keyed by view ids. | | +| [views](outputs.tf#L88) | View resources. | | diff --git a/modules/gcs/README.md b/modules/gcs/README.md index 7e6cc22f4..11b4b6ba3 100644 --- a/modules/gcs/README.md +++ b/modules/gcs/README.md @@ -134,11 +134,11 @@ module "bucket-gcs-notification" { | name | description | sensitive | |---|---|:---:| -| [bucket](outputs.tf#L17) | Bucket resource. | | -| [id](outputs.tf#L28) | Bucket ID (same as name). | | -| [name](outputs.tf#L37) | Bucket name. | | -| [notification](outputs.tf#L46) | GCS Notification self link. | | -| [topic](outputs.tf#L51) | Topic ID used by GCS. | | -| [url](outputs.tf#L56) | Bucket URL. | | +| [as_logging_destination](outputs.tf#L17) | Parameters to use this bucket as a log sink destination. | | +| [bucket](outputs.tf#L29) | Bucket resource. | | +| [name](outputs.tf#L34) | Bucket name. | | +| [notification](outputs.tf#L43) | GCS Notification self link. | | +| [topic](outputs.tf#L48) | Topic ID used by GCS. | | +| [url](outputs.tf#L53) | Bucket URL. | | diff --git a/modules/logging-bucket/README.md b/modules/logging-bucket/README.md index 7af82ccb3..5328b943d 100644 --- a/modules/logging-bucket/README.md +++ b/modules/logging-bucket/README.md @@ -56,6 +56,7 @@ module "bucket-default" { | name | description | sensitive | |---|---|:---:| -| [id](outputs.tf#L17) | ID of the created bucket. | | +| [as_logging_destination](outputs.tf#L17) | Parameters to use this bucket as a log sink destination. | | +| [id](outputs.tf#L30) | ID of the created bucket. | | diff --git a/modules/pubsub/README.md b/modules/pubsub/README.md index b75aaf6d9..a83391102 100644 --- a/modules/pubsub/README.md +++ b/modules/pubsub/README.md @@ -111,9 +111,10 @@ module "pubsub" { | name | description | sensitive | |---|---|:---:| -| [id](outputs.tf#L17) | Topic id. | | -| [subscription_id](outputs.tf#L25) | Subscription ids. | | -| [subscriptions](outputs.tf#L35) | Subscription resources. | | -| [topic](outputs.tf#L43) | Topic resource. | | +| [as_logging_destination](outputs.tf#L17) | Parameters to use this topic as a log sink destination. | | +| [id](outputs.tf#L28) | Topic id. | | +| [subscription_id](outputs.tf#L36) | Subscription ids. | | +| [subscriptions](outputs.tf#L46) | Subscription resources. | | +| [topic](outputs.tf#L54) | Topic resource. | | diff --git a/tests/modules/folder/test_plan_logging.py b/tests/modules/folder/test_plan_logging.py index be6271557..6b305d0b1 100644 --- a/tests/modules/folder/test_plan_logging.py +++ b/tests/modules/folder/test_plan_logging.py @@ -14,8 +14,6 @@ from collections import Counter -from icecream import ic - def test_sinks(plan_runner): "Test folder-level sinks."