Better/More examples about building versus supplying container image

[mathieu-benoit]

Let's have more and dedicated examples about building versus supplying container image.

For examples:

• --image
• --override-property

Today, we have this for the --override-property: https://docs.score.dev/docs/how-to/overrides/#how-to-override-a-property, but we could illustrate for example --image and also with score-compose, we could illustrate something like this:

CONTAINER_NAME=hello-world
CONTAINER_IMAGE=${CONTAINER_NAME}:local
score-compose generate score.yaml \
		--build '${CONTAINER_NAME}={"context":".","tags":["${CONTAINER_IMAGE}"]}'
docker compose up --build -d

With that users can better understand their options, how and when they could build/supply their container images, etc.

[Siddhartha-singh01]

Hey @mathieu-benoit this is a great idea clearer examples around building vs. supplying container images would really help users.

I'd like to take this on. Could you assign this to me? Thanks!

[Siddhartha-singh01]

Thanks so much, @mathieu-benoit I'd really love to work on this one.

Here's my plan: I'll start by going through the existing --override-property docs to understand how that section is structured and how the examples are presented today. Once I have a good feel for the current pattern, I'll put together dedicated examples covering building vs. supplying a container image illustrating --image for supplying a pre-built image and --build for building from local source with score-compose, along with guidance on when each one makes sense.

I'll open a PR as soon as it's ready.

Will keep this thread updated if I have any questions along the way!

Thanks!

[mathieu-benoit]

Thanks @Siddhartha-singh01!

Yeah, let's add a new dedicated section in there https://docs.score.dev/docs/how-to/overrides/ at the bottom.

Something that can be reused in your PR:

The value provided to the score-compose generate --image flag overrides the image field of any workload that lacks an explicit image definition in its Score file. If you want to handle different images for different multiple workloads, see the example above with --override-property containers.my-service.image=python3.

Same for score-k8s.

And also specific to score-compose:

For score-compose generate, the --build parameter can be used to specify an optional build context to use for the given container. The format is either --build=container=./dir or --build=container={'"context":"./dir"}.

[Siddhartha-singh01]

Thanks for the guidance, @mathieu-benoit

I've updated #291 instead of a separate page, I added a new "Build or supply a container image" section at the bottom of the Overrides page, as you suggested. It reuses the wording you shared:

How to supply a pre-built image covers the --image flag for both score-compose and score-k8s, and points to the --override-property example above for handling different images across multiple workloads.
How to build a container image the score-compose specific --build flag, with the two supported formats and a short example.
Builds clean locally with yarn run hugo and passes dprint check. Let me know if you'd like any wording tweaks or a different example.

Thanks!