This module allows you to copy docker image assets to a repository you control. This can be necessary if you want to build a Docker image in one CDK app and consume it in a different app or outside the CDK.
Project description
CDK Docker Image Deployment
This module allows you to copy docker image assets to a repository you control. This can be necessary if you want to build a Docker image in one CDK app and consume it in a different app or outside the CDK, or if you want to apply a lifecycle policy to all images of a part of your application.
Getting Started
Below is a basic example for how to use the DockerImageDeployment
API:
import * as ecr from 'aws-cdk-lib/aws-ecr';
import * as imagedeploy from 'cdk-docker-image-deployment';
const repo = new ecr.Repository.fromRepositoryName(this, 'MyRepository', 'myrepository');
new imagedeploy.DockerImageDeployment(this, 'ExampleImageDeploymentWithTag', {
source: imagedeploy.Source.directory('path/to/directory'),
destination: imagedeploy.Destination.ecr(repo, {
tag: 'myspecialtag',
}),
});
Currently Supported Sources
Source.directory()
: Supply a path to a local docker image as source.
Don't see a source listed? See if there is an open issue or PR already. If not, please open an issue asking for it or better yet, submit a contribution!
Currently Supported Destinations
Destination.ecr(repo, options)
: Send your docker image to an ECR repository in your stack's account.
Don't see a destination listed? See if there is an open issue or PR already. If not, please open an issue asking for it or better yet, submit a contribution!
Under the Hood
- When this stack is deployed (either via cdk deploy or via CI/CD), the contents of the local Docker image will be archived and uploaded to an intermediary assets ECR Repository using the cdk-assets mechanism.
- The
DockerImageDeployment
construct synthesizes a CodeBuild Project which uses docker to pull the image from the intermediary repository, tag the image if a tag is provided, and push the image to the destination repository. - The deployment will wait until the CodeBuild Project completes successfully before finishing.
The architecture of this construct can be seen here:
Security
See CONTRIBUTING for more information.
License
This project is licensed under the Apache-2.0 License.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for cdk-docker-image-deployment-0.0.267.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 55bab4eb3136bea666c20cedb7bef1cb574f8b8b06b2570d96541d508476110e |
|
MD5 | 8c3527bca098ef8da7bce0841d796569 |
|
BLAKE2b-256 | 9d446ebc70ba27ac6ed96cef0671f24a8a23286d8a113ab210d3d94c7efbef3c |
Hashes for cdk_docker_image_deployment-0.0.267-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5d191e8bf2ce0c7e07dc2da8cf9920317d169f390b4bc37e59f36dee14dcd4d3 |
|
MD5 | 9073e93ccc08d8ce36abb9cf2d83fc82 |
|
BLAKE2b-256 | 12296e1e4e6702e4e8b96ece8b164259199e1bad1c636cef6ec2fc53fd1d7c98 |