Description

This module is able to use your Docker Hub details and periodically clone Docker Hub repo's to private ECR repositories. This way you won't run into Docker Hub rate limits. If you pair it with a VPC endpoint you can get improved pull results (and perhaps use this in a stricter environment with no internet access).

Your Docker Hub access token needs to have public repo pull permissions (that is the only permission it needs as well). Otherwise the CodeBuild will run into rate limiting issues because the networking is shared.

An example of the containers variable:

containers = {
  "mongo"           = ["latest"],
  "redis"           = ["latest"],
  "hashicorp/vault" = ["1.14", "1.13.3"],
}

The paths of the images will be prefixed with the namespace variable to prevent conflicts. If your image URLs will be:

XXXXX.dkr.ecr.eu-west-1.amazonaws.com/ecsclone/redis

This module also supports adding additional Dockerfile lines. This is helpful if you need to add VOLUME bind mounts to standard containers. For instance it can be used for Vault agent to creates a shared bind mount with the VOLUME keyword:

build_commands = {
  "hashicorp/vault:1.14" = [
    "RUN mkdir /etc/vault",
    "RUN chmod 777 /etc/vault",
    "VOLUME [\"/etc/vault\"]"
  ]
}

The resulting Dockerfile will be:

FROM hashicorp/vault:1.14
RUN mkdir /etc/vault
RUN chmod 777 /etc/vault
VOLUME ["/etc/vault"]

Now you can mount the same /etc/vault folder in your application containers and run them as a sidecar container. Vault can put the .env to the shared folder.

There are also other usecases for this. You might need to initialize a standard Docker image with environment variables with ENV that are not initialized when the container was built. This allows you to customize the behaviour of standard public containers without running your own build pipeline.

A fully working setup can be found in the examples folder.

For more debugging steps check out the elasticscale blog.

About ElasticScale

Discover ES Foundation, the smart digital infrastructure for SaaS companies that want to grow and thrive.

Check out our website for more information.

Requirements

Name	Version
aws	>= 4.22.0

Providers

Name	Version
aws	4.67.0
null	3.2.1

Modules

No modules.

Resources

Name	Type
aws_codebuild_project.main	resource
aws_ecr_lifecycle_policy.foopolicy	resource
aws_ecr_repository.ecr	resource
aws_iam_role.main	resource
aws_iam_role_policy.main	resource
aws_ssm_parameter.accesstoken	resource
null_resource.init	resource
aws_caller_identity.current	data source
aws_iam_policy_document.assume_role	data source
aws_iam_policy_document.main	data source
aws_region.current	data source

Inputs

Name	Description	Type	Default	Required
account_id	AWS account ID	string	null	no
build_commands	This allows you to add additional lines to the Dockerfile before pushing to ECR	map(list(string))	{}	no
containers	Containers to clone including tags	map(list(string))	n/a	yes
docker_hub_access_token	Docker Hub access token (public repo read only access)	string	n/a	yes
docker_hub_username	Docker Hub username	string	n/a	yes
namespace	Prefix to add before all pulled containers to prevent conflicts	string	"ecsclone"	no
prefix	Prefix to add to all resources	string	"ecs-clone-"	no
region	AWS region	string	null	no

Outputs

Name	Description
image_base_url	The base URL for your ECR images from Docker Hub