forgeops image does not allow users to set image names for AWS ECR

[farnsworth2008]

In AWS ECR, repositories naming results in followed image style references.

$ACCOUNT_ID.dkr.ecr.$REGION.amazonaws.com/$ECR_NAME:$TAG

Our team needs some flexibility in the way our ECRs are named. We do not want to have ECRs named based based solely on the forge rock component name (i.e. we don't want an ECR named ds).

Our preferred names would be something like the following:

12345678.dkr.ecr.us-east-1.amazonaws.com/wizbang-ds:v0.0.1-0.1

Given an ECR named wizbang-ds I was unable to convince the forgeops image subcommand to produce output that I could use. When I provided a parameter of --image-repo 12345678.dkr.ecr.us-east-1.amazonaws.com/wizbang-ds forgeops attempted to use 12345678.dkr.ecr.us-east-1.amazonaws.com/wizbang-ds/ds:v0.0.1-0.1 as the fully qualified name which does not work with ECR.

Patching as follows solved my problem and I feel is a better system because when a user sets --image-repo they don't need the forgeops tool to add /{image_name}.

diff --git a/lib/python/releases.py b/lib/python/releases.py
index fbc8179..59971a1 100644
--- a/lib/python/releases.py
+++ b/lib/python/releases.py
@@ -199,7 +199,7 @@ def set_image(image_name, tag, repo=None):
     repo: string
     """
     data = { 'image': {} }
-    data['image']['repository'] = f"{repo}/{image_name}" if repo else image_name
+    data['image']['repository'] = f"{repo}" if repo else image_name
     if tag:
         data['image']['tag'] = tag
     return data

With the patch above, my scripting can use the following:

forgeops image \
--env-name "$fgo_env" \
--image-repo "$AWS_ACCOUNT.dkr.ecr.$AWS_REGION.amazonaws.com/wizbang-$component" \
--tag "$tag" \
"$component"

Please consider using this approach in the future or suggest another way to achive the same result with the existing forgeops tool.

[damonconway]

@farnsworth2008 Hi! Thanks for the feedback. I can't implement this change in this way because it breaks lots of functionality. However, how about adding some new flags instead to achieve the same result? I'm thinking of adding 2 flags to build and image. --name-prepend and --name-append That way it would flow more naturally with the existing use cases.

Your use case above would look like this:
forgeops image -e my_env --image-repo 12345678.dkr.ecr.us-east-1.amazonaws.com --name-prepend wizbang- --tag 8.0.1 ds

It will also be added to build:
forgeops build -e my_env -p my_profile --name-prepend wizbang- --release my_release --push-to 12345678.dkr.ecr.us-east-1.amazonaws.com --tag "8.0.1-$(date +%Y%m%d%H%M)" ds

Does this work for you?

[farnsworth2008]

It would work but I think the --name-prepend is a little weird. How about just having a --skip-image-prepend flag so --image-repo could be feel more normal to someone who works in the context where their image repos are like ECR. Or you could use --aws-ecr as the flag name.

My thinking is that for someone who works in AWS with ECR the idea they have is that --image-repo should be their ECR image not the top level domain. Yeah, I get why your system evolved to always append /{image_name} but if you made that conditional based on a boolean flag such as --skip-image-prepend or --aws-ecr I think it would be more clear because then your --image-repo could actually be an image repo.

But regardless I can make it work if you have a --name-prepend option.