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. It is also compatible with the GitHub Actions IAM Role mixin.

Warning (Older) regarding eks-iam component

warning

Older versions of our reference architecture have aneks-iam component that needs to be updated to provide sufficient IAM roles to allow pods to pull from ECR repos

Usage

Stack Level: Regional

Here's an example snippet for how to use this component. This component is normally only applied once as the resources it creates are globally accessible, but you may want to create ECRs in multiple regions for redundancy. This is typically provisioned via the stack for the "artifact" account (typically auto, artifact, or corp) in the primary region.

components:
  terraform:
    ecr:
      vars:
        ecr_user_enabled: false
        enable_lifecycle_policy: true
        max_image_count: 500
        scan_images_on_push: true
        protected_tags:
          - prod
        image_tag_mutability: MUTABLE

        images:
          - infrastructure
          - microservice-a
          - microservice-b
          - microservice-c
        read_write_account_role_map:
          identity:
            - admin
            - cicd
          automation:
            - admin
        read_only_account_role_map:
          corp: ["*"]
          dev: ["*"]
          prod: ["*"]
          stage: ["*"]

Variables

Required Variables

enable_lifecycle_policy (bool) required: Enable/disable image lifecycle policy
images (list(string)) required: List of image names (ECR repo names) to create repos for
max_image_count (number) required: Max number of images to store. Old ones will be deleted to make room for new ones.
read_write_account_role_map (map(list(string))) required: Map of account:[role, role...] for write access. Use * for role to grant access to entire account
region (string) required: AWS Region

Optional Variables

ecr_user_enabled (bool) optional

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)

Default value: false

image_tag_mutability (string) optional

The tag mutability setting for the repository. Must be one of: MUTABLE or IMMUTABLE

Default value: "MUTABLE"

principals_lambda (list(string)) optional

Principal account IDs of Lambdas allowed to consume ECR

Default value: [ ]

protected_tags (list(string)) optional

Tags to refrain from deleting

Default value: [ ]

pull_through_cache_rules optional

Map of pull through cache rules to configure

Type:

map(object({
registry = string
secret   = optional(string, "")
}))

Default value: { }

read_only_account_role_map (map(list(string))) optional

Map of account:[role, role...] for read-only access. Use * for role to grant access to entire account

Default value: { }

replication_configurations optional

Replication configuration for a registry. See Replication Configuration.

Type:

list(object({
rules = list(object({
  destinations = list(object({
    region      = string
    registry_id = string
  }))
  repository_filters = list(object({
    filter      = string
    filter_type = string
  }))
}))
}))

Default value: [ ]

scan_images_on_push (bool) optional

Indicates whether images are scanned after being pushed to the repository

Default value: false

Context Variables

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

additional_tag_map (map(string)) optional

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.

Required: No

Default value: { }

attributes (list(string)) optional

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.

Required: No

Default value: [ ]

context (any) optional

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.

Required: No

Default value:

{
  "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
}

delimiter (string) optional

Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.

Required: No

Default value: null

descriptor_formats (any) optional

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).

Required: No

Default value: { }

enabled (bool) optional

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional

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.

Required: No

Default value: null

label_key_case (string) optional

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.

Required: No

Default value: null

label_order (list(string)) optional

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.

Required: No

Default value: null

label_value_case (string) optional

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.

Required: No

Default value: null

labels_as_tags (set(string)) optional

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.

Required: No

Default value:

[
  "default"
]

name (string) optional

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.

Required: No

Default value: null

namespace (string) optional

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional

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.

Required: No

Default value: null

stage (string) optional

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional

Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.

Required: No

Default value: { }

tenant (string) optional

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs

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
repository_host: ECR repository name

Dependencies

Requirements

terraform, version: >= 1.0.0
aws, version: >= 4.9.0, < 6.0.0

Providers

aws, version: >= 4.9.0, < 6.0.0

Modules

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

Resources

The following resources are used by this module:

aws_ecr_pull_through_cache_rule.this (resource)
aws_iam_policy.ecr_user (resource)
aws_iam_user.ecr (resource)
aws_iam_user_policy_attachment.ecr_user (resource)

Data Sources

The following data sources are used by this module:

aws_iam_policy_document.ecr_user (data source)
aws_secretsmanager_secret.cache_credentials (data source)

References

cloudposse/terraform-aws-components - Cloud Posse's upstream component

Usage​

Variables​

Required Variables​

Optional Variables​

Context Variables​

Outputs​

Dependencies​

Requirements​

Providers​

Modules​

Resources​

Data Sources​

Related​

References​

Usage

Variables

Required Variables

Optional Variables

Context Variables

Outputs

Dependencies

Requirements

Providers

Modules

Resources

Data Sources

Related

References