Skip to content

Latest commit

 

History

History
 
 

ecr

README.md

Component: ecr

This component is responsible for provisioning repositories, lifecycle rules, and permissions for streamlined ECR usage. This utilizes the roles-to-principals submodule to assign accounts to various roles.

Usage

Stack Level: Regional

Here's an example snippet for how to use this component. This component should only be applied once as the resources it creates are global. This is typically done via the corp stack (e.g. uw2-corp.yaml).

components:
  terraform:
    ecr:
      vars:
        enabled: true
        ecr_user_enabled: true
        max_image_count: 500
        scan_images_on_push: true
        cicd_accounts:
        - automation
        images:
          - infrastructure
          - microservice-a
          - microservice-b
          - microservice-c
        read_write_account_role_map:
          identity:
          - admin
          - ops
          - cicd
          automation:
          - admin
          - ops
        read_only_account_role_map:
          corp: ["*"]
          devdata: ["*"]
          devplatform: ["*"]
          proddata: ["*"]
          prodplatform: ["*"]
          stagedata: ["*"]
          stageplatform: ["*"]

Requirements

Name Version
terraform >= 1.0.0
aws ~> 4.0

Providers

Name Version
aws ~> 4.0

Modules

Name Source Version
ecr cloudposse/ecr/aws 0.34.0
full_access ../account-map/modules/roles-to-principals n/a
iam_roles ../account-map/modules/iam-roles n/a
readonly_access ../account-map/modules/roles-to-principals n/a
this cloudposse/label/null 0.25.0

Resources

Name Type
aws_iam_policy.ecr_user resource
aws_iam_user.ecr resource
aws_iam_user_policy_attachment.ecr_user resource
aws_iam_policy_document.ecr_user data source

Inputs

Name Description Type Default Required
additional_tag_map Additional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.		 map(string) {} no
attributes ID element. Additional attributes (e.g. workers or cluster) to add to id,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the delimiter
and treated as a single ID element.		 list(string) [] no
context Single object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as null to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional_tag_map, which are merged.		 any 
{
  "additional_tag_map": {},
  "attributes": [],
  "delimiter": null,
  "descriptor_formats": {},
  "enabled": true,
  "environment": null,
  "id_length_limit": null,
  "label_key_case": null,
  "label_order": [],
  "label_value_case": null,
  "labels_as_tags": [
    "unset"
  ],
  "name": null,
  "namespace": null,
  "regex_replace_chars": null,
  "stage": null,
  "tags": {},
  "tenant": null
}
 no
delimiter Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.		 string null no
descriptor_formats Describe additional descriptors to be output in the descriptors output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
{<br> format = string<br> labels = list(string)<br>}
(Type is any so the map values can later be enhanced to provide additional options.)
format is a Terraform format string to be passed to the format() function.
labels is a list of labels, in order, to pass to format() function.
Label values will be normalized before being passed to format() so they will be
identical to how they appear in id.
Default is {} (descriptors output will be empty).		 any {} no
ecr_user_enabled Enable/disable the provisioning of the ECR user (for CI/CD systems that don't support assuming IAM roles to access ECR, e.g. Codefresh) bool false no
enable_lifecycle_policy Enable/disable image lifecycle policy bool n/a yes
enabled Set to false to prevent the module from creating any resources bool null no
environment ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' string null no
id_length_limit Limit id to this many characters (minimum 6).
Set to 0 for unlimited length.
Set to null for keep the existing setting, which defaults to 0.
Does not affect id_full.		 number null no
image_tag_mutability The tag mutability setting for the repository. Must be one of: MUTABLE or IMMUTABLE string "MUTABLE" no
images List of image names (ECR repo names) to create repos for list(string) n/a yes
import_profile_name AWS Profile name to use when importing a resource string null no
import_role_arn IAM Role ARN to use when importing a resource string null no
label_key_case Controls the letter case of the tags keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the tags input.
Possible values: lower, title, upper.
Default value: title.		 string null no
label_order The order in which the labels (ID elements) appear in the id.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.		 list(string) null no
label_value_case Controls the letter case of ID elements (labels) as included in id,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the tags input.
Possible values: lower, title, upper and none (no transformation).
Set this to title and set delimiter to "" to yield Pascal Case IDs.
Default value: lower.		 string null no
labels_as_tags Set of labels (ID elements) to include as tags in the tags output.
Default is to include all labels.
Tags with empty values will not be included in the tags output.
Set to [] to suppress all generated tags.
Notes:
The value of the name tag, if included, will be the id, not the name.
Unlike other null-label inputs, the initial setting of labels_as_tags cannot be
changed in later chained modules. Attempts to change it will be silently ignored.		 set(string) 
[
  "default"
]
 no
max_image_count Max number of images to store. Old ones will be deleted to make room for new ones. number n/a yes
name ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a tag.
The "name" tag is set to the full id string. There is no tag with the value of the name input.		 string null no
namespace ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique string null no
protected_tags Tags to refrain from deleting list(string) n/a yes
read_only_account_role_map Map of account:[role, role...] for read-only access. Use * for role to grant access to entire account map(list(string)) {} no
read_write_account_role_map Map of account:[role, role...] for write access. Use * for role to grant access to entire account map(list(string)) n/a yes
regex_replace_chars Terraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.		 string null no
region AWS Region string n/a yes
root_account_tenant_name The tenant name for the root account string null no
scan_images_on_push Indicates whether images are scanned after being pushed to the repository bool false no
stage ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' string null no
tags Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.		 map(string) {} no
tenant ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for string null no

Outputs

Name Description
ecr_repo_arn_map Map of image names to ARNs
ecr_repo_url_map Map of image names to URLs
ecr_user_arn ECR user ARN
ecr_user_name ECR user name
ecr_user_unique_id ECR user unique ID assigned by AWS

References