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.221.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 833e83861716540aeabd471ba16088f61b8c7f23399163da72f3b4e29ec3260a |
|
MD5 | 2cd085f06958b9805931a3eb16e763b0 |
|
BLAKE2b-256 | cf241bba4e0cfca6d77987a7e00edb47da2a611e77271aaa9566d612861506ef |
Hashes for cdk_docker_image_deployment-0.0.221-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1c426a28c6e468872b0c1d884950d1ec672b2435cbb7d9b2bc833491b553e413 |
|
MD5 | cda8c5454e55034a02f0d2e4a755a75a |
|
BLAKE2b-256 | fac82c29f676ead51a6b3c2cf5c5ba7bb8dce32ed110311f2e40843be9b54371 |