imageName option is confusing

[t0yv0]

What happened?

Mitch Gerdisch
  Thursday at 5:58 PM

Given the following (awsx) code, I would expect the image tag in the ecr to be latest. Instead it is set to the imageName value (i.e. “mitch-image”).

Am I mistaken about how this should work? Or is this a bug?

const image = new awsx.ecr.Image("my-image", {
    imageName: "mitch-image",
    repositoryUrl: repository.url,
    context: "./app", // Path to your Dockerfile and application directory
    imageTag: "latest",
});

Checking up on this, #1171 introduced the imageName option but it's behaviorally identical to imageTag option at the moment, we probably only want one of those, not two. We should consider retracting 1171.

Example

See above.

Output of pulumi about

N/A

Additional context

No response

Contributing

Vote on this issue by adding a 👍 reaction.
To contribute a fix for this issue, leave a comment (and link to your pull request, if you've opened one already).

[flostadler]

Ideally we should remove imageName and keep only imageTag.

Image name usually refers to the part before the tag (see docker docs), but here the imageName is used like a tag.

For ECR, the image name is set when creating the repository. So if users want different image names, they need to create different repos. If they just want different tags, then they can set the imageTag property on awsx.ecr.Image

[flostadler]

If we're touching this, we should also try to fix the resource name of the Image. I just saw that's it's using the TAG as the resource name:

pulumi-awsx/awsx/ecr/image.ts

Lines 40 to 44 in 0cbb50c

	const imageName = args.imageName
	? args.imageName
	: imageTag
	? imageTag
	: createUniqueImageName(dockerInputs);

pulumi-awsx/awsx/ecr/image.ts

Line 89 in 0cbb50c

const image = new docker.Image(imageName, dockerImageArgs, { parent });

But you can have the same tag (e.g. latest) across many different images, which would lead to duplicate URN errors right now if they're in the same stack.