Add ecr.RegistryImage resource for pushing existing images to ECR #1464

flostadler · 2025-01-06T18:50:38Z

The current awsx.ecr.Image resource is limited to building and pushing new images to ECR. However, many CI/CD workflows need to push pre-built images that may come from separate build processes or workflows.
This PR introduces a new awsx.ecr.RegistryImage component that enables pushing existing Docker images to ECR. The component extends the functionality of `docker.RegistryImage, automatically configures the provider with ECR credentials and detects changes to images to trigger pushes.

The component handles scenarios where the source image tag remains constant (e.g., my-image:latest) but the underlying image content has changed. Instead of relying solely on the image name for change detection, it uses the image's unique ID to determine when updates are needed. This ensures proper triggering of infrastructure updates when the source image was rebuilt.

Resolves #1203

awsx/ecr/registryImage.ts

corymhall

🚀

awsx/ecr/auth.ts

t0yv0 · 2025-01-10T18:42:14Z

Curious about this as I don't have a good intuition on our Docker support. My one question is adding new resources creates apparent complexity for the user, no? The matrix of possibilities is:

Image source: (1) prebuilt image; (2) need to build it
Destination: (1) ECR; (2) somewhere else? (3) nowhere, just build it

Does this matrix have very different Pulumi resources involved depending on what you are doing, and does this new resource make it even more complicated?

https://www.pulumi.com/registry/packages/docker-build/#example seems to be able to push to ECR, can it push a prebuilt image to ECR? I think yes?

flostadler · 2025-01-10T19:54:17Z

Curious about this as I don't have a good intuition on our Docker support. My one question is adding new resources creates apparent complexity for the user, no? The matrix of possibilities is:
Image source: (1) prebuilt image; (2) need to build it
Destination: (1) ECR; (2) somewhere else? (3) nowhere, just build it 
Does this matrix have very different Pulumi resources involved depending on what you are doing, and does this new resource make it even more complicated?

https://www.pulumi.com/registry/packages/docker-build/#example seems to be able to push to ECR, can it push a prebuilt image to ECR? I think yes?

The only resource that can push prebuilt images is docker.RegistryImage. (docker-build cannot)

Right now users would need to handle the auth bit and re-triggering the image push when the source image changes. This is what this PR addresses. Given that the feature request has 14 upvotes I’d argue that users have an appetite for this.

awsx/ecr/auth.ts

t0yv0 · 2025-01-13T18:55:00Z

awsx/ecr/registryImage.ts

+    const creds = pulumi
+      .output(args.repositoryUrl)
+      .apply((url) => getDockerCredentials({ registryUrl: url }, { parent: this }));
+    const provider = new docker.Provider(name, {


There is no way for the user to customize https://www.pulumi.com/registry/packages/docker/#remote-hosts or anything else about this provider. Possibly OK for now just noting.

Good point, I can quickly expose those. I don't think those are gonna be useful for most users (e.g. remote host) as part of pushing a local image, but it doesn't hurt to export them to support future use cases

Users can still reach this code with transforms possibly, if really needed.

t0yv0 · 2025-01-13T18:55:35Z

awsx/schema-types.ts

@@ -118,6 +119,20 @@ export interface ImageArgs {
    readonly repositoryUrl: pulumi.Input<string>;
    readonly target?: pulumi.Input<string>;
 }
+export abstract class RegistryImage<TData = any> extends (pulumi.ComponentResource)<TData> {
+    public image!: unknown | pulumi.Output<unknown>;


What is unknown here exactly?

Uh that's interesting, good catch!
Seems like the script for generating provider internal types has a bug or cannot properly handle references to docker??

The SDK and schema look good, but I'm gonna dig into this

Yeah, the type-gen for provider internal types was only configured to handle aws. I've added docker as well now

t0yv0 · 2025-01-13T18:56:19Z

examples/ts-ecr-registry-image/README.md

@@ -0,0 +1,5 @@
+# Pushing a local image to an ECR registry
+
+This example demonstrates how to push a local image to an ECR registry using the `awsx.ecr.RegistryImage` component.


t0yv0 · 2025-01-13T18:57:12Z

schemagen/pkg/gen/docs/ecr/registry-image.md

+{{% example %}}
+### Pushing an image to an ECR repository
+
+```typescript


Could be cool to source from examples but that's for another time :)

github-actions · 2025-01-15T14:57:17Z

Does the PR have any schema changes?

Looking good! No breaking changes found.

New resources:

ecr.RegistryImage

Maintainer note: consult the runbook for dealing with any breaking changes.

codecov · 2025-01-15T15:16:35Z

Codecov Report

Attention: Patch coverage is 0% with 76 lines in your changes missing coverage. Please review.

Project coverage is 0.00%. Comparing base (4aeca78) to head (0ff619a).
Report is 4 commits behind head on master.

Files with missing lines	Patch %	Lines
provider/pkg/schemagen/ecr.go	0.00%	58 Missing ⚠️
provider/pkg/schemagen/schema.go	0.00%	18 Missing ⚠️

