cloudposse / terraform-aws-ecr Goto Github PK

View Code? Open in Web Editor NEW

173.0 22.0 125.0 1.17 MB

Terraform Module to manage Docker Container Registries on AWS ECR

Home Page: https://cloudposse.com/accelerate

License: Apache License 2.0

HCL 90.81% Makefile 5.98% Go 3.21%

terraform terraform-modules ecr aws docker docker-registry hcl2

terraform-aws-ecr's Introduction

Terraform module to provision an AWS ECR Docker Container registry.

Tip

👽 Use Atmos with Terraform

Cloud Posse uses atmos to easily orchestrate multiple environments using Terraform.
Works with Github Actions, Atlantis, or Spacelift.

Watch demo of using Atmos with Terraform

Example of running atmos to manage infrastructure from our Quick Start tutorial.

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]
}

Important

In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic approach for updating versions to avoid unexpected changes.

Makefile Targets

Available targets:

  help                                Help screen
  help/all                            Display help for all targets
  help/short                          This help short screen
  lint                                Lint terraform code

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`	{ "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
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	object({ encryption_type = string kms_key = any })	`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 be changed in later chained modules. Attempts to change it will be silently ignored.	`set(string)`	[ "default" ]	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.	list(object({ rules = list(object({ # Maximum 10 destinations = list(object({ # Maximum 25 region = string registry_id = string })) repository_filters = list(object({ filter = string filter_type = string })) })) }))	`[]`	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

Related Projects

Check out these related projects.

terraform-aws-jenkins - Terraform module to build Docker image with Jenkins, save it to an ECR repo, and deploy to Elastic Beanstalk running Docker stack
terraform-aws-kops-ecr - Terraform module to provision an ECR repository and grant users and kubernetes nodes access to it.

Tip

Use Terraform Reference Architectures for AWS

Use Cloud Posse's ready-to-go terraform architecture blueprints for AWS to get up and running quickly.

✅ We build it with you.
✅ You own everything.
✅ Your team wins.

📚 Learn More

Cloud Posse is the leading DevOps Accelerator for funded startups and enterprises.

Your team can operate like a pro today.

Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.

Day-0: Your Foundation for Success

Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
Deployment Strategy. Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.
Site Reliability Engineering. Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.
Security Baseline. Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.
GitOps. Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.

Day-2: Your Operational Mastery

Training. Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.
Support. Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.
Troubleshooting. Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.
Code Reviews. Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.
Bug Fixes. Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.
Migration Assistance. Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.
Customer Workshops. Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.

✨ Contributing

This project is under active development, and we encourage contributions from our community.

Many thanks to our outstanding contributors:

For 🐛 bug reports & feature requests, please use the issue tracker.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

Review our Code of Conduct and Contributor Guidelines.
Fork the repo on GitHub
Clone the project to your own machine
Commit changes to your own branch
Push your work back up to your fork
Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

🌎 Slack Community

Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.

📰 Newsletter

Sign up for our newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. Dropped straight into your Inbox every week — and usually a 5-minute read.

📆 Office Hours

Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a live Q&A that you can’t find anywhere else. It's FREE for everyone!

License

Preamble to the Apache License, Version 2.0

Complete license is available in the LICENSE file.

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

Trademarks

All other trademarks referenced herein are the property of their respective owners.

terraform-aws-ecr's People

Contributors

Stargazers

Watchers

Forkers

ivan-pinatti aikram1271 ori-stoliar bmacauley justindisney chrisevett badsector3 streamich arobinson-r7 daringanitch lvh sweetops snap40 yoadfe premkumarcandy hookercookerman ids-inc ryan-tmx rogerscuall roock wesselvdv betterworks karthik012 turingfantasy samahm blackbookusa asiegman jelitox doc82 mitsiek k911 nexeck unionpos sekharmandava castlery tkhs3 lablabs s2504s kalkanisys saikiranburle nitrocode wefactorit vmalinics0 mahaffey bellatoris betterofficeapps marianod92 hamza-tumturk davidkarlsen dmattia yariksheptykin luca15mx maheshdte arun9theja deadlysyn kalyan088 voa2000 jonesmabea magento-eqp dekimsey redwarn richardarpanet marlettefunding marcusjack zfedoran anupclouddevops syphernl openworldza zaargh hi-eu codezninja paragon-vitamins dmitriy-lukyanchikov prasanna619 enorrtv nilreml max-lobur shaikis engaugusto dragosmc parvianeja ops-guru dsme94 sqlhorizons standardgalactic 35blaze dovnaralexander geradineboue ryanoatz99 bwmetcalf piyushsonigra majnashn tsunamaru mohasaaid joshmyers kpankonen aca8089 alexjurkiewicz leonardobiffi sevenpicoforks

terraform-aws-ecr's Issues

0.15 -> 0.16 transition wants to destroy and recreate all repos

Describe the Bug

When I update my configuration to use tagged version 0.16.0, from 0.15.0, terraform tries to destroy my repositories and create new ones in their places. It looks like the internal resource naming has changed. Do I need to run terraform state mv for all of my repos? I have a lot of repos.

Expected Behavior

If the new module is going to change the repositories, I expect them to be modified in place. Destroying them will delete my entire ECS infrastructure.

Steps to Reproduce

Steps to reproduce the behavior:

Create a repository using Terraform and module source git::https://github.com/cloudposse/terraform-aws-ecr.git?ref=tags/0.15.0
Modify the configuration to use version 0.16.0 (or any later version up to 0.20.0), so git diff might output e.g.

 module "ecr_dev" {
-  source          = "git::https://github.com/cloudposse/terraform-aws-ecr.git?ref=tags/0.15.0"
+  source          = "git::https://github.com/cloudposse/terraform-aws-ecr.git?ref=tags/0.16.0"
   name            = "my-repo"

Run terraform plan

Screenshots

If applicable, add screenshots or logs to help explain your problem.

module.ecr_dev.aws_ecr_repository.default[0] will be destroyed
module.ecr_dev.aws_ecr_repository.name["my-repo"] will be created

Environment (please complete the following information):

Anything that will help us triage the bug will help. Here are some ideas:
terraform 0.12.25 on OS X.

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

This repository currently has no open or pending branches.

Detected dependencies

terraform

versions.tf

hashicorp/terraform >= 0.13.0

aws >= 3.30.0

Check this box to trigger a request for Renovate to run again on this repository

ya'll ready?! public ECR! 🔥

Public ECR support is dropping later today (possibly), would be a nice addition to the module (I think) hashicorp/terraform-provider-aws#16540

multi region ECR with replication support

Have a question? Please checkout our Slack Community or visit our Slack Archive.

Describe the Feature

Is it good to have multi region(s) ECR creation and replication so that same can be used for DR strategy.

Expected Behavior

Multi Region with replication support

Use Case

If team want to setup full DR it would be nice to have ECR replication feature which will automatically push new ECR changes to DR or other regions. and can be used by local resources reduce the data transfer as well.

4.0.0 deprecated warning

Found a bug? Maybe our Slack Community can help.

Describe the Bug

When upgrading to 4.0.0, aws_iam_policy_document source_json should be replaced with source_policy_documents

https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document#source_json

│   with module.ecr.data.aws_iam_policy_document.resource,
│   on .terraform/modules/ecr/main.tf line 138, in data "aws_iam_policy_document" "resource":
│  138:   source_json   = local.principals_readonly_access_non_empty ? join("", [data.aws_iam_policy_document.resource_readonly_access[0].json]) : join("", [data.aws_iam_policy_document.empty[0].json])
│
│ Use the attribute "source_policy_documents" instead.
│
│ (and one more similar warning elsewhere)

Expected Behavior

No deprecation warning

Steps to Reproduce

Steps to reproduce the behavior:

Go to cloudposse/terraform-aws-ecr/examples/complete
Run terraform plan -var 'region=us-east-1'
~~3. Enter '....'~~
See ~~error~~ deprecation warning

Screenshots

If applicable, add screenshots or logs to help explain your problem.

Environment (please complete the following information):

Anything that will help us triage the bug will help. Here are some ideas:

OS: [e.g. Linux, OSX, WSL, etc]
Version [e.g. 10.15]

Additional Context

Add any other context about the problem here.

Make it TF 0.13 compatible

Describe the Bug

Not bug but enhancement.
Allow for using TF 0.13 which allows for for_each in modules.

Expected Behavior

A clear and concise description of what you expected to happen.

Steps to Reproduce

[et2448@Davids-Work-MacBook-Pro tf-ecr (⎈ |icp-global-context:dependency-track)]$ terraform13 init
Initializing modules...

Error: Unsupported Terraform Core version

  on .terraform/modules/ecr.label/versions.tf line 2, in terraform:
   2:   required_version = "~> 0.12.0"

Module module.ecr.module.label (from
git::https://github.com/cloudposse/terraform-null-label.git?ref=tags/0.16.0)
does not support Terraform version 0.13.0-beta2. To proceed, either choose
another supported Terraform version or update this version constraint. Version
constraints are normally set for good reason, so updating the constraint may
lead to other errors or unexpected behavior.


Error: Unsupported Terraform Core version

  on .terraform/modules/ecr/terraform-aws-ecr-0.16.0/versions.tf line 2, in terraform:
   2:   required_version = "~> 0.12.0"

Module module.ecr (from cloudposse/ecr/aws) does not support Terraform version
0.13.0-beta2. To proceed, either choose another supported Terraform version or
update this version constraint. Version constraints are normally set for good
reason, so updating the constraint may lead to other errors or unexpected
behavior.

Screenshots

If applicable, add screenshots or logs to help explain your problem.

Environment (please complete the following information):

Anything that will help us triage the bug will help. Here are some ideas:

OS: [e.g. Linux, OSX, WSL, etc]
Version [e.g. 10.15]

Additional Context

Add any other context about the problem here.

Reduce permission to functions only

Found a bug? Maybe our Slack Community can help.

Describe the Bug

Currently CrossAccountPermission permission also being added to the ECR policy when principle_lambda variable is added. which will allow members form other account to use image apart from lambda also. and it is also working without adding that CrossAccountPermission as well

Expected Behavior

should not allow permission other then lambda functions
Write only permission feature should be there which will allow user to write image only to the ecr repo. not other features.

{
      "Sid": "WriteOnlyAccess",
      "Effect": "Allow",
      "Principal": {
        "AWS": "priniciple_arn"
      },
      "Action": [
        "ecr:BatchCheckLayerAvailability",
        "ecr:CompleteLayerUpload",
        "ecr:InitiateLayerUpload",
        "ecr:PutImage",
        "ecr:UploadLayerPart"
      ]
    }

Malformed policy document when principal and multiple images supplied

Found a bug? Maybe our Slack Community can help.

Describe the Bug

I invoke the module as follows:

module "ecr" {
  #source     = "git::[email protected]:cloudposse/terraform-aws-ecr?ref=tags/0.15.0"
  #source     = "git::[email protected]:carnegierobotics/terraform-aws-ecr?ref=fix/policy"
  source     = "/home/jhosteny/src/github/crl/terraform-aws-ecr"
  name       = var.name
  namespace  = var.namespace
  stage      = var.stage
  tags       = var.tags
  attributes = var.attributes
  delimiter  = var.delimiter

  image_names = var.image_names
  principals_full_access = [var.sidecred_ecr_writer_role_arn]
}

This produces the following plan:

An execution plan has been generated and is shown below.
Resource actions are indicated with the following symbols:
  + create

Terraform will perform the following actions:

  # module.ecr.aws_ecr_repository_policy.default[0] will be created
  + resource "aws_ecr_repository_policy" "default" {
      + id          = (known after apply)
      + policy      = "{\n  \"Version\": \"2012-10-17\",\n  \"Statement\": [\n    {\n      \"Sid\": \"FullAccess\",\n      \"Effect\": \"Allow\",\n      \"Action\": [\n        \"ecr:UploadLayerPart\",\n        \"ecr:StartImageScan\",\n        \"ecr:SetRepositoryPolicy\",\n        \"ecr:PutImage\",\n        \"ecr:ListImages\",\n        \"ecr:InitiateLayerUpload\",\n        \"ecr:GetRepositoryPolicy\",\n        \"ecr:GetDownloadUrlForLayer\",\n        \"ecr:GetAuthorizationToken\",\n        \"ecr:DescribeRepositories\",\n        \"ecr:DescribeImages\",\n        \"ecr:DescribeImageScanFindings\",\n        \"ecr:DeleteRepositoryPolicy\",\n        \"ecr:DeleteRepository\",\n        \"ecr:CompleteLayerUpload\",\n        \"ecr:BatchGetImage\",\n        \"ecr:BatchDeleteImage\",\n        \"ecr:BatchCheckLayerAvailability\"\n      ],\n      \"Principal\": {\n        \"AWS\": \"arn:aws:iam::919264070010:role/tai-prod-sidecred-ecr-writer\"\n      }\n    }\n  ]\n}{\n  \"Version\": \"2012-10-17\",\n  \"Statement\": [\n    {\n      \"Sid\": \"FullAccess\",\n      \"Effect\": \"Allow\",\n      \"Action\": [\n        \"ecr:UploadLayerPart\",\n        \"ecr:StartImageScan\",\n        \"ecr:SetRepositoryPolicy\",\n        \"ecr:PutImage\",\n        \"ecr:ListImages\",\n        \"ecr:InitiateLayerUpload\",\n        \"ecr:GetRepositoryPolicy\",\n        \"ecr:GetDownloadUrlForLayer\",\n        \"ecr:GetAuthorizationToken\",\n        \"ecr:DescribeRepositories\",\n        \"ecr:DescribeImages\",\n        \"ecr:DescribeImageScanFindings\",\n        \"ecr:DeleteRepositoryPolicy\",\n        \"ecr:DeleteRepository\",\n        \"ecr:CompleteLayerUpload\",\n        \"ecr:BatchGetImage\",\n        \"ecr:BatchDeleteImage\",\n        \"ecr:BatchCheckLayerAvailability\"\n      ],\n      \"Principal\": {\n        \"AWS\": \"arn:aws:iam::919264070010:role/tai-prod-sidecred-ecr-writer\"\n      }\n    }\n  ]\n}"
      + registry_id = (known after apply)
      + repository  = "knightbase-ubuntu18"
    }

  # module.ecr.aws_ecr_repository_policy.default[1] will be created
  + resource "aws_ecr_repository_policy" "default" {
      + id          = (known after apply)
      + policy      = "{\n  \"Version\": \"2012-10-17\",\n  \"Statement\": [\n    {\n      \"Sid\": \"FullAccess\",\n      \"Effect\": \"Allow\",\n      \"Action\": [\n        \"ecr:UploadLayerPart\",\n        \"ecr:StartImageScan\",\n        \"ecr:SetRepositoryPolicy\",\n        \"ecr:PutImage\",\n        \"ecr:ListImages\",\n        \"ecr:InitiateLayerUpload\",\n        \"ecr:GetRepositoryPolicy\",\n        \"ecr:GetDownloadUrlForLayer\",\n        \"ecr:GetAuthorizationToken\",\n        \"ecr:DescribeRepositories\",\n        \"ecr:DescribeImages\",\n        \"ecr:DescribeImageScanFindings\",\n        \"ecr:DeleteRepositoryPolicy\",\n        \"ecr:DeleteRepository\",\n        \"ecr:CompleteLayerUpload\",\n        \"ecr:BatchGetImage\",\n        \"ecr:BatchDeleteImage\",\n        \"ecr:BatchCheckLayerAvailability\"\n      ],\n      \"Principal\": {\n        \"AWS\": \"arn:aws:iam::919264070010:role/tai-prod-sidecred-ecr-writer\"\n      }\n    }\n  ]\n}{\n  \"Version\": \"2012-10-17\",\n  \"Statement\": [\n    {\n      \"Sid\": \"FullAccess\",\n      \"Effect\": \"Allow\",\n      \"Action\": [\n        \"ecr:UploadLayerPart\",\n        \"ecr:StartImageScan\",\n        \"ecr:SetRepositoryPolicy\",\n        \"ecr:PutImage\",\n        \"ecr:ListImages\",\n        \"ecr:InitiateLayerUpload\",\n        \"ecr:GetRepositoryPolicy\",\n        \"ecr:GetDownloadUrlForLayer\",\n        \"ecr:GetAuthorizationToken\",\n        \"ecr:DescribeRepositories\",\n        \"ecr:DescribeImages\",\n        \"ecr:DescribeImageScanFindings\",\n        \"ecr:DeleteRepositoryPolicy\",\n        \"ecr:DeleteRepository\",\n        \"ecr:CompleteLayerUpload\",\n        \"ecr:BatchGetImage\",\n        \"ecr:BatchDeleteImage\",\n        \"ecr:BatchCheckLayerAvailability\"\n      ],\n      \"Principal\": {\n        \"AWS\": \"arn:aws:iam::919264070010:role/tai-prod-sidecred-ecr-writer\"\n      }\n    }\n  ]\n}"
      + registry_id = (known after apply)
      + repository  = "test"
    }

Plan: 2 to add, 0 to change, 0 to destroy.

For clarity, here is what the proposed document for one of the repositories looks like when pretty printed:

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Sid": "FullAccess",
      "Effect": "Allow",
      "Action": [
        "ecr:UploadLayerPart",
        "ecr:StartImageScan",
        "ecr:SetRepositoryPolicy",
        "ecr:PutImage",
        "ecr:ListImages",
        "ecr:InitiateLayerUpload",
        "ecr:GetRepositoryPolicy",
        "ecr:GetDownloadUrlForLayer",
        "ecr:GetAuthorizationToken",
        "ecr:DescribeRepositories",
        "ecr:DescribeImages",
        "ecr:DescribeImageScanFindings",
        "ecr:DeleteRepositoryPolicy",
        "ecr:DeleteRepository",
        "ecr:CompleteLayerUpload",
        "ecr:BatchGetImage",
        "ecr:BatchDeleteImage",
        "ecr:BatchCheckLayerAvailability"
      ],
      "Principal": {
        "AWS": "arn:aws:iam::919264070010:role/tai-prod-sidecred-core"
      }
    }
  ]
}{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Sid": "FullAccess",
      "Effect": "Allow",
      "Action": [
        "ecr:UploadLayerPart",
        "ecr:StartImageScan",
        "ecr:SetRepositoryPolicy",
        "ecr:PutImage",
        "ecr:ListImages",
        "ecr:InitiateLayerUpload",
        "ecr:GetRepositoryPolicy",
        "ecr:GetDownloadUrlForLayer",
        "ecr:GetAuthorizationToken",
        "ecr:DescribeRepositories",
        "ecr:DescribeImages",
        "ecr:DescribeImageScanFindings",
        "ecr:DeleteRepositoryPolicy",
        "ecr:DeleteRepository",
        "ecr:CompleteLayerUpload",
        "ecr:BatchGetImage",
        "ecr:BatchDeleteImage",
        "ecr:BatchCheckLayerAvailability"
      ],
      "Principal": {
        "AWS": "arn:aws:iam::919264070010:role/tai-prod-sidecred-core"
      }
    }
  ]
}

You can see that the document is concatenated twice. This is due to this join. I will have a PR shortly.

Expected Behavior

The plan should have been:

An execution plan has been generated and is shown below.
Resource actions are indicated with the following symbols:
  + create

Terraform will perform the following actions:

  # module.ecr.aws_ecr_repository_policy.default[0] will be created
  + resource "aws_ecr_repository_policy" "default" {
      + id          = (known after apply)
      + policy      = jsonencode(
            {
              + Statement = [
                  + {
                      + Action    = [
                          + "ecr:UploadLayerPart",
                          + "ecr:StartImageScan",
                          + "ecr:SetRepositoryPolicy",
                          + "ecr:PutImage",
                          + "ecr:ListImages",
                          + "ecr:InitiateLayerUpload",
                          + "ecr:GetRepositoryPolicy",
                          + "ecr:GetDownloadUrlForLayer",
                          + "ecr:GetAuthorizationToken",
                          + "ecr:DescribeRepositories",
                          + "ecr:DescribeImages",
                          + "ecr:DescribeImageScanFindings",
                          + "ecr:DeleteRepositoryPolicy",
                          + "ecr:DeleteRepository",
                          + "ecr:CompleteLayerUpload",
                          + "ecr:BatchGetImage",
                          + "ecr:BatchDeleteImage",
                          + "ecr:BatchCheckLayerAvailability",
                        ]
                      + Effect    = "Allow"
                      + Principal = {
                          + AWS = "arn:aws:iam::919264070010:role/tai-prod-sidecred-ecr-writer"
                        }
                      + Sid       = "FullAccess"
                    },
                ]
              + Version   = "2012-10-17"
            }
        )
      + registry_id = (known after apply)
      + repository  = "knightbase-ubuntu18"
    }

  # module.ecr.aws_ecr_repository_policy.default[1] will be created
  + resource "aws_ecr_repository_policy" "default" {
      + id          = (known after apply)
      + policy      = jsonencode(
            {
              + Statement = [
                  + {
                      + Action    = [
                          + "ecr:UploadLayerPart",
                          + "ecr:StartImageScan",
                          + "ecr:SetRepositoryPolicy",
                          + "ecr:PutImage",
                          + "ecr:ListImages",
                          + "ecr:InitiateLayerUpload",
                          + "ecr:GetRepositoryPolicy",
                          + "ecr:GetDownloadUrlForLayer",
                          + "ecr:GetAuthorizationToken",
                          + "ecr:DescribeRepositories",
                          + "ecr:DescribeImages",
                          + "ecr:DescribeImageScanFindings",
                          + "ecr:DeleteRepositoryPolicy",
                          + "ecr:DeleteRepository",
                          + "ecr:CompleteLayerUpload",
                          + "ecr:BatchGetImage",
                          + "ecr:BatchDeleteImage",
                          + "ecr:BatchCheckLayerAvailability",
                        ]
                      + Effect    = "Allow"
                      + Principal = {
                          + AWS = "arn:aws:iam::919264070010:role/tai-prod-sidecred-ecr-writer"
                        }
                      + Sid       = "FullAccess"
                    },
                ]
              + Version   = "2012-10-17"
            }
        )
      + registry_id = (known after apply)
      + repository  = "test"
    }

Plan: 2 to add, 0 to change, 0 to destroy.

Steps to Reproduce

Steps to reproduce the behavior:

Create an ECR module with multiple images and a principal.

Backslash being removed from name variable when used with use_fullname

Though I think this is by design rather than a bug, it should be discussed.

Describe the Bug

Slashes are removed from the name variable even when use_fullname is true

Expected Behavior

Characters valid for the service should be valid for the module. Whilst regex_replace_chars does a good job of keeping the most valid characters, another regex var is required for when name is used alongside a use_fullname=true. We should be overriding regex_replace_chars as it has a wider impact than just the name variable.

Maybe even take this a step further and use the namespace before adding a slash when use_fullname=false?

Steps to Reproduce

Apply the module with a name that contains a / and use_fullname=true, the slash will not be in the name of the ECR repository.

Support for namespaced repositories

Using v0.12.0 of this module, is there support for namespaced repositories? I can manually create a repository in ECR as mycompany/niftyimage, but it looks like the null-label module munges namespace together with name into mycompany-niftyimage. Putting the namespace into the name attribute (name = mycompany/niftyimage) together with use_fullname = false, gives a computed name of mycompanyniftyimage.

I don't see a way to get a Docker-standard repository/namespace/image structure using the module at the moment. Any thoughts?

Thanks for the work on this module!

Enable lifefycle policy based on "Since imaged pushed"

Have a question? Please checkout our Slack Community or visit our Slack Archive.

Describe the Feature

Unless I missed it, the current rule available for images expiracy is based on the max number of images for a repo (max_image_count).
Adding the possibility to use the countType "sinceImagePushed" would obviously extend the capabilities of this module.

Describe Ideal Solution

Have the ability to choose between a lifecycle based on either the total number of images or the number of days since their last push.
If both options are set, obviously this should not be allowed.

Alternatives Considered

For the moment I manage the policies outside the module, directly with the resource aws_ecr_lifecycle_policy which will iterate on the list of images on which I want to apply it.

module doesn't seem to work on fresh account

terraform version: 0.11.8
terraform-aws-ecr: 0.2.10 (master)

expected result:

a new ECR called cloud/databank_fe with default roles provided by the module (no roles are provided)
This ECR is created on another newly created account, the script is executed from the master account and TF will use a provider with assume role.

terraform main.tf

provider "aws" {
    version = "~> 1.29"
    region = "eu-west-1"
}

terraform {
    backend "s3" {
        bucket  = "my-bucket"
        key     = "devops-aws/repo/terraform.tfstate"
        region  = "eu-west-1"
        encrypt = true
        dynamodb_table = "terraform-lock-table"
    }
}

# read root state to retrieve account_repo.id

data "terraform_remote_state" "root" {
    backend = "s3"
    config {
        bucket  = "my-bucket"
        key     = "devops-aws/root/terraform.tfstate"
        region  = "eu-west-1"
        encrypt = true
    }
}

provider "aws" {
    alias = "assume_repo_admin"
    assume_role {
        role_arn     = "arn:aws:iam::${data.terraform_remote_state.root.account_repo_id}:role/OrganizationAccountAccessRole"
        session_name = "setup_account_repo"
    }
}

# create ECR repositories

module "ecr" {
    providers = {
        aws = "aws.assume_repo_admin"
    }
    source      = "git::https://github.com/cloudposse/terraform-aws-ecr.git?ref=master"
    name        = "cloud/databank_fe"
    namespace   = "repo"
    stage       = "travis"
}

actual result:

$ terraform plan
Refreshing Terraform state in-memory prior to plan...
The refreshed state will be used to calculate this plan, but will not be
persisted to local or remote state storage.

data.terraform_remote_state.root: Refreshing state...
data.aws_iam_policy_document.login: Refreshing state...
data.aws_iam_policy_document.assume_role: Refreshing state...

------------------------------------------------------------------------

Error: Error running plan: 11 error(s) occurred:

* module.ecr.output.policy_write_name: Resource 'aws_iam_policy.write' not found for variable 'aws_iam_policy.write.name'
* module.ecr.output.role_arn: Resource 'aws_iam_role.default' does not have attribute 'arn' for variable 'aws_iam_role.default.*.arn'
* module.ecr.output.role_name: Resource 'aws_iam_role.default' does not have attribute 'name' for variable 'aws_iam_role.default.*.name'
* module.ecr.aws_iam_instance_profile.default: 1 error(s) occurred:

* module.ecr.aws_iam_instance_profile.default: Resource 'aws_iam_role.default' not found for variable 'aws_iam_role.default.name'
* module.ecr.output.policy_write_arn: Resource 'aws_iam_policy.write' not found for variable 'aws_iam_policy.write.arn'
* module.ecr.aws_iam_role_policy_attachment.default_ecr: 1 error(s) occurred:

* module.ecr.aws_iam_role_policy_attachment.default_ecr: Resource 'aws_iam_role.default' not found for variable 'aws_iam_role.default.name'
* module.ecr.output.policy_login_name: Resource 'aws_iam_policy.login' not found for variable 'aws_iam_policy.login.name'
* module.ecr.output.policy_read_arn: Resource 'aws_iam_policy.read' not found for variable 'aws_iam_policy.read.arn'
* module.ecr.output.policy_read_name: Resource 'aws_iam_policy.read' not found for variable 'aws_iam_policy.read.name'
* module.ecr.output.policy_login_arn: Resource 'aws_iam_policy.login' not found for variable 'aws_iam_policy.login.arn'
* module.ecr.data.aws_iam_policy_document.default_ecr: 1 error(s) occurred:

* module.ecr.data.aws_iam_policy_document.default_ecr: Resource 'aws_iam_role.default' not found for variable 'aws_iam_role.default.arn'

The problem also seems to occur if I try to create it on the same account.

Requesting to add `scan_type ` to `aws_ecr_registry_scanning_configuration`

Describe the Feature

With version 3.70 of the Terraform AWS provider it is now possible to make use of scan_types to enable enhanced scanning.
Currently there is no such feature implemented in the code.

Enhanced scanning—
Amazon ECR integrates with Amazon Inspector to provide automated, continuous scanning of your repositories. Your container images are scanned for both operating systems and programing language package vulnerabilities. As new vulnerabilities appear, the scan results are updated and Amazon Inspector emits an event to EventBridge to notify you.

Expected Behavior

Being able to set options on what scanning type is/will be used for ECR images. As per:

https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ecr_registry_scanning_configuration

Use Case

Added value will come from being in line with what the Terraform provider is able to, well, provide. Allowing users of the module to make use of new capabilities provided by Terraform and AWS.

Describe Ideal Solution

Using the scan_type flag in the terraform module to set this to ENHANCED instead of perhaps a default BASIC. This way the images will be continually scanned, which leads to a better security posture overall.

Principal ARNs input for ECR Power User

Describe the Feature

Create an input variable for Principal ARNs to provide power user access to ECR.

Expected Behavior

Principal ARNs will be provided with actions that match the policy AmazonEC2ContainerRegistryPowerUser which provides full access to Amazon EC2 Container Registry repositories, but does not allow repository deletion or policy changes.

Use Case

A centrally managed environment where Principal ARNs are allowed to update images in ECR repos but not alter policies or delete repos. This will add a guardrail to prevent unintentional/intentional deletion of repos containing nonrecoverable container images.

Alternatives Considered

Grant the ability create custom policies to attach to either current Principal ARN input.

AWS - ECR policy issue for some accounts

For certain users, AWS is not allowing restricting the ECR read for specific resource. The policy can be updated to all [*] resources only.

data "aws_iam_policy_document" "token" {
  statement {
    sid     = "ECRGetAuthorizationToken"
    effect  = "Allow"
    actions = ["ecr:GetAuthorizationToken"]

    resources = ["*"]   //it's working
    //resources = ["${aws_ecr_repository.default.arn}"]  --> not working 

  }
}

Allow other principals

Describe the Feature

Allow for other principals other than AWS for access control.

Expected Behavior

Allow Service or other values in principals_readonly_access.

Use Case

For letting services like lambda pull from the repository.

Describe Ideal Solution

To specify the type of principals when the value is not AWS, you could also specify the whole access policy.

Alternatives Considered

Using other modules.

Error: Invalid for_each argument

Describe the Bug

╷
│ Error: Invalid for_each argument
│
│   on  ecr/modules/ecr/main.tf line 310, in resource "aws_ecr_repository_policy" "name":
│  310:   for_each   = toset(local.ecr_need_policy && module.this.enabled ? local.image_names : [])
│     ├────────────────
│     │ local.ecr_need_policy is a bool, known only after apply
│     │ local.image_names is list of string with 2 elements
│     │ module.this.enabled is true
│
│ The "for_each" set includes values derived from resource attributes that cannot be determined until apply, and so Terraform cannot determine the full set of keys that will identify the instances of this resource.
│
│ When working with unknown values in for_each, it's better to use a map value where the keys are defined statically in your configuration and where only the values contain apply-time results.
│
│ Alternatively, you could use the -target planning option to first apply only the resources that the for_each value depends on, and then apply a second time to fully converge.
╵

Expected Behavior

no issues

Steps to Reproduce

fresh deployment using ecr, using

module "ecr" {
  source  = "cloudposse/ecr/aws"
  version = "0.40.0"
}

Screenshots

No response

Environment

No response

Additional Context

No response

image_names variable not working as expected

Describe the Bug

using the provided example in multi-repo, the repositories that are created are simply just app or worker and they are not namespaced at all like the documentation states (something like my-app/app or my-app/worker

Documentation

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.

Current Behavior

Code

module "ecr" {
  source = "cloudposse/ecr/aws"
  namespace = "my-app"
  environment = "ca"
  stage = "prod"
  use_fullname = true
  image_names = ["worker","app"]
}

Output

  # module.ecr.aws_ecr_repository.name["app"] will be created
  + resource "aws_ecr_repository" "name" {
      + arn                  = (known after apply)
      + id                   = (known after apply)
      + image_tag_mutability = "IMMUTABLE"
      + name                 = "app"
      + registry_id          = (known after apply)
      + repository_url       = (known after apply)
      + tags                 = {
          + "Environment" = "ca"
          + "Name"        = "my-app-ca-prod" <-- Name
          + "Namespace"   = "my-app"
          + "Stage"       = "prod"
        }
      + tags_all             = {
          + "Environment" = "ca"
          + "Name"        = "my-app-ca-prod" <-- Name
          + "Namespace"   = "my-app"
          + "Stage"       = "prod"
        }

      + image_scanning_configuration {
          + scan_on_push = true
        }
    }

  # module.ecr.aws_ecr_repository.name["circleci-with-prince"] will be created
  + resource "aws_ecr_repository" "name" {
      + arn                  = (known after apply)
      + id                   = (known after apply)
      + image_tag_mutability = "IMMUTABLE"
      + name                 = "worker"
      + registry_id          = (known after apply)
      + repository_url       = (known after apply)
      + tags                 = {
          + "Environment" = "ca"
          + "Name"        = "my-app-ca-prod" <-- Name
          + "Namespace"   = "my-app"
          + "Stage"       = "prod"
        }
      + tags_all             = {
          + "Environment" = "ca"
          + "Name"        = "my-app-ca-prod" <-- Name
          + "Namespace"   = "my-app"
          + "Stage"       = "prod"
        }

      + image_scanning_configuration {
          + scan_on_push = true
        }
    }

Expected Behavior

  # module.ecr.aws_ecr_repository.name["app"] will be created
  + resource "aws_ecr_repository" "name" {
      + arn                  = (known after apply)
      + id                   = (known after apply)
      + image_tag_mutability = "IMMUTABLE"
      + name                 = "my-app/app" <-- Name with namespace or full `ns-env-stage/name`
      + registry_id          = (known after apply)
      + repository_url       = (known after apply)
      + tags                 = {
          + "Environment" = "ca"
          + "Name"        = "my-app-ca-prod" <-- Name
          + "Namespace"   = "my-app"
          + "Stage"       = "prod"
        }
      + tags_all             = {
          + "Environment" = "ca"
          + "Name"        = "my-app-ca-prod" <-- Name
          + "Namespace"   = "my-app"
          + "Stage"       = "prod"
        }

      + image_scanning_configuration {
          + scan_on_push = true
        }
    }

  # module.ecr.aws_ecr_repository.name["circleci-with-prince"] will be created
  + resource "aws_ecr_repository" "name" {
      + arn                  = (known after apply)
      + id                   = (known after apply)
      + image_tag_mutability = "IMMUTABLE"
      + name                 = "my-app/worker" <-- Name with namespace or full `ns-env-stage/name`
      + registry_id          = (known after apply)
      + repository_url       = (known after apply)
      + tags                 = {
          + "Environment" = "ca"
          + "Name"        = "my-app-ca-prod" <-- Name
          + "Namespace"   = "my-app"
          + "Stage"       = "prod"
        }
      + tags_all             = {
          + "Environment" = "ca"
          + "Name"        = "my-app-ca-prod" <-- Name
          + "Namespace"   = "my-app"
          + "Stage"       = "prod"
        }

      + image_scanning_configuration {
          + scan_on_push = true
        }
    }

Environment (please complete the following information):

Anything that will help us triage the bug will help. Here are some ideas:

OS: MacOS Monterey 12.4
Terraform: v1.1.5/darwin_arm64

'aws_iam_role.default' not found

I've used the default assumerole role name
OrganizationAccountAccessRole

data "aws_iam_role" "ecr" {
  name = "OrganizationAccountAccessRole"
}

and got the following error planning with TF 0.11

Error: Error running plan: 1 error(s) occurred:

* module.ecr.output.role_name: Resource 'aws_iam_role.default' not found for variable 'aws_iam_role.default.name'

multi-repo namespacing does not appear to work

Describe the Bug

using the provided example in multi-repo, the repositories that are created are simply just redis or nginx and they are not namespaced at all like the documentation states (something like eg/reds or eg/nginx

From the README

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

Current Behavior

+ resource "aws_ecr_repository" "name" {
  + arn                  = (known after apply)
  + id                   = (known after apply)
  + image_tag_mutability = "IMMUTABLE"
  + name                 = "nginx"
  + registry_id          = (known after apply)
  + repository_url       = (known after apply)
  + tags                 = {
      + "Name"      = "eg-dev-app"
      + "Namespace" = "eg"
      + "Stage"     = "dev"
    }
  + tags_all             = {
      + "Name"      = "eg-dev-app"
      + "Namespace" = "eg"
      + "Stage"     = "dev"
    }

  + image_scanning_configuration {
      + scan_on_push = true
    }
}

Expected Behavior

+ resource "aws_ecr_repository" "name" {
  + arn                  = (known after apply)
  + id                   = (known after apply)
  + image_tag_mutability = "IMMUTABLE"
  + name                 = "eg/nginx"
  + registry_id          = (known after apply)
  + repository_url       = (known after apply)
  + tags                 = {
      + "Name"      = "eg-dev-app"
      + "Namespace" = "eg"
      + "Stage"     = "dev"
    }
  + tags_all             = {
      + "Name"      = "eg-dev-app"
      + "Namespace" = "eg"
      + "Stage"     = "dev"
    }

  + image_scanning_configuration {
      + scan_on_push = true
    }
}

Allow the whole AWS Org for readonly

Describe the Feature

In scenarios where there are many AWS accounts in the AWS Org, it is often more practical to allow the whole org
to pull images than dozens individual accounts.

Expected Behavior

From each AWS account users and services can execute non-modifying actions, e.g. pulling the images, list images, etc.

Describe Ideal Solution

A pseudo-policy:

      {
        "Sid": "AllowOrgPull",
        "Effect": "Allow",
        "Principal": "*",
        "Condition": {
          "StringEquals": {
            "aws:PrincipalOrgID": ${jsonencode(data.aws_organizations_organization.current.id)}
          }
        },
        "Action": [
          "ecr:BatchGetImage",
          "ecr:BatchCheckLayerAvailability",
          "ecr:CreateRepository",
          "ecr:DescribeImages",
          "ecr:DescribeImageScanFindings",
          "ecr:DescribeRepositories",
          "ecr:GetAuthorizationToken",
          "ecr:GetDownloadUrlForLayer",
          "ecr:GetLifecyclePolicy",
          "ecr:GetLifecyclePolicyPreview",
          "ecr:GetRepositoryPolicy",
          "ecr:ListImages",
          "ecr:ListTagsForResource"
        ]
      },

Issues on importing ECR repositories

Describe the Bug

Hello, I wanted to import multiple ECR repositories into one ECR module. I was able to import only first repository. The rest of them gave me output errors like below:
First import:

terraform import 'module.ecs.module.ecr.aws_ecr_repository.name["YYYYYYYYYY"]' YYYYYYYYYY
module.ecs.module.ecr.aws_ecr_repository.name["YYYYYYYYYY"]: Importing from ID "YYYYYYYYYY"...
module.ecs.module.ecr.aws_ecr_repository.name["YYYYYYYYYY"]: Import prepared!
  Prepared aws_ecr_repository for import
module.ecs.module.ecr.aws_ecr_repository.name["YYYYYYYYYY"]: Refreshing state... [id=YYYYYYYYYY]

Import successful!

second import:

terraform import 'module.ecs.module.ecr.aws_ecr_repository.name["XXXXXXXXXXX"]' XXXXXXXXXXX
module.ecs.module.ecr.aws_ecr_repository.name["XXXXXXXXXXX"]: Importing from ID "XXXXXXXXXXX"...
module.ecs.module.ecr.aws_ecr_repository.name["XXXXXXXXXXX"]: Import prepared!
  Prepared aws_ecr_repository for import
module.ecs.module.ecr.aws_ecr_repository.name["XXXXXXXXXXX"]: Refreshing state... [id=XXXXXXXXXXX]

Error: Invalid index

  on .terraform/modules/ecs.ecr/outputs.tf line 2, in output "registry_id":
   2:   value       = module.this.enabled ? aws_ecr_repository.name[local.image_names[0]].registry_id : ""
    |----------------
    | aws_ecr_repository.name is object with 1 attribute "YYYYYYYYYY"
    | local.image_names[0] is "XXXXXXXXXXX"

The given key does not identify an element in this collection value.


Error: Invalid index

  on .terraform/modules/ecs.ecr/outputs.tf line 7, in output "repository_name":
   7:   value       = module.this.enabled ? aws_ecr_repository.name[local.image_names[0]].name : ""
    |----------------
    | aws_ecr_repository.name is object with 1 attribute "YYYYYYYYYY"
    | local.image_names[0] is "XXXXXXXXXXX"

The given key does not identify an element in this collection value.


Error: Invalid index

  on .terraform/modules/ecs.ecr/outputs.tf line 12, in output "repository_url":
  12:   value       = module.this.enabled ? aws_ecr_repository.name[local.image_names[0]].repository_url : ""
    |----------------
    | aws_ecr_repository.name is object with 1 attribute "YYYYYYYYYY"
    | local.image_names[0] is "XXXXXXXXXXX"

The given key does not identify an element in this collection value.


Error: Invalid index

  on .terraform/modules/ecs.ecr/outputs.tf line 17, in output "repository_arn":
  17:   value       = module.this.enabled ? aws_ecr_repository.name[local.image_names[0]].arn : ""
    |----------------
    | aws_ecr_repository.name is object with 1 attribute "YYYYYYYYYY"
    | local.image_names[0] is "XXXXXXXXXXX"

The given key does not identify an element in this collection value.

Expected Behavior

All imports are working without issue.

Steps to Reproduce

Steps to reproduce the behavior:

Create manually ECR repositories
Create manifest with the same names in variable image_names
try to import existing images into module
See error

Environment (please complete the following information):

Anything that will help us triage the bug will help. Here are some ideas:

OS: Linux
Module version 0.32.2
Terraform 0.13/0.14

Additional Context

This is our code for ecr module

module "ecr" {
  source                = "git::https://github.com/cloudposse/terraform-aws-ecr.git?ref=tags/0.32.2"
  enabled               = var.enabled && var.ecr_enabled
  name                  = var.name
  namespace             = var.namespace
  stage                 = var.stage
  tags                  = module.label.tags
  protected_tags        = var.ecr_protected_tag_prefixes
  max_image_count       = var.ecr_max_image_count
  image_tag_mutability  = var.ecr_image_tag_mutability
  image_names           = ["XXXXXXXXXXX", "YYYYYYYYYY"]
}

Would you add a count attribute to this module

Appreciate all your efforts

resource_full_access iam document is missing a few permissions

Describe the Bug

If the data source resource_full_access is truly for full access, then https://github.com/cloudposse/terraform-aws-ecr/blob/master/main.tf#L116 is missing the following permissions

"ecr:SetRepositoryPolicy",
"ecr:DeleteRepositoryPolicy",
"ecr:DeleteRepository",
"ecr:BatchDeleteImage",

Expected Behavior

Have those permissions above

Additional Context

There are a few ways we can solve this and my preference is the first.

Add the above perms to the resource_full_access document
Create a variable to override all those permissions or append those perms
Give resource_full_access all the ecr perms using ecr:*

@maximmi @aknysh

Module requires aws provider version 3.1.0

versions.tf requires aws = ">= 2.34"
But encryption_configuration in main.tf was introduced with aws provider version 3.1.0

How to get basic auth username / password?

Apologies in advance for this possibly naive question, but...

We have existing code that wants to push to an azure container registry via basic auth username / password. To use ecr, looking to replicate the same thing here.

The $ aws ecr get-login command returns -u AWS and -p {STS_TOKEN_REALLY_LONG_STRING_HERE}.

Is it possible to fetch this information via the outputs of this terraform module? If not, what is the recommended approach to that? (getting the STS token)

Add new image scanning configuration to the ECR repository

As of terraform aws provider 2.34.0 the ECR image repository now has an additional setting to enable image scanning for CVE vulnerabilities.

https://www.terraform.io/docs/providers/aws/r/ecr_repository.html

It looks like the README mentions a role functionality that is no longer available.

Based on this PR: https://github.com/cloudposse/terraform-aws-ecr/pull/21/files it seems that the usage docs may need to be updated.

Possibly instead of:

The module works in two distinct modes:

If you provide the existing IAM Role names in the roles attribute, the Roles will be granted permissions to work with the created registry.

If the roles attribute is omitted or is an empty list, a new IAM Role will be created and granted all the required permissions to work with the registry. The Role name will be assigned to the output variable role_name. In addition, an EC2 Instance Profile will be created from the new IAM Role, which might be assigned to EC2 instances granting them permissions to work with the ECR registry.

It could say something like:

The module works in two distinct modes:

If you provide the existing IAM Role names in the principals_full_access or principals_readonly_access attributes, the Roles will be granted permissions to work with the created registry.

If the principals_full_access and principals_readonly_access attributes are omitted or are an empty list no roles will be assigned to the cluster.

Happy to submit a PR, but also not sure if any variables should be required or what else is needed to update the README.

Add Example Usage

what

Add example invocation

why

We need this so we can soon enable automated continuous integration testing of module

Getting error from downloading module when running terraform init

I am getting this error when I run against the master branch. Currently I am skipping the latest commit and fetch from the second to last commit, it worked as expected. I am suspecting the last commit could have caused the issue

Error downloading modules: Error loading modules: module alert-engine-ecr: Error parsing .terraform/modules/612474be353f3466b76e6152fc91c0be/main.tf: At 2:42: Unknown token: 2:42 IDENT length

Add variable to override image_tag_mutability default value

Resource: aws_ecr_repository

image_tag_mutability - (Optional) The tag mutability setting for the repository. Must be one of: MUTABLE or IMMUTABLE. Defaults to MUTABLE.

Specifying Encryption type "KMS" with a custom KMS key specifies a destroy/create for each new plan

Found a bug? Maybe our Slack Community can help.

Describe the Bug

Specifying Encryption type "KMS" with a custom KMS key specifies a destroy/create of all defined registries for each new Terraform plan

Expected Behavior

No changes should be identified. Works as expected when not configuring a custom KMS key.