Terraform module to provision an AWS ECR Docker Container registry.
This project is part of our comprehensive "SweetOps" approach towards DevOps.
It's 100% Open Source and licensed under the APACHE2.
We literally have hundreds of terraform modules that are Open Source and well-maintained. Check them out!
IMPORTANT: The master branch is used in source just as an example. In your code, do not pin to master because there may be breaking changes between releases.
Instead pin to the release tag (e.g. ?ref=tags/x.y.z) of one of our latest releases.
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 = "git::https://github.com/cloudposse/terraform-aws-ecr.git?ref=master"
namespace = "eg"
stage = "test"
name = "ecr"
principals_full_access = [data.aws_iam_role.ecr.arn]
}Available targets:
help Help screen
help/all Display help for all targets
help/short This help short screen
lint Lint terraform code
| Name | Version |
|---|---|
| terraform | >= 0.12.0, < 0.14.0 |
| aws | ~> 2.34 |
| local | ~> 1.2 |
| template | ~> 2.0 |
| Name | Version |
|---|---|
| aws | ~> 2.34 |
| Name | Description | Type | Default | Required |
|---|---|---|---|---|
| attributes | Additional attributes (e.g. policy or role) |
list(string) |
[] |
no |
| delimiter | Delimiter to be used between name, namespace, stage, etc. |
string |
"-" |
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 |
true |
no |
| environment | Environment, e.g. 'prod', 'staging', 'dev', 'pre-prod', 'UAT' | string |
"" |
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 |
"MUTABLE" |
no |
| max_image_count | How many Docker Image versions AWS ECR will store | number |
500 |
no |
| name | The Name of the application or solution (e.g. bastion or portal) |
string |
n/a | yes |
| namespace | Namespace (e.g. eg or cp) |
string |
"" |
no |
| principals_full_access | Principal ARNs to provide with full 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 | Regex to replace chars with empty string in namespace, environment, stage and name. By default only letters, digits, dash, slash, and underscore are allowed, all other chars are removed |
string |
"/[^a-z/A-Z_0-9-]/" |
no |
| scan_images_on_push | Indicates whether images are scanned after being pushed to the repository (true) or not (false) | bool |
false |
no |
| stage | Stage (e.g. prod, dev, staging) |
string |
"" |
no |
| tags | Additional tags (e.g. map('BusinessUnit','XYZ')) |
map(string) |
{} |
no |
| use_fullname | Set 'true' to use namespace-stage-name for ecr repository name, else name |
bool |
true |
no |
| 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 |
Like this project? Please give it a ★ on our GitHub! (it helps us a lot)
Are you using this project or any of our other projects? Consider leaving a testimonial. =)
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.
Got a question? We got answers.
File a GitHub issue, send us an email or join our Slack Community.
We are a DevOps Accelerator. We'll help you build your cloud infrastructure from the ground up so you can own it. Then we'll show you how to operate it and stick around for as long as you need us.
Work directly with our team of DevOps experts via email, slack, and video conferencing.
We deliver 10x the value for a fraction of the cost of a full-time engineer. Our track record is not even funny. If you want things done right and you need it done FAST, then we're your best bet.
- Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
- Release Engineering. You'll have end-to-end CI/CD with unlimited staging environments.
- Site Reliability Engineering. You'll have total visibility into your apps and microservices.
- Security Baseline. You'll have built-in governance with accountability and audit logs for all changes.
- GitOps. You'll be able to operate your infrastructure via Pull Requests.
- Training. You'll receive hands-on training so your team can operate what we build.
- Questions. You'll have a direct line of communication between our teams via a Shared Slack channel.
- Troubleshooting. You'll get help to triage when things aren't working.
- Code Reviews. You'll receive constructive feedback on Pull Requests.
- Bug Fixes. We'll rapidly work with you to fix any bugs in our projects.
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.
Participate in our Discourse Forums. Here you'll find answers to commonly asked questions. Most questions will be related to the enormous number of projects we support on our GitHub. Come here to collaborate on answers, find solutions, and get ideas about the products and services we value. It only takes a minute to get started! Just sign in with SSO using your GitHub account.
Sign up for our newsletter that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.
Join us every Wednesday via Zoom for our weekly "Lunch & Learn" sessions. It's FREE for everyone!
Please use the issue tracker to report any bugs or file feature requests.
If you are interested in being a contributor and want to get involved in developing this project or help out with our other projects, we would love to hear from you! Shoot us an email.
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
- 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!
Copyright © 2017-2020 Cloud Posse, LLC
See LICENSE for full details.
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.
All other trademarks referenced herein are the property of their respective owners.
This project is maintained and funded by Cloud Posse, LLC. Like it? Please let us know by leaving a testimonial!
We're a DevOps Professional Services company based in Los Angeles, CA. We ❤️ Open Source Software.
We offer paid support on all of our projects.
Check out our other projects, follow us on twitter, apply for a job, or hire us to help with your cloud strategy and implementation.
 Igor Rodionov |
 Andriy Knysh |
 Sergey Vasilyev |
 Ivan Pinatti |
 Erik Osterman |
|---|