Additional details and impacted files

@@          Coverage Diff           @@
##           master   #1464   +/-   ##
======================================
  Coverage    0.00%   0.00%           
======================================
  Files          10      10           
  Lines        2345    2398   +53     
======================================
- Misses       2345    2398   +53

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

pulumi-bot · 2025-01-16T16:33:10Z

This PR has been shipped in release v2.21.0.

flostadler added 5 commits January 6, 2025 19:36

Add schema for ecr.RegistryImage resource

e1539f5

Implement RegistryImage resource

b0b4389

regen schema

8669c8d

Regen SDK

693545d

Add test

7357678

flostadler added do-not-merge Do Not Merge blocked The issue cannot be resolved without 3rd party action. labels Jan 6, 2025

flostadler marked this pull request as draft January 6, 2025 18:50

flostadler added 3 commits January 6, 2025 19:51

Merge branch 'master' into flostadler/registry-image

66e4827

Remove unused code

3ddbbdc

Keep old behavior for ecr.Image

5909e85

flostadler marked this pull request as ready for review January 6, 2025 21:18

flostadler requested review from corymhall, t0yv0 and a team January 6, 2025 21:19

flostadler commented Jan 7, 2025

View reviewed changes

awsx/ecr/registryImage.ts Show resolved Hide resolved

flostadler commented Jan 7, 2025

View reviewed changes

awsx/ecr/registryImage.ts Outdated Show resolved Hide resolved

Default tag to 'latest'

7b82a05

flostadler self-assigned this Jan 7, 2025

fmt

68f76e4

corymhall approved these changes Jan 7, 2025

View reviewed changes

awsx/ecr/auth.ts Show resolved Hide resolved

flostadler added 2 commits January 8, 2025 10:30

Add docstrings

c351b0b

Merge branch 'master' into flostadler/registry-image

3f32536

Update docker to v4.6.0

8e5f0e5

flostadler removed blocked The issue cannot be resolved without 3rd party action. do-not-merge Do Not Merge labels Jan 13, 2025

Merge branch 'master' into flostadler/registry-image

6db431d

flostadler requested a review from corymhall January 13, 2025 17:51

t0yv0 reviewed Jan 13, 2025

View reviewed changes

awsx/ecr/auth.ts Outdated Show resolved Hide resolved

corymhall approved these changes Jan 13, 2025

View reviewed changes

t0yv0 reviewed Jan 13, 2025

View reviewed changes

t0yv0 approved these changes Jan 13, 2025

View reviewed changes

flostadler added 5 commits January 14, 2025 15:03

Handle refs to docker in generate-provider-types.ts

a2f8706

Add auth error handling

9a99481

Add docker dep to example

64bcff7

Merge branch 'master' into flostadler/registry-image

51f1929

Fix merge

30b16ad

flostadler added 2 commits January 15, 2025 16:27

Make linter happy

d7420ee

Make linter happy

0ff619a

flostadler merged commit 8a76562 into master Jan 16, 2025
25 checks passed

flostadler deleted the flostadler/registry-image branch January 16, 2025 13:15

pulumi-bot mentioned this pull request Jan 16, 2025

ECR Image: push without build #1203

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add ecr.RegistryImage resource for pushing existing images to ECR #1464

Add ecr.RegistryImage resource for pushing existing images to ECR #1464

flostadler commented Jan 6, 2025 •

edited

Loading

corymhall left a comment

t0yv0 commented Jan 10, 2025

flostadler commented Jan 10, 2025 •

edited

Loading

t0yv0 Jan 13, 2025

flostadler Jan 13, 2025

t0yv0 Jan 13, 2025

t0yv0 Jan 13, 2025

flostadler Jan 13, 2025

t0yv0 Jan 13, 2025

flostadler Jan 14, 2025

t0yv0 Jan 13, 2025

t0yv0 Jan 13, 2025

github-actions bot commented Jan 15, 2025

codecov bot commented Jan 15, 2025 •

edited

Loading

pulumi-bot commented Jan 16, 2025

		@@ -0,0 +1,5 @@
		# Pushing a local image to an ECR registry

		This example demonstrates how to push a local image to an ECR registry using the `awsx.ecr.RegistryImage` component.

Add ecr.RegistryImage resource for pushing existing images to ECR #1464

Add ecr.RegistryImage resource for pushing existing images to ECR #1464

Conversation

flostadler commented Jan 6, 2025 • edited Loading

corymhall left a comment

Choose a reason for hiding this comment

t0yv0 commented Jan 10, 2025

flostadler commented Jan 10, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Jan 15, 2025

Does the PR have any schema changes?

New resources:

codecov bot commented Jan 15, 2025 • edited Loading

Codecov Report

pulumi-bot commented Jan 16, 2025

flostadler commented Jan 6, 2025 •

edited

Loading

flostadler commented Jan 10, 2025 •

edited

Loading

codecov bot commented Jan 15, 2025 •

edited

Loading