@aws-cdk/aws-ecr-assets
Advanced tools
@aws-cdk/aws-ecr-assets is an AWS CDK library that allows you to build and publish Docker images to Amazon Elastic Container Registry (ECR) as part of your AWS Cloud Development Kit (CDK) applications. This package simplifies the process of managing Docker images within your CDK stacks.
Building Docker Images
This feature allows you to build Docker images from a specified directory and include them in your CDK stack. The Docker image is built and uploaded to an ECR repository automatically.
const ecrAssets = require('@aws-cdk/aws-ecr-assets');
const cdk = require('@aws-cdk/core');
class MyStack extends cdk.Stack {
constructor(scope, id, props) {
super(scope, id, props);
new ecrAssets.DockerImageAsset(this, 'MyDockerImage', {
directory: path.join(__dirname, 'my-docker-image')
});
}
}
const app = new cdk.App();
new MyStack(app, 'MyStack');Using Docker Images in ECS
This feature demonstrates how to use a Docker image built with @aws-cdk/aws-ecr-assets in an Amazon ECS task definition. The Docker image is referenced directly from the ECR repository.
const ecs = require('@aws-cdk/aws-ecs');
const ecrAssets = require('@aws-cdk/aws-ecr-assets');
const cdk = require('@aws-cdk/core');
class MyStack extends cdk.Stack {
constructor(scope, id, props) {
super(scope, id, props);
const asset = new ecrAssets.DockerImageAsset(this, 'MyDockerImage', {
directory: path.join(__dirname, 'my-docker-image')
});
new ecs.ContainerImage.fromDockerImageAsset(asset);
}
}
const app = new cdk.App();
new MyStack(app, 'MyStack');Dockerode is a Node.js module that provides a Docker Remote API client. It allows you to manage Docker containers, images, and other Docker resources programmatically. Unlike @aws-cdk/aws-ecr-assets, which is tightly integrated with AWS CDK and ECR, Dockerode is a more general-purpose Docker client.
Node Docker API is another Node.js client for the Docker Remote API. It provides a simple and flexible way to interact with Docker from Node.js applications. While it offers similar functionalities to Dockerode, it is not specifically designed for integration with AWS services like @aws-cdk/aws-ecr-assets.
The AWS SDK for JavaScript provides a comprehensive set of tools for interacting with AWS services, including ECR. While you can use the AWS SDK to manage ECR repositories and images, it does not provide the same level of abstraction and integration with CDK as @aws-cdk/aws-ecr-assets.
This module allows bundling Docker images as assets.
Images are built from a local Docker context directory (with a Dockerfile),
uploaded to Amazon Elastic Container Registry (ECR) by the CDK toolkit
and/or your app's CI/CD pipeline, and can be naturally referenced in your CDK app.
import { DockerImageAsset } from '@aws-cdk/aws-ecr-assets';
const asset = new DockerImageAsset(this, 'MyBuildImage', {
directory: path.join(__dirname, 'my-image')
});
The directory my-image must include a Dockerfile.
This will instruct the toolkit to build a Docker image from my-image, push it
to an Amazon ECR repository and wire the name of the repository as CloudFormation
parameters to your stack.
By default, all files in the given directory will be copied into the docker
build context. If there is a large directory that you know you definitely
don't need in the build context you can improve the performance by adding the
names of files and directories to ignore to a file called .dockerignore, or
pass them via the exclude property. If both are available, the patterns
found in exclude are appended to the patterns found in .dockerignore.
The ignoreMode property controls how the set of ignore patterns is
interpreted. The recommended setting for Docker image assets is
IgnoreMode.DOCKER. If the context flag
@aws-cdk/aws-ecr-assets:dockerIgnoreSupport is set to true in your
cdk.json (this is by default for new projects, but must be set manually for
old projects) then IgnoreMode.DOCKER is the default and you don't need to
configure it on the asset itself.
Use asset.imageUri to reference the image. It includes both the ECR image URL
and tag.
You can optionally pass build args to the docker build command by specifying
the buildArgs property. It is recommended to skip hashing of buildArgs for
values that can change between different machines to maintain a consistent
asset hash.
const asset = new DockerImageAsset(this, 'MyBuildImage', {
directory: path.join(__dirname, 'my-image'),
buildArgs: {
HTTP_PROXY: 'http://10.20.30.2:1234'
},
invalidation: {
buildArgs: false
}
});
You can optionally pass a target to the docker build command by specifying
the target property:
const asset = new DockerImageAsset(this, 'MyBuildImage', {
directory: path.join(__dirname, 'my-image'),
target: 'a-target'
})
Images are loaded from a local tarball, uploaded to ECR by the CDK toolkit and/or your app's CI-CD pipeline, and can be naturally referenced in your CDK app.
import { TarballImageAsset } from '@aws-cdk/aws-ecr-assets';
const asset = new TarballImageAsset(this, 'MyBuildImage', {
tarballFile: 'local-image.tar'
});
This will instruct the toolkit to add the tarball as a file asset. During deployment it will load the container image
from local-image.tar, push it to an Amazon ECR repository and wire the name of the repository as CloudFormation parameters
to your stack.
DockerImageAsset is designed for seamless build & consumption of image assets by CDK code deployed to multiple environments
through the CDK CLI or through CI/CD workflows. To that end, the ECR repository behind this construct is controlled by the AWS CDK.
The mechanics of where these images are published and how are intentionally kept as an implementation detail, and the construct
does not support customizations such as specifying the ECR repository name or tags.
If you are looking for a way to publish image assets to an ECR repository in your control, you should consider using cdklabs/cdk-ecr-deployment, which is able to replicate an image asset from the CDK-controlled ECR repository to a repository of your choice.
Here an example from the cdklabs/cdk-ecr-deployment project:
import * as ecrdeploy from 'cdk-ecr-deployment';
const image = new DockerImageAsset(this, 'CDKDockerImage', {
directory: path.join(__dirname, 'docker'),
});
new ecrdeploy.ECRDeployment(this, 'DeployDockerImage', {
src: new ecrdeploy.DockerImageName(image.imageUri),
dest: new ecrdeploy.DockerImageName(`${cdk.Aws.ACCOUNT_ID}.dkr.ecr.us-west-2.amazonaws.com/test:nginx`),
});
⚠️ Please note that this is a 3rd-party construct library and is not officially supported by AWS. You are welcome to +1 this GitHub issue if you would like to see native support for this use-case in the AWS CDK.
Depending on the consumer of your image asset, you will need to make sure the principal has permissions to pull the image.
In most cases, you should use the asset.repository.grantPull(principal)
method. This will modify the IAM policy of the principal to allow it to
pull images from this repository.
If the pulling principal is not in the same account or is an AWS service that
doesn't assume a role in your account (e.g. AWS CodeBuild), pull permissions
must be granted on the resource policy (and not on the principal's policy).
To do that, you can use asset.repository.addToResourcePolicy(statement) to
grant the desired principal the following permissions: "ecr:GetDownloadUrlForLayer",
"ecr:BatchGetImage" and "ecr:BatchCheckLayerAvailability".
1.130.0 (2021-10-29)
DefaultSynthesizer deployments are never skipped (#17099) (c74b012), closes #16959FAQs
Docker image assets deployed to ECR
The npm package @aws-cdk/aws-ecr-assets receives a total of 44,912 weekly downloads. As such, @aws-cdk/aws-ecr-assets popularity was classified as popular.
We found that @aws-cdk/aws-ecr-assets demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.