add docs on profile

terraform-modules · Jan 31, 2023 · e1fe63a · e1fe63a
1 parent 1379d6f
commit e1fe63a
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -45,6 +45,7 @@ locals {
 module "images" {
   source = "git@github.e.it.census.gov:terraform-modules/aws-ecr-copy-images.git"
 
+  profile          = var.profile
   application_list = ["app1", "app2"]
   application_name = "org-project"
   image_config     = local.image_config
@@ -74,6 +75,11 @@ org-project/nodejs-14	817869416306.dkr.ecr.us-gov-east-1.amazonaws.com/org-proje
 org-project/openjdk-8	817869416306.dkr.ecr.us-gov-east-1.amazonaws.com/org-project/openjdk-8 August 22, 2022, 12:43:57 (UTC-04)	Enabled	Enabled	KMS
 ```
 
+# Variables
+## profile
+This variable is required because this module calls a script, and it uses `aws` CLI commands.  As such, it needs to set the `AWS_PROFILE` environment
+variable to call the script properly.
+
 # Caveats
 Currently, a destroy of the images (null\_resources) does **NOT** remove the repository. That is a work in progress.
 

diff --git a/examples/simple/copy-images.tf b/examples/simple/copy-images.tf
@@ -1,6 +1,7 @@
 module "images" {
   source = "git@github.e.it.census.gov:terraform-modules/aws-ecr-copy-images.git"
 
+  profile          = var.profile
   application_list = ["app1", "app2"]
   application_name = "org-project"
   image_config     = var.image_config

diff --git a/main.tf b/main.tf
@@ -46,6 +46,7 @@
 * module "images" {
 *   source = "git@github.e.it.census.gov:terraform-modules/aws-ecr-copy-images.git"
 * 
+*   profile          = var.profile
 *   application_list = ["app1", "app2"]
 *   application_name = "org-project"
 *   image_config     = local.image_config
@@ -74,6 +75,11 @@
 * org-project/nodejs-14	817869416306.dkr.ecr.us-gov-east-1.amazonaws.com/org-project/nodejs-14 August 22, 2022, 12:43:57 (UTC-04)	Enabled	Enabled	KMS 
 * org-project/openjdk-8	817869416306.dkr.ecr.us-gov-east-1.amazonaws.com/org-project/openjdk-8 August 22, 2022, 12:43:57 (UTC-04)	Enabled	Enabled	KMS
 * ```
+*
+* # Variables
+* ## profile
+* This variable is required because this module calls a script, and it uses `aws` CLI commands.  As such, it needs to set the `AWS_PROFILE` environment
+* variable to call the script properly.
 * 
 * # Caveats
 * Currently, a destroy of the images (null_resources) does **NOT** remove the repository. That is a work in progress.