README.yaml

#
# This is the canonical configuration for the `README.md`
# Run `make readme` to rebuild the `README.md`
#

# Name of this project
name: terraform-aws-ecr

# Tags of this project
tags:
  - aws
  - terraform
  - terraform-modules
  - platform
  - ecr
  - docker
  - docker-registry

# Categories of this project
categories:
  - terraform-modules/platform

# Logo for this project
#logo: docs/logo.png

# License of this project
license: "APACHE2"

# Canonical GitHub repo
github_repo: cloudposse/terraform-aws-ecr

# Badges to display
badges:
  - name: Latest Release
    image: https://img.shields.io/github/release/cloudposse/terraform-aws-ecr.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-aws-ecr/releases/latest
  - name: Last Updated
    image: https://img.shields.io/github/last-commit/cloudposse/terraform-aws-ecr.svg?style=for-the-badge
    url: https://github.com/cloudposse/terraform-aws-ecr/commits
  - name: Slack Community
    image: https://slack.cloudposse.com/for-the-badge.svg
    url: https://slack.cloudposse.com

# List any related terraform modules that this module may be used with or that this module depends on.
related:
  - name: "terraform-aws-jenkins"
    description: "Terraform module to build Docker image with Jenkins, save it to an ECR repo, and deploy to Elastic Beanstalk running Docker stack"
    url: "https://github.com/cloudposse/terraform-aws-jenkins"
  - name: "terraform-aws-kops-ecr"
    description: "Terraform module to provision an ECR repository and grant users and kubernetes nodes access to it."
    url: "https://github.com/cloudposse/terraform-aws-kops-ecr"

# Short description of this project
description: |-
  Terraform module to provision an [`AWS ECR Docker Container registry`](https://aws.amazon.com/ecr/).

# How to use this project
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](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#Principal_specifying).
  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](https://docs.aws.amazon.com/AmazonECR/latest/userguide/security_iam_service-with-iam.html).

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

  ```hcl
  # 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]
  }
  ```

include:
  - "docs/targets.md"
  - "docs/terraform.md"

# Contributors to this project
contributors: []