terraform-aws-ecr

Terraform module to create AWS ECR (Elastic Container Registry) which is a fully-managed Docker container registry.

Usage

You can use this module to create an ECR registry using few parameters (simple example) or define in detail every aspect of the registry (complete example).

Check the examples for the simple and the complete snippets.

Simple example

This example creates an ECR registry using few parameters

module "ecr" {

  source = "lgallard/ecr/aws"

  name         = "ecr-repo-dev"

  # Tags
  tags = {
    Owner       = "DevOps team"
    Environment = "dev"
    Terraform   = true
  }

}

Complete example

In this example the register is defined in detailed.

module "ecr" {

  source = "lgallard/ecr/aws"

  name                 = "ecr-repo-dev"
  scan_on_push         = true
  timeouts_delete      = "60m"
  image_tag_mutability = "MUTABLE"


  # Note that currently only one policy may be applied to a repository.
  policy = <<EOF
{
    "Version": "2008-10-17",
    "Statement": [
        {
            "Sid": "repo policy",
            "Effect": "Allow",
            "Principal": "*",
            "Action": [
                "ecr:GetDownloadUrlForLayer",
                "ecr:BatchGetImage",
                "ecr:BatchCheckLayerAvailability",
                "ecr:PutImage",
                "ecr:InitiateLayerUpload",
                "ecr:UploadLayerPart",
                "ecr:CompleteLayerUpload",
                "ecr:DescribeRepositories",
                "ecr:GetRepositoryPolicy",
                "ecr:ListImages",
                "ecr:DeleteRepository",
                "ecr:BatchDeleteImage",
                "ecr:SetRepositoryPolicy",
                "ecr:DeleteRepositoryPolicy"
            ]
        }
    ]
}
EOF

  # Only one lifecycle policy can be used per repository.
  # To apply multiple rules, combined them in one policy JSON.
  lifecycle_policy = <<EOF
{
    "rules": [
        {
            "rulePriority": 1,
            "description": "Expire untagged images older than 14 days",
            "selection": {
                "tagStatus": "untagged",
                "countType": "sinceImagePushed",
                "countUnit": "days",
                "countNumber": 14
            },
            "action": {
                "type": "expire"
            }
        },
        {
            "rulePriority": 2,
            "description": "Keep last 30 dev images",
            "selection": {
                "tagStatus": "tagged",
                "tagPrefixList": ["dev"],
                "countType": "imageCountMoreThan",
                "countNumber": 30
            },
            "action": {
                "type": "expire"
            }
        }
    ]
}
EOF

  # Tags
  tags = {
    Owner       = "DevOps team"
    Environment = "dev"
    Terraform   = true
  }

}

Requirements

No requirements.

Providers

Name	Version
aws	5.12.0

Modules

No modules.

Resources

Name	Type
aws_ecr_lifecycle_policy.lifecycle_policy	resource
aws_ecr_repository.repo	resource
aws_ecr_repository_policy.policy	resource
aws_kms_alias.kms_key_alias	resource
aws_kms_key.kms_key	resource

Inputs

Name	Description	Type	Default	Required
encryption_type	The encryption type to use for the repository. Valid values are `AES256` or `KMS`	`string`	`"AES256"`	no
force_delete	If `true`, will delete the repository even if it contains images. Defaults to `false`	`bool`	`false`	no
image_scanning_configuration	Configuration block that defines image scanning configuration for the repository. By default, image scanning must be manually triggered. See the ECR User Guide for more information about image scanning.	`map(any)`	`null`	no
image_tag_mutability	The tag mutability setting for the repository. Must be one of: `MUTABLE` or `IMMUTABLE`.	`string`	`"MUTABLE"`	no
kms_key	The ARN of the KMS key to use when encryption_type is `KMS`. If not specified when encryption_type is `KMS`, uses a new KMS key. Otherwise, uses the default AWS managed key for ECR.	`string`	`null`	no
lifecycle_policy	Manages the ECR repository lifecycle policy	`string`	`null`	no
name	Name of the repository.	`string`	n/a	yes
policy	Manages the ECR repository policy	`string`	`null`	no
scan_on_push	Indicates whether images are scanned after being pushed to the repository (true) or not scanned (false).	`bool`	`true`	no
tags	A mapping of tags to assign to the resource.	`map(string)`	`{}`	no
timeouts	Timeouts map.	`map(any)`	`{}`	no
timeouts_delete	How long to wait for a repository to be deleted.	`string`	`null`	no

Outputs

Name	Description
arn	Full ARN of the repository
name	The name of the repository.
registry_id	The registry ID where the repository was created.
repository_url	The URL of the repository (in the form `aws_account_id.dkr.ecr.region.amazonaws.com/repositoryName`)

lgallard/terraform-aws-ecr