Module: ecr
Terraform module to provision an AWS ECR Docker Container registry
.
Usage
The module creates one or more Elastic Container Registry (ECR) repositories. All repositories created will share the same configuration. Use this module multiple times to create repositories with different configurations.
If you provide 1 or more names in image_names
then one repository will be created for
each of the names you provide. Those names can include "namespaces", which are just
prefixes ending with a slash (/
).
If you do not provide any names in image_names
, the module will create a single ECR repo
named namespace-stage-name
or just name
depending on the value of use_fullname
.
Access to the repositories is granted to via the principals_full_access
and
principals_readonly_access
lists, which are lists of strings that can designate any valid AWS
Principal.
This module only creates the Repository Policy allowing those Principals access.
The Principals will still separately need IAM policies allowing them permission
to execute ECR actions against the repository. For more details, see
How Amazon Elastic Container Registry Works with IAM.
Include this repository as a module in your existing terraform code:
# IAM Role to be granted ECR permissions
data "aws_iam_role" "ecr" {
name = "ecr"
}
module "ecr" {
source = "cloudposse/ecr/aws"
# Cloud Posse recommends pinning every module to a specific version
# version = "x.x.x"
namespace = "eg"
stage = "test"
name = "ecr"
principals_full_access = [data.aws_iam_role.ecr.arn]
}
Requirements
Name | Version |
---|---|
terraform | >= 0.13.0 |
aws | >= 4.22.0 |
Providers
Name | Version |
---|---|
aws | >= 4.22.0 |
Modules
Name | Source | Version |
---|---|---|
this | cloudposse/label/null | 0.25.0 |
Resources
Name | Type |
---|---|
aws_ecr_lifecycle_policy.name | resource |
aws_ecr_replication_configuration.replication_configuration | resource |
aws_ecr_repository.name | resource |
aws_ecr_repository_policy.name | resource |
aws_iam_policy_document.empty | data source |
aws_iam_policy_document.lambda_access | data source |
aws_iam_policy_document.organization_full_access | data source |
aws_iam_policy_document.organization_push_access | data source |
aws_iam_policy_document.organizations_readonly_access | data source |
aws_iam_policy_document.resource | data source |
aws_iam_policy_document.resource_full_access | data source |
aws_iam_policy_document.resource_pull_through_cache | data source |
aws_iam_policy_document.resource_push_access | data source |
aws_iam_policy_document.resource_readonly_access | data source |
aws_partition.current | 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 |
| 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 beidentical to how they appear in id .Default is {} (descriptors output will be empty). | any | {} | no |
enable_lifecycle_policy | Set to false to prevent the module from adding any lifecycle policies to any repositories | bool | true | no |
enabled | Set to false to prevent the module from creating any resources | bool | null | no |
encryption_configuration | ECR encryption configuration |
| null | no |
environment | ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' | string | null | no |
force_delete | Whether to delete the repository even if it contains images | bool | false | 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_names | List of Docker local image names, used as repository names for AWS ECR | list(string) | [] | no |
image_tag_mutability | The tag mutability setting for the repository. Must be one of: MUTABLE or IMMUTABLE | string | "IMMUTABLE" | 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 bechanged in later chained modules. Attempts to change it will be silently ignored. | set(string) |
| no |
max_image_count | How many Docker Image versions AWS ECR will store | number | 500 | no |
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 |
organizations_full_access | Organization IDs to provide with full access to the ECR. | list(string) | [] | no |
organizations_push_access | Organization IDs to provide with push access to the ECR | list(string) | [] | no |
organizations_readonly_access | Organization IDs to provide with readonly access to the ECR. | list(string) | [] | no |
prefixes_pull_through_repositories | Organization IDs to provide with push access to the ECR | list(string) | [] | no |
principals_full_access | Principal ARNs to provide with full access to the ECR | list(string) | [] | no |
principals_lambda | Principal account IDs of Lambdas allowed to consume ECR | list(string) | [] | no |
principals_pull_though_access | Principal ARNs to provide with pull though access to the ECR | list(string) | [] | no |
principals_push_access | Principal ARNs to provide with push access to the ECR | list(string) | [] | no |
principals_readonly_access | Principal ARNs to provide with readonly access to the ECR | list(string) | [] | no |
protected_tags | Name of image tags prefixes that should not be destroyed. Useful if you tag images with names like dev , staging , and prod | set(string) | [] | no |
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 |
replication_configurations | Replication configuration for a registry. See Replication Configuration. |
| [] | no |
scan_images_on_push | Indicates whether images are scanned after being pushed to the repository (true) or not (false) | bool | true | 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 |
use_fullname | Set 'true' to use namespace-stage-name for ecr repository name, else name | bool | true | no |
Outputs
Name | Description |
---|---|
registry_id | Registry ID |
repository_arn | ARN of first repository created |
repository_arn_map | Map of repository names to repository ARNs |
repository_name | Name of first repository created |
repository_url | URL of first repository created |
repository_url_map | Map of repository names to repository URLs |