Add Docker registries `use_local_alias` configuration option. #17265

kaos · 2022-10-18T23:45:19Z

If you run an Docker image locally, support using a shorter image name than the full registry url required when publishing the image, to keep the image names briefer in case of very long registry addresses (AWS cough cough)

When ./pants run <image target> only the first registry with a "use_local_alias" defined on any of the applicable registries will be built and executed, while ./pants package <image target> always tags the built image with all image names, including the short ones.

Example:

# pants.toml

[docker.registries.company]
address = 123456789987654321.dkr.ecr.us-west-1.amazonaws.com
use_local_alias = true

$ ./pants run myservice:img
Building docker image: company/myservice:latest
...

Where as when you package myservice:img, it would tag it with both the registry address, and the alias and for publish it would push only the image with the registry address.

[ci skip-build-wheels] [ci skip-rust]

…-name/16354

src/python/pants/backend/docker/goals/run_image.py

…-name/16354

…ias instead as short name. + fix issue with build invocation from image run goal.

kaos · 2022-10-20T22:21:28Z

src/python/pants/backend/docker/goals/run_image.py

+        if registry.run_as_alias:
+            # We only need to tag a single image name for run requests if there is a registry with
+            # `run_as_alias` as true.
+            build_request = replace(


This is arguably a little bit hackish, but we simply override the list of registries selected for the docker build field set in case of a run request to only include the registry alias as a hardcoded value, overriding any defaults or field values. Sneaky.

kaos · 2022-10-20T22:22:17Z

@thejcannon does this do what you wish it did?

src/python/pants/backend/docker/goals/package_image.py

thejcannon

The example LGTM. I'll leave the implementation up to whoever to review.

Thanks!

benjyw

Neat! Couple of questions:

Should run_as_alias be local_alias? It may not be specific to the run goal so much as to local operations more generally?

Could we just always generate and use this alias? Do we need the flag?

kaos · 2022-11-06T17:44:04Z

Should run_as_alias be local_alias? It may not be specific to the run goal so much as to local operations more generally?

Thanks, I like that. 👍🏽

Could we just always generate and use this alias? Do we need the flag?

We could, yes. I was being a bit cautious in making this an opt-in feature. It could add up quite a few extra superfluous tags in case of multiple registries (although I don't know if that is a common thing or not).

I'm fine either way..

benjyw · 2022-11-07T03:53:05Z

Could we just always generate and use this alias? Do we need the flag?

We could, yes. I was being a bit cautious in making this an opt-in feature. It could add up quite a few extra superfluous tags in case of multiple registries (although I don't know if that is a common thing or not).

I'm fine either way..

Ah, that makes sense. So yeah, opt-in makes sense, and people can set with __defaults__ if they want to always opt in.

So the name should probably be use_local_alias or something that indicates that the value is a boolean. local_alias seems like it should be the string alias to use...

kaos · 2022-11-07T15:38:34Z

Could we just always generate and use this alias? Do we need the flag?

We could, yes. I was being a bit cautious in making this an opt-in feature. It could add up quite a few extra superfluous tags in case of multiple registries (although I don't know if that is a common thing or not).
I'm fine either way..

Ah, that makes sense. So yeah, opt-in makes sense, and people can set with __defaults__ if they want to always opt in.

So the name should probably be use_local_alias or something that indicates that the value is a boolean. local_alias seems like it should be the string alias to use...

Gotcha. I'll change to use_local_alias. Just noting that this is a pants configuration, not target field, so __defaults__ doesn't apply.

benjyw · 2022-11-07T15:42:15Z

Ah right, this is on the registry.

…-name/16354

Add Docker registries local_name configuration option.

50667fa

[ci skip-build-wheels] [ci skip-rust]

kaos added category:new feature backend: Docker Docker backend-related issues labels Oct 18, 2022

kaos requested a review from thejcannon October 18, 2022 23:45

Merge remote-tracking branch 'upstream/main' into docker-run-registry…

be78f96

…-name/16354

kaos commented Oct 19, 2022

View reviewed changes

src/python/pants/backend/docker/goals/run_image.py Outdated Show resolved Hide resolved

kaos marked this pull request as draft October 19, 2022 11:55

kaos added 2 commits October 20, 2022 16:39

Merge remote-tracking branch 'upstream/main' into docker-run-registry…

d8db9e9

…-name/16354

Flip local_name to run_as_alias bool ft toggle to use registry al…

e7edfc8

…ias instead as short name. + fix issue with build invocation from image run goal.

kaos changed the title ~~Add Docker registries local_name configuration option.~~ Add Docker registries run_as_alias configuration option. Oct 20, 2022

kaos marked this pull request as ready for review October 20, 2022 22:18

kaos commented Oct 20, 2022

View reviewed changes

Eric-Arellano reviewed Oct 20, 2022

View reviewed changes

src/python/pants/backend/docker/goals/package_image.py Outdated Show resolved Hide resolved

kaos added 2 commits November 4, 2022 13:47

Merge branch 'main' into docker-run-registry-name/16354

18a64e3

rename DockerFieldSet to DockerPackageFieldSet.

a93b055

thejcannon approved these changes Nov 4, 2022

View reviewed changes

benjyw reviewed Nov 5, 2022

View reviewed changes

kaos changed the title ~~Add Docker registries run_as_alias configuration option.~~ Add Docker registries use_local_alias configuration option. Nov 8, 2022

kaos added 2 commits November 8, 2022 08:30

Merge remote-tracking branch 'upstream/main' into docker-run-registry…

95940ce

…-name/16354

rename run_as_alias -> use_local_alias.

3d2a973

kaos enabled auto-merge (squash) November 8, 2022 14:01

kaos merged commit 3c0214c into pantsbuild:main Nov 8, 2022

kaos deleted the docker-run-registry-name/16354 branch November 8, 2022 16:35

huonw mentioned this pull request Nov 10, 2022

Export metadata about a packaged docker image #17299

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Docker registries `use_local_alias` configuration option. #17265

Add Docker registries `use_local_alias` configuration option. #17265

kaos commented Oct 18, 2022 •

edited

Loading

kaos Oct 20, 2022

kaos commented Oct 20, 2022

thejcannon left a comment

benjyw left a comment

kaos commented Nov 6, 2022

benjyw commented Nov 7, 2022

kaos commented Nov 7, 2022

benjyw commented Nov 7, 2022

Add Docker registries use_local_alias configuration option. #17265

Add Docker registries use_local_alias configuration option. #17265

Conversation

kaos commented Oct 18, 2022 • edited Loading

kaos Oct 20, 2022

Choose a reason for hiding this comment

kaos commented Oct 20, 2022

thejcannon left a comment

Choose a reason for hiding this comment

benjyw left a comment

Choose a reason for hiding this comment

kaos commented Nov 6, 2022

benjyw commented Nov 7, 2022

kaos commented Nov 7, 2022

benjyw commented Nov 7, 2022

Add Docker registries `use_local_alias` configuration option. #17265

Add Docker registries `use_local_alias` configuration option. #17265

kaos commented Oct 18, 2022 •

edited

Loading