Use a version identifier label in all image tags built by `ddev`

[stasadev]

Is there an existing issue for this?

• I have searched the existing issues

Is your feature request related to a problem?

• feat: improve images cleanup in ddev delete images, ddev delete, ddev clean, fixes #5073, fixes #7201 #7151 (comment)

Another thing I noticed: if the image doesn't have a specific ddev version in its tag, it won't be rebuilt later.

So if users update ddev and use something like ddev/ddev-solr, the already built Solr image won't be rebuilt with the new ddev.

And ddev delete images doesn't remove deleted add-on image.

Describe your solution

This could be solved by always setting the image: field with proper tag identifier in fixComposeYaml().

Tag Identifier could be some new variable in versionconstants.go or we can rely on the WebTag.

Describe alternatives

Add-ons can set the image: on their own and use $DDEV_VERSION:

services:
  solr:
    image: ddev-solr:${DDEV_VERSION}-built
    build:
      ...

But I don't think that users on DDEV HEAD will be happy about it (because $DDEV_VERSION will change all the time).

Additional context

No response

[stasadev]

I tested the image: change with our postgres database and found that changing the image: alone isn't enough. Docker reuses its cache, so it ends up using the same image SHA with a new tag.

1. One option is to run docker-compose build --no-cache <service-name>. If we check that some image tag for a service doesn't exist, then we can run build without cache for that service before doing the usual docker-compose build on ddev start.
2. Another option is to modify the Dockerfile by adding a dummy ARG with tag at the top. This forces Docker to rebuild the image. I can do this for postgres, since we control the Dockerfile, but not for other extra services.

I'll use the second option for postgres in #7151 as a temporary measure so ddev delete images works properly. Later, I'll remove the temporary ARG when implementing the first option.

Edit: I'll simply check for postgres:*-built in #7151 for now, because that PR is already doing a lot.

[stasadev]

Different names for images can change the way we pull them in:

ddev/pkg/ddevapp/ddevapp.go

Lines 1865 to 1886 in 28aa456

	// PullContainerImages configured Docker images with full output, since docker-compose up doesn't have nice output
	func (app *DdevApp) PullContainerImages() error {
	images, err := app.FindAllImages()
	if err != nil {
	return err
	}
	// Don't pull xhgui if not in xhgui mode
	if app.GetXHProfMode() != types.XHProfModeXHGui {
	images = nodeps.RemoveItemFromSlice(images, ddevImages.GetXhguiImage())
	}
	images = append(images, FindNotOmittedImages(app)...)
	for _, i := range images {
	err := dockerutil.Pull(i)
	if err != nil {
	return err
	}
	util.Debug("Pulled image for %s", i)
	}
	return nil
	}

Which uses:

ddev/pkg/ddevapp/ddevapp.go

Lines 1905 to 1926 in 28aa456

	// FindAllImages returns an array of image tags for all containers in the compose file
	func (app *DdevApp) FindAllImages() ([]string, error) {
	var images []string
	if app.ComposeYaml == nil {
	return images, nil
	}
	if y, ok := app.ComposeYaml["services"]; ok {
	for _, v := range y.(map[string]interface{}) {
	if i, ok := v.(map[string]interface{})["image"]; ok {
	if strings.HasSuffix(i.(string), "-built") {
	i = strings.TrimSuffix(i.(string), "-built")
	if strings.HasSuffix(i.(string), "-"+app.Name) {
	i = strings.TrimSuffix(i.(string), "-"+app.Name)
	}
	}
	images = append(images, i.(string))
	}
	}
	}
	return images, nil
	}

And the logic for pulls may be changed with:

• Enable parallel download via docker compose during pre-pull of images #7163

[stasadev]

I was thinking about new labels to use them for all Docker resources created by DDEV.

com.ddev.version seems ideal, clear indicator which includes the version for reliable cleanup.
It also makes sense to add com.ddev.site-name everywhere in the app context.

We'll need to check for all the labels for compatibility (i.e. check for com.docker.compose.project), but this will lead to a cleaner setup moving forward.

---

In case of using labels, we don't need to edit image built tags.

[rfay]

i'd be in favor of some related labels, including git committish. I think we have an old issue about this, and docker has some good support.