(ecr-deployment): Native solution for pushing container images to named ECR repositories

[athewsey]

Describe the feature

A fully-supported, CDK-native way to stage container image assets to named ECR repositories, similar to how s3-deployment supports staging assets to S3.

Use Case

This has been a known gap for some time, and the aws-ecr-assets README still references issue #12597 which was actually accepted by the CDK team but then closed (incorrectly I would argue) without a solution getting rolled in to aws-cdk itself.

There are a range of reasons to want to stage container images defined in CDK stacks to named repositories rather than just the CDK-managed one: Both for philosophical environment tidiness; use-cases where developers need to access the images by name; and for setting up secure IAM permissions (since repository ARNs are name-dependent).

The non-native solutions under CDKLabs have struggled with persistent bugs and lack of maintenance (e.g. cdk-ecr-deployment#478, cdk-ecr-deployment#651, cdk-ecr-deployment#380, cdk-docker-image-deployment#433, etc)

Proposed Solution

A construct or sub-module (aws-ecr-deployment maybe?), maintained within this aws-cdk repository itself, for loading container image assets to named ECR repositories.

Other Information

I would be totally fine if the solution here is to re-open the original issue that's still mentioned on the README and close this one as a duplicate - but right now the docs are directing users to +1 an issue that's already been closed.

Acknowledgements

• [ ] I may be able to implement this feature request
• [ ] This feature might incur a breaking change

CDK version used

2.140.0

Environment details (OS name and version, etc.)

macOS

[tmokmss]

jfyi there is another non-native solution: ContainerImageBuild.

You can push a container image to any ECR repository with arbitrary image tag:

import { ContainerImageBuild } from 'deploy-time-build';

const image = new ContainerImageBuild(this, 'BuildImage', {
    directory: 'example-image',
    repository: repository,
    tag: 'foo',
});

with additonal configurations such as zstd compression or deploy-time build args injection.

[pahud]

Thank you. We recommend https://github.com/cdklabs/cdk-ecr-deployment at this moment.

Your feedback is very important. I'll bring it to the team's attention.