luxolus
/
open-nomad
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity

docker: set force=true on remove image to handle images referenced by multiple tags (#15962) 

* docker: set force=true on remove image to handle images referenced by multiple tags

This PR changes our call of docker client RemoveImage() to RemoveImageExtended with
the Force=true option set. This fixes a bug where an image referenced by more than
one tag could never be garbage collected by Nomad. The Force option only applies to
stopped containers; it does not affect running workloads.

* docker: add note about image_delay and multiple tags
This commit is contained in:
Seth Hoenig 2023-01-31 07:53:18 -06:00 committed by GitHub
parent 31eb30f5f5
commit 139f2c0b0f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.changelog/15962.txt Normal file
View File

@ -0,0 +1,3 @@
```release-note:bug
docker: Fixed a bug where images referenced by multiple tags would not be GC'd
```

6
drivers/docker/coordinator.go
View File

@ -59,7 +59,7 @@ func (p *pullFuture) set(imageID string, err error) {
type DockerImageClient interface { type DockerImageClient interface {
PullImage(opts docker.PullImageOptions, auth docker.AuthConfiguration) error PullImage(opts docker.PullImageOptions, auth docker.AuthConfiguration) error
InspectImage(id string) (*docker.Image, error) InspectImage(id string) (*docker.Image, error)
RemoveImage(id string) error RemoveImageExtended(id string, opts docker.RemoveImageOptions) error
} }
// LogEventFn is a callback which allows Drivers to emit task events. // LogEventFn is a callback which allows Drivers to emit task events.
@ -320,7 +320,9 @@ func (d *dockerCoordinator) removeImageImpl(id string, ctx context.Context) {
d.imageLock.Unlock() d.imageLock.Unlock()
for i := 0; i < 3; i++ { for i := 0; i < 3; i++ {
err := d.client.RemoveImage(id) err := d.client.RemoveImageExtended(id, docker.RemoveImageOptions{
Force: true, // necessary to GC images referenced by multiple tags
})
if err == nil { if err == nil {
break break
} }

2
drivers/docker/coordinator_test.go
View File

@ -48,7 +48,7 @@ func (m *mockImageClient) InspectImage(id string) (*docker.Image, error) {
}, nil }, nil
} }
func (m *mockImageClient) RemoveImage(id string) error { func (m *mockImageClient) RemoveImageExtended(id string, options docker.RemoveImageOptions) error {
m.lock.Lock() m.lock.Lock()
defer m.lock.Unlock() defer m.lock.Unlock()
m.removed[id]++ m.removed[id]++

3
website/content/docs/drivers/docker.mdx
View File

@ -959,7 +959,8 @@ host system.
here](https://golang.org/pkg/time/#ParseDuration), that defaults to `3m`. here](https://golang.org/pkg/time/#ParseDuration), that defaults to `3m`.
The delay controls how long Nomad will wait between an image being unused The delay controls how long Nomad will wait between an image being unused
and deleting it. If a task is received that uses the same image within and deleting it. If a task is received that uses the same image within
the delay, the image will be reused. the delay, the image will be reused. If an image is referenced by more than
one tag, `image_delay` may not work correctly.
- `container` - Defaults to `true`. This option can be used to disable Nomad - `container` - Defaults to `true`. This option can be used to disable Nomad
from removing a container when the task exits. Under a name conflict, from removing a container when the task exits. Under a name conflict,