README.md

terraform-aws-ecr

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!

Usage

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 works in two distinct modes:

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

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

Include this repository as a module in your existing terraform code:

# IAM Role is provided. It will 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"
  name                = "${var.name}"
  namespace           = "${var.namespace}"
  stage               = "${var.stage}"
  roles               = ["${data.aws_iam_role.ecr.name}"]
}

Example of attaching policies to a user for CI/CD

module "cicd_user" {
  source    = "git::https://github.com/cloudposse/terraform-aws-iam-system-user.git?ref=tags/0.3.0"
  namespace = "${var.namespace}"
  stage     = "${var.stage}"
  name      = "codefresh"
}

resource "aws_iam_policy_attachment" "login" {
  name       = "${module.cicd_user.user_name}-login"
  users      = ["${module.cicd_user.user_name}"]
  policy_arn = "${module.ecr.policy_login_arn}"
}

resource "aws_iam_policy_attachment" "read" {
  name       = "${module.cicd_user.user_name}-read"
  users      = ["${module.cicd_user.user_name}"]
  policy_arn = "${module.ecr.policy_read_arn}"
}

resource "aws_iam_policy_attachment" "write" {
  name       = "${module.cicd_user.user_name}-write"
  users      = ["${module.cicd_user.user_name}"]
  policy_arn = "${module.ecr.policy_write_arn}"
}

Makefile Targets

Available targets:

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

Inputs

Name	Description	Type	Default	Required
attributes	Additional attributes (e.g. policy or role)	list	<list>	no
delimiter	Delimiter to be used between name, namespace, stage, etc.	string	-	no
enabled	Set to false to prevent the module from creating any resources	string	true	no
max_image_count	How many Docker Image versions AWS ECR will store	string	500	no
name	The Name of the application or solution (e.g. bastion or portal)	string	-	yes
namespace	Namespace (e.g. cp or cloudposse)	string	-	yes
principals_full_access	Principal ARN to provide with full access to the ECR	list	<list>	no
principals_readonly_access	Principal ARN to provide with readonly access to the ECR	list	<list>	no
stage	Stage (e.g. prod, dev, staging)	string	-	yes
tags	Additional tags (e.g. map('BusinessUnit','XYZ'))	map	<map>	no
use_fullname	Set 'true' to use namespace-stage-name for ecr repository name, else name	string	true	no

Outputs

Name	Description
registry_id	Registry ID
registry_url	Registry URL
repository_name	Registry name

Share the Love

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

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.

Help

Got a question?

File a GitHub issue, send us an email or join our Slack Community.

Commercial Support

Work directly with our team of DevOps experts via email, slack, and video conferencing.

We provide commercial support for all of our Open Source projects. As a Dedicated Support customer, you have access to our team of subject matter experts at a fraction of the cost of a full-time engineer.

• Questions. We'll use a Shared Slack channel between your team and ours.
• Troubleshooting. We'll help you triage why things aren't working.
• Code Reviews. We'll review your Pull Requests and provide constructive feedback.
• Bug Fixes. We'll rapidly work to fix any bugs in our projects.
• Build New Terraform Modules. We'll develop original modules to provision infrastructure.
• Cloud Architecture. We'll assist with your cloud strategy and design.
• Implementation. We'll provide hands-on support to implement our reference architectures.

Terraform Module Development

Are you interested in custom Terraform module development? Submit your inquiry using our form today and we'll get back to you ASAP.

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

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

Contributing

Bug Reports & Feature Requests

Please use the issue tracker to report any bugs or file feature requests.

Developing

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.

1. Fork the repo on GitHub
2. Clone the project to your own machine
3. Commit changes to your own branch
4. Push your work back up to your fork
5. 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

Copyright © 2017-2019 Cloud Posse, LLC

License

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.

Trademarks

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

About

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.

Contributors

Igor Rodionov	Andriy Knysh	Sergey Vasilyev	Ivan Pinatti