build: label built images for reliable cleanup on down
#9819
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When running `compose down`, the `--rmi` flag can be passed,
which currently supports two values:
* `local`: remove any _implicitly-named_ images that Compose
built
* `all` : remove any named images (locally-built or fetched
from a remote repo)
Removing images in the `local` case can be problematic, as it's
historically been done via a fair amount of inference over the
Compose model. Additionally, when using the "project-model"
(by passing `--project-name` instead of using a Compose file),
we're even more limited: if no containers for the project are
running, there's nothing to derive state from to perform the
inference on.
As a first pass, we started labeling _containers_ with the name
of the locally-built image associated with it (if any) in docker#9715.
Unfortunately, this still suffers from the aforementioned problems
around using actual state (i.e. the containers might no longer
exist) and meant that when operating in file mode (the default),
things did not behave as expected: the label is not available
in the project since it only exists at runtime.
Now, with these changes, Compose will label any images it builds
with project metadata. Upon cleanup during `down`, the engine
image API is queried for related images and matched up with the
services for the project. As a fallback for images built with
prior versions of Compose, the previous approach is still taken.
See also:
* docker#9655
* docker#9715
Signed-off-by: Milas Bowman <[email protected]>
milas
commented
Sep 7, 2022
pkg/compose/down.go
Outdated
| @@ -190,17 +201,108 @@ func (s *composeService) removeNetwork(ctx context.Context, name string, w progr | |||
| return nil | |||
| } | |||
|
|
|||
| func (s *composeService) getServiceImagesToRemove(options api.DownOptions, project *types.Project) map[string]struct{} { | |||
| images := map[string]struct{}{} | |||
| //nolint:gocyclo | |||
There was a problem hiding this comment.
😬 😬 😬
I've tried to overly comment this method, and it's actually quite procedural despite the high cyclomatic complexity, but I'm interested in suggestions and am happy to refactor, as I do realize it's quite long.
nicksieger
reviewed
Sep 8, 2022
Signed-off-by: Milas Bowman <[email protected]>
Signed-off-by: Milas Bowman <[email protected]>
Signed-off-by: Milas Bowman <[email protected]>
milas
force-pushed
the
down-image-rm
branch
from
dc1397d
to
8016786
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What I did
When running
compose down, the--rmiflag can be passed, which currently supports two values:local: remove any implicitly-named images that Compose builtall: remove any named images (locally-built or fetched from a remote repo)Removing images in the
localcase can be problematic, as it's historically been done via a fair amount of inference over the Compose model. Additionally, when using the "project-model" (by passing--project-nameinstead of using a Compose file), we're even more limited: if no containers for the project are running, there's nothing to derive state from to perform the inference on.As a first pass, we started labeling containers with the name of the locally-built image associated with it (if any) in #9715. Unfortunately, this still suffers from the aforementioned problems around using actual state (i.e. the containers might no longer exist) and meant that when operating in file mode (the default), things did not behave as expected: the label is not available in the project since it only exists at runtime.
Now, with these changes, Compose will label any images it builds with project metadata. Upon cleanup during
down, the engine image API is queried for related images and matched up with the services for the project. As a fallback for images built with prior versions of Compose, the previous approach is still taken.Related issue
--rmidoesn't remove images when used together with-p#9655downwith--rmi#9715(not mandatory) A picture of a cute animal, if possible in relation with what you did
