update doc

terraform-modules · Aug 22, 2022 · 25304b1 · 25304b1
1 parent 840ce21
commit 25304b1
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 39 deletions.
diff --git a/README.md b/README.md
@@ -1,10 +1,10 @@
 # About aws-ecr-copy-images
-This module will create ECR repositories with the prefix of `_application_name_` for the list of
-repositories in `_application_list_`.  This allows for a project to upload their images into
+This module will create ECR repositories with the prefix of _application\_name_ for the list of
+repositories in \_application\_list\_.  This allows for a project to upload their images into
 /{application\_name}/{sub\_app}/\_image\_:\_tag\_.
 
 Also, if provided a list of source image configurations, it will download them from their location
-and upload them to the prefix of `_application_name_` followed by the _name_ in the `image_config`
+and upload them to the prefix of _application\_name\_ followed by the \_name_ in the `image_config`
 object.
 
 # Usage

diff --git a/examples/simple/copy-images.tf b/examples/simple/copy-images.tf
@@ -1,41 +1,9 @@
-locals {
-  image_config = [
-    {
-      enabled         = true
-      dest_path       = null
-      name            = "openjdk-8"
-      source_image    = "ubi8/openjdk-8"
-      source_registry = "registry.access.redhat.com"
-      source_tag      = null
-      tag             = "latest"
-    },
-    {
-      enabled         = true
-      name            = "nginx-118"
-      dest_path       = null
-      source_image    = "ubi8/nginx-118"
-      source_registry = "registry.access.redhat.com"
-      source_tag      = null
-      tag             = "latest"
-    },
-    {
-      enabled         = true
-      name            = "nodejs-14"
-      dest_path       = null
-      source_image    = "ubi8/nodejs-14"
-      source_registry = "registry.access.redhat.com"
-      source_tag      = null
-      tag             = "latest"
-    },
-  ]
-}
-
 module "images" {
   source = "git@github.e.it.census.gov:terraform-modules/aws-ecr-copy-images.git"
 
   application_list = ["app1", "app2"]
   application_name = "org-project"
-  image_config     = local.image_config
+  image_config     = var.image_config
   tags             = {}
 
   ### optional

diff --git a/main.tf b/main.tf
@@ -1,11 +1,11 @@
 /*
 * # About aws-ecr-copy-images
-* This module will create ECR repositories with the prefix of `_application_name_` for the list of
-* repositories in `_application_list_`.  This allows for a project to upload their images into
+* This module will create ECR repositories with the prefix of _application_name_ for the list of
+* repositories in _application_list_.  This allows for a project to upload their images into
 * /{application_name}/{sub_app}/_image_:_tag_.
 *
 * Also, if provided a list of source image configurations, it will download them from their location
-* and upload them to the prefix of `_application_name_` followed by the _name_ in the `image_config`
+* and upload them to the prefix of _application_name_ followed by the _name_ in the `image_config`
 * object.
 *
 * # Usage