/terraform-aws-ecr

This terraform module is used to create ECR on AWS.

Primary LanguageHCLApache License 2.0Apache-2.0

Terraform AWS ECR

This terraform module is used to create ECR on AWS.

Terraform Licence tfsec static-checks

We eat, drink, sleep and most importantly love DevOps. We are working towards strategies for standardizing architecture while ensuring security for the infrastructure. We are strong believer of the philosophy Bigger problems are always solved by breaking them into smaller manageable problems. Resonating with microservices architecture, it is considered best-practice to run database, cluster, storage in smaller connected yet manageable pieces within the infrastructure.

This module is basically combination of Terraform open source and includes automatation tests and examples. It also helps to create and improve your infrastructure with minimalistic code instead of maintaining the whole infrastructure code yourself.

We have fifty plus terraform modules. A few of them are comepleted and are available for open source usage while a few others are in progress.

Prerequisites

This module has a few dependencies:

Examples

IMPORTANT: Since the master branch used in source varies based on new modifications, we suggest that you use the release versions here.

Simple Example

Here is an example of how you can use this module in your inventory structure:

  module "ecr" {
    source      = "clouddrove/ecr/aws"
    version     = "1.3.0"
    name        = "ecr"
    scan_on_push         = true
    image_tag_mutability = "MUTABLE"
}

Inputs

Name Description Type Default Required
attributes Additional attributes (e.g. 1). list(any) 
[
  "environment",
  "name"
]
 no
delimiter Delimiter to be used between organization, environment, name and attributes. string "-" no
enabled_ecr Set to false to prevent the module from creating any resources. bool true no
encryption_configuration ECR encryption configuration 
object({
    encryption_type = string
    kms_key         = any
  })
 null no
environment Environment (e.g. prod, dev, staging). string "test" 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) {} no
image_tag_mutability The tag mutability setting for the repository. string "IMMUTABLE" no
label_order Label order, e.g. name,application. list(any) [] no
managedby ManagedBy, eg 'CloudDrove' string "anmol@clouddrove.com" no
max_image_count How many Docker Image versions AWS ECR will store. number 7 no
name Name (e.g. app or cluster). string "" no
principals_full_access Principal ARN to provide with full access to the ECR. list(any) [] no
principals_readonly_access Principal ARN to provide with readonly access to the ECR. list(any) [] no
repository Terraform current module repo string "https://github.com/clouddrove/terraform-aws-ecr" no
scan_on_push Indicates whether images are scanned after being pushed to the repository (true) or not scanned (false). bool true no
tags Additional tags (e.g. map(BusinessUnit,XYZ). map(any) {} no
timeouts Timeouts map. map(any) {} no
use_fullname Set 'true' to use namespace-stage-name for ecr repository name, else name. bool true no

Outputs

Name Description
arn Registry ARN.
registry_id Registry ID.
registry_url Registry URL.
repository_name Registry name.
tags A mapping of tags to assign to the resource.

Testing

In this module testing is performed with terratest and it creates a small piece of infrastructure, matches the output like ARN, ID and Tags name etc and destroy infrastructure in your AWS account. This testing is written in GO, so you need a GO environment in your system.

You need to run the following command in the testing folder:

  go test -run Test

Feedback

If you come accross a bug or have any feedback, please log it in our issue tracker, or feel free to drop us an email at hello@clouddrove.com.

If you have found it worth your time, go ahead and give us a ★ on our GitHub!

About us

At CloudDrove, we offer expert guidance, implementation support and services to help organisations accelerate their journey to the cloud. Our services include docker and container orchestration, cloud migration and adoption, infrastructure automation, application modernisation and remediation, and performance engineering.

We are The Cloud Experts!

We ❤️ Open Source and you can check out our other modules to get help with your new Cloud ideas.