From c6331251bfd1e9842461001fa15647f478d78530 Mon Sep 17 00:00:00 2001
From: John Dewey <john.dewey@corelight.com>
Date: Thu, 6 Jun 2024 10:23:35 -0700
Subject: [PATCH] Add tags to the README's usage

---
 README.md                                 | 17 ++++++++++++-----
 modules/secondary_event_rule/variables.tf |  4 ++--
 modules/sensor_iam/variables.tf           |  4 ++--
 variables.tf                              |  4 ++--
 4 files changed, 18 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index 8c1ab36..1aa34be 100644
--- a/README.md
+++ b/README.md
@@ -3,24 +3,31 @@
 <img src="docs/overview.svg" alt="overview">
 
 ## Usage
-```terraform
 
+```terraform
 module "enrichment" {
   source = "github.com/corelight/terraform-aws-enrichment"
 
   corelight_cloud_enrichment_image = "123456789111.dkr.ecr.us-east-1.amazonaws.com/corelight-sensor-enrichment-aws"
   corelight_cloud_enrichment_image_tag = "0.1.0"
   enrichment_bucket_name = "corelight-enrichment"
+
+  tags = {
+    terraform : true,
+    example : true,
+    purpose : "Corelight"
+  }
 }
 ```
 
 ## Preparation
 
-Image based Lambdas must be deployed from a private Elastic Container Registry (ECR) 
-repository and therefore the data collection serverless container image provided by 
+Image based Lambdas must be deployed from a private Elastic Container Registry (ECR)
+repository and therefore the data collection serverless container image provided by
 Corelight must be copied from Dockerhub and pushed to your own ECR repository.
 
 #### Copying the Corelight image
+
 Log into the destination ECR
 
 ```bash
@@ -49,7 +56,7 @@ docker pull $SRC_IMAGE
 # Copy Image to ECR
 skopeo copy docker://$SRC_IMAGE docker://$DST_IMAGE --dest-tls-verify
 ```
-If you would prefer not to use Skopeo then the image will need to be pulled, tagged, and pushed 
+If you would prefer not to use Skopeo then the image will need to be pulled, tagged, and pushed
 to ECR manually.
 
 ```bash
@@ -85,4 +92,4 @@ Deployment examples can be found [here](examples)
 
 The project is licensed under the [MIT][] license.
 
-[MIT]: LICENSE
\ No newline at end of file
+[MIT]: LICENSE
diff --git a/modules/secondary_event_rule/variables.tf b/modules/secondary_event_rule/variables.tf
index 59545a6..fd772d8 100644
--- a/modules/secondary_event_rule/variables.tf
+++ b/modules/secondary_event_rule/variables.tf
@@ -15,7 +15,7 @@ variable "cross_region_eventbridge_role_arn" {
 
 ### Variables with Defaults
 variable "tags" {
-  description = "Any tags that should be applied to resources deployed by the module"
+  description = "(optional) Any tags that should be applied to resources deployed by the module"
   type        = object({})
   default     = {}
-}
\ No newline at end of file
+}
diff --git a/modules/sensor_iam/variables.tf b/modules/sensor_iam/variables.tf
index 690e9ad..4fd4cce 100644
--- a/modules/sensor_iam/variables.tf
+++ b/modules/sensor_iam/variables.tf
@@ -17,7 +17,7 @@ variable "corelight_sensor_policy_name" {
 }
 
 variable "tags" {
-  description = "Any tags that should be applied to resources deployed by the module"
+  description = "(optional) Any tags that should be applied to resources deployed by the module"
   type        = object({})
   default     = {}
-}
\ No newline at end of file
+}
diff --git a/variables.tf b/variables.tf
index ab64d4f..939435a 100644
--- a/variables.tf
+++ b/variables.tf
@@ -123,7 +123,7 @@ variable "scheduled_sync_regions" {
 }
 
 variable "tags" {
-  description = "Any tags that should be applied to resources deployed by the module"
+  description = "(optional) Any tags that should be applied to resources deployed by the module"
   type        = object({})
   default     = {}
-}
\ No newline at end of file
+}