Is there an example of custom docker tag plugin?
# generalm
modern-wolf-36228
11/26/2021, 2:24 PMIs there an example of custom docker tag plugin?
c
curved-television-6568
11/26/2021, 2:58 PMNo, and that part is not easily plugged into, as-is.
curved-television-6568
11/26/2021, 2:59 PMFor custom tags, the by far easiest is if it is possible to set the desired tag (or part of the tag) as an environment variable when invoking pants, then you can define that as a build arg and use it in the tag.
curved-television-6568
11/26/2021, 2:59 PM Copy code
docker_image(image_tags=["{build_args.MY_VAR}"])curved-television-6568
11/26/2021, 3:00 PMthen either in
pants.toml Copy code
[docker]
build_args = ["MY_VAR"]curved-television-6568
11/26/2021, 3:00 PM Copy code
docker_image(extra_build_args=["MY_VAR"])curved-television-6568
11/26/2021, 3:02 PMUsing a plugin, I think “easiest” would be to define a custom target, with a derived
image_tagsm
modern-wolf-36228
11/26/2021, 3:02 PMthe double
docker_imagec
curved-television-6568
11/26/2021, 3:02 PMWhat’s your use case you’re trying to solve?
m
modern-wolf-36228
11/26/2021, 3:02 PMcustom tag using pipeline unique id
modern-wolf-36228
11/26/2021, 3:02 PMur solution is what I want
modern-wolf-36228
11/26/2021, 3:03 PMthe easy one
c
curved-television-6568
11/26/2021, 3:03 PMgreat 🙂
m
modern-wolf-36228
11/26/2021, 3:03 PMah
modern-wolf-36228
11/26/2021, 3:04 PMif I just use
docker_image(image_tags=["{<http://build_args.MY|build_args.MY>_VAR}"], extra_build_args=["MY_VAR"])c
curved-television-6568
11/26/2021, 3:05 PMI have stuff like this (to attach the BUILD_NUMBER from jenkins to the image version)
Copy code
# pants.toml
[docker]
build_args=["BUILD_NUMBER"] Copy code
docker_image(image_tags=["1.0-{build_args.BUILD_NUMBER}"])🙌 1
m
modern-wolf-36228
11/26/2021, 3:05 PMI have the exact same case
💯 2
modern-wolf-36228
11/26/2021, 3:05 PMand if I want to build locally, I need to have the env variable, right?
c
curved-television-6568
11/26/2021, 3:06 PMYes, for now… https://github.com/pantsbuild/pants/issues/13719
curved-television-6568
11/26/2021, 3:06 PM Copy code
BUILD_NUMBER=0 ./pants ... # does the trickm
modern-wolf-36228
11/26/2021, 3:08 PMI guess the work to create a plugin is not worth it, so I'll do the same
👍 1
modern-wolf-36228
11/26/2021, 3:08 PMsubscribed to that issue 🎉
modern-wolf-36228
11/26/2021, 3:08 PMthanks again @curved-television-6568 🙏
❤️ 1
g
gifted-soccer-38559
12/01/2021, 5:12 PMthanks for this thread! similar use-case here
💯 3
c
curved-television-6568
12/01/2021, 5:14 PMOK, so we should consider adding a section about this to the docker docs, perhaps.. 🙂
✅ 2
💯 3
curved-television-6568
12/27/2021, 11:47 AMAdded section with example for how to include dynamic data in the image tag when building a Docker image here: https://www.pantsbuild.org/v2.9/docs/tagging-docker-images#including-dynamic-data-in-the-image-tag-using-environment-variables
cc @happy-kitchen-89482 you may want to review, thanks 😉
h
happy-kitchen-89482
12/27/2021, 1:03 PMNice! Does this mean that the "Dynamically generated tags" callout beneath it is no longer accurate?
c
curved-television-6568
12/27/2021, 1:11 PMKind of, I changed the wording in it, to include the possibility for using env vars in combination with build args. But perhaps could be removed altogether..
h
happy-kitchen-89482
12/27/2021, 7:21 PMLG I'll tweak the phrasing a little if that's OK, for consistency with the tone of the docs
👍 1
❤️ 1
c
curved-television-6568
12/27/2021, 7:24 PMAbsolutely
h
happy-kitchen-89482
12/27/2021, 7:39 PMDone
happy-kitchen-89482
12/27/2021, 7:39 PMThanks!
c
curved-television-6568
12/27/2021, 7:40 PM✍️
curved-television-6568
12/27/2021, 7:42 PMNice 🙂
4 Views