-
Notifications
You must be signed in to change notification settings - Fork 288
/
docker_pruner.go
356 lines (305 loc) · 11.7 KB
/
docker_pruner.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
package dockerprune
import (
"context"
"fmt"
"sort"
"strings"
"time"
"github.com/docker/go-units"
"github.com/docker/docker/api/types"
"github.com/docker/docker/api/types/filters"
"github.com/tilt-dev/tilt/internal/container"
"github.com/tilt-dev/tilt/pkg/model"
"github.com/tilt-dev/tilt/internal/engine/buildcontrol"
"github.com/tilt-dev/tilt/internal/docker"
"github.com/tilt-dev/tilt/internal/sliceutils"
"github.com/tilt-dev/tilt/internal/store"
"github.com/tilt-dev/tilt/pkg/logger"
)
var gcEnabledSelector = fmt.Sprintf("%s=true", docker.GCEnabledLabel)
type DockerPruner struct {
dCli docker.Client
disabledForTesting bool
disabledOnSetup bool
lastPruneBuildCount int
lastPruneTime time.Time
}
var _ store.Subscriber = &DockerPruner{}
var _ store.SetUpper = &DockerPruner{}
func NewDockerPruner(dCli docker.Client) *DockerPruner {
return &DockerPruner{dCli: dCli}
}
func (dp *DockerPruner) DisabledForTesting(disabled bool) {
dp.disabledForTesting = disabled
}
func (dp *DockerPruner) SetUp(ctx context.Context, _ store.RStore) error {
err := dp.dCli.CheckConnected()
if err != nil {
// If Docker is not responding at all, other parts of the system will log this.
dp.disabledOnSetup = true
return nil
}
if err := dp.sufficientVersionError(); err != nil {
logger.Get(ctx).Infof(
"[Docker Prune] Docker API version too low for Tilt to run Docker Prune:\n\t%v", err,
)
dp.disabledOnSetup = true
return nil
}
return nil
}
// OnChange determines if any Tilt-built Docker images should be pruned based on settings and invokes the pruning
// process if necessary.
//
// Care should be taken when modifying this method to not introduce expensive operations unless necessary, as this
// is invoked for EVERY store action change batch. Because of this, the store (un)locking is done somewhat manually,
// so care must be taken to avoid locking issues.
func (dp *DockerPruner) OnChange(ctx context.Context, st store.RStore, summary store.ChangeSummary) error {
if dp.disabledForTesting || dp.disabledOnSetup || summary.IsLogOnly() {
return nil
}
state := st.RLockState()
settings := state.DockerPruneSettings
// Exit early if possible if any of the following is true:
// * Pruning is disabled entirely
// * Engine is currently building something
// * There are NO `docker_build`s in the Tiltfile
// * Something is queued for building
if !settings.Enabled || len(state.CurrentBuildSet) > 0 || !state.HasBuild() || buildcontrol.NextManifestNameToBuild(state) != "" {
st.RUnlockState()
return nil
}
// Prune as soon after startup as we can (waiting until we've built SOMETHING)
curBuildCount := state.CompletedBuildCount
shouldPrune := dp.lastPruneTime.IsZero() && curBuildCount > 0
// "Prune every X builds" takes precedence over "prune every Y hours"
if settings.NumBuilds != 0 {
buildsSince := curBuildCount - dp.lastPruneBuildCount
if buildsSince >= settings.NumBuilds {
shouldPrune = true
}
} else {
interval := settings.Interval
if interval == 0 {
interval = model.DockerPruneDefaultInterval
}
if time.Since(dp.lastPruneTime) >= interval {
shouldPrune = true
}
}
if shouldPrune {
// N.B. Only determine the ref selectors if we're actually going to prune - OnChange is called for every batch
// of store events and this is a comparatively expensive operation (lots of regex), but 99% of the time this
// is called, no pruning is going to happen, so avoid burning CPU cycles unnecessarily
imgSelectors := model.LocalRefSelectorsForManifests(state.Manifests(), state.Clusters)
st.RUnlockState()
dp.PruneAndRecordState(ctx, settings.MaxAge, settings.KeepRecent, imgSelectors, curBuildCount)
return nil
}
st.RUnlockState()
return nil
}
func (dp *DockerPruner) PruneAndRecordState(ctx context.Context, maxAge time.Duration, keepRecent int, imgSelectors []container.RefSelector, curBuildCount int) {
dp.Prune(ctx, maxAge, keepRecent, imgSelectors)
dp.lastPruneTime = time.Now()
dp.lastPruneBuildCount = curBuildCount
}
func (dp *DockerPruner) Prune(ctx context.Context, maxAge time.Duration, keepRecent int, imgSelectors []container.RefSelector) {
// For future: dispatch event with output/errors to be recorded
// in engineState.TiltSystemState on store (analogous to TiltfileState)
err := dp.prune(ctx, maxAge, keepRecent, imgSelectors)
if err != nil {
logger.Get(ctx).Infof("[Docker Prune] error running docker prune: %v", err)
}
}
func (dp *DockerPruner) prune(ctx context.Context, maxAge time.Duration, keepRecent int, imgSelectors []container.RefSelector) error {
l := logger.Get(ctx)
if err := dp.sufficientVersionError(); err != nil {
l.Debugf("[Docker Prune] skipping Docker prune, Docker API version too low:\t%v", err)
return nil
}
f := filters.NewArgs(
filters.Arg("label", gcEnabledSelector),
filters.Arg("until", maxAge.String()),
)
// PRUNE CONTAINERS
containerReport, err := dp.dCli.ContainersPrune(ctx, f)
if err != nil {
return err
}
prettyPrintContainersPruneReport(containerReport, l)
// PRUNE IMAGES
imageReport, err := dp.deleteOldImages(ctx, maxAge, keepRecent, imgSelectors)
if err != nil {
return err
}
prettyPrintImagesPruneReport(imageReport, l)
// PRUNE BUILD CACHE
opts := types.BuildCachePruneOptions{Filters: f}
cacheReport, err := dp.dCli.BuildCachePrune(ctx, opts)
if err != nil {
if !strings.Contains(err.Error(), `"build prune" requires API version`) {
return err
}
l.Debugf("[Docker Prune] skipping build cache prune, Docker API version too low:\t%s", err)
} else {
prettyPrintCachePruneReport(cacheReport, l)
}
return nil
}
func (dp *DockerPruner) inspectImages(ctx context.Context, imgs []types.ImageSummary) []types.ImageInspect {
result := []types.ImageInspect{}
for _, imgSummary := range imgs {
inspect, _, err := dp.dCli.ImageInspectWithRaw(ctx, imgSummary.ID)
if err != nil {
logger.Get(ctx).Debugf("[Docker Prune] error inspecting image '%s': %v", imgSummary.ID, err)
continue
}
result = append(result, inspect)
}
return result
}
// Return all image objects that exceed the max age threshold.
func (dp *DockerPruner) filterImageInspectsByMaxAge(ctx context.Context, inspects []types.ImageInspect, maxAge time.Duration, selectors []container.RefSelector) []types.ImageInspect {
result := []types.ImageInspect{}
for _, inspect := range inspects {
namedRefs, err := container.ParseNamedMulti(inspect.RepoTags)
if err != nil {
logger.Get(ctx).Debugf("[Docker Prune] error parsing repo tags for '%s': %v", inspect.ID, err)
continue
}
// LastTagTime indicates the last time the image was built, which is more
// meaningful to us than when the image was created.
if time.Since(inspect.Metadata.LastTagTime) >= maxAge && container.AnyMatch(namedRefs, selectors) {
if len(inspect.RepoTags) > 1 {
logger.Get(ctx).Debugf("[Docker Prune] cannot prune image %s (tags: %s); `docker image remove --force` "+
"required to remove an image with multiple tags (Docker throws error: "+
"\"image is referenced in one or more repositories\")",
inspect.ID, strings.Join(inspect.RepoTags, ", "))
continue
}
result = append(result, inspect)
}
}
return result
}
// Return all image objects that aren't in the N
// most recently used for each tag.
func (dp *DockerPruner) filterOutMostRecentInspects(ctx context.Context, inspects []types.ImageInspect, keepRecent int, selectors []container.RefSelector) []types.ImageInspect {
// First, sort the images in order from most recent to least recent.
recentFirst := append([]types.ImageInspect{}, inspects...)
sort.SliceStable(recentFirst, func(i, j int) bool {
// LastTagTime indicates the last time the image was built, which is more
// meaningful to us than when the image was created.
return recentFirst[i].Metadata.LastTagTime.After(recentFirst[j].Metadata.LastTagTime)
})
// Next, aggregate the images by which selector they match.
imgsBySelector := make(map[container.RefSelector][]types.ImageInspect)
for _, inspect := range recentFirst {
namedRefs, err := container.ParseNamedMulti(inspect.RepoTags)
if err != nil {
logger.Get(ctx).Debugf("[Docker Prune] error parsing repo tags for '%s': %v", inspect.ID, err)
continue
}
for _, sel := range selectors {
if sel.MatchesAny(namedRefs) {
imgsBySelector[sel] = append(imgsBySelector[sel], inspect)
break
}
}
}
// Finally, keep the N most recent for each tag.
idsToKeep := make(map[string]bool)
for _, list := range imgsBySelector {
for i := 0; i < keepRecent && i < len(list); i++ {
idsToKeep[list[i].ID] = true
}
}
result := []types.ImageInspect{}
for _, inspect := range inspects {
if !idsToKeep[inspect.ID] {
result = append(result, inspect)
}
}
return result
}
func (dp *DockerPruner) deleteOldImages(ctx context.Context, maxAge time.Duration, keepRecent int, selectors []container.RefSelector) (types.ImagesPruneReport, error) {
opts := types.ImageListOptions{
Filters: filters.NewArgs(
filters.Arg("label", gcEnabledSelector),
),
}
imgs, err := dp.dCli.ImageList(ctx, opts)
if err != nil {
return types.ImagesPruneReport{}, err
}
inspects := dp.inspectImages(ctx, imgs)
inspects = dp.filterImageInspectsByMaxAge(ctx, inspects, maxAge, selectors)
toDelete := dp.filterOutMostRecentInspects(ctx, inspects, keepRecent, selectors)
rmOpts := types.ImageRemoveOptions{PruneChildren: true}
var responseItems []types.ImageDeleteResponseItem
var reclaimedBytes uint64
for _, inspect := range toDelete {
items, err := dp.dCli.ImageRemove(ctx, inspect.ID, rmOpts)
if err != nil {
// No good way to detect in-use images from `inspect` output, so just ignore those errors
if !strings.Contains(err.Error(), "image is being used by running container") {
logger.Get(ctx).Debugf("[Docker Prune] error removing image '%s': %v", inspect.ID, err)
}
continue
}
responseItems = append(responseItems, items...)
reclaimedBytes += uint64(inspect.Size)
}
return types.ImagesPruneReport{
ImagesDeleted: responseItems,
SpaceReclaimed: reclaimedBytes,
}, nil
}
func (dp *DockerPruner) sufficientVersionError() error {
return dp.dCli.NewVersionError("1.30", "image | container prune with filter: label")
}
func prettyPrintImagesPruneReport(report types.ImagesPruneReport, l logger.Logger) {
if len(report.ImagesDeleted) == 0 && !l.Level().ShouldDisplay(logger.VerboseLvl) {
return
}
l.Infof("[Docker Prune] removed %d images, reclaimed %s",
len(report.ImagesDeleted), humanSize(report.SpaceReclaimed))
if len(report.ImagesDeleted) > 0 {
for _, img := range report.ImagesDeleted {
l.Debugf("\t- %s", prettyStringImgDeleteItem(img))
}
}
}
func prettyStringImgDeleteItem(img types.ImageDeleteResponseItem) string {
if img.Deleted != "" {
return fmt.Sprintf("deleted: %s", img.Deleted)
}
if img.Untagged != "" {
return fmt.Sprintf("untagged: %s", img.Untagged)
}
return ""
}
func prettyPrintCachePruneReport(report *types.BuildCachePruneReport, l logger.Logger) {
if len(report.CachesDeleted) == 0 && !l.Level().ShouldDisplay(logger.VerboseLvl) {
return
}
l.Infof("[Docker Prune] removed %d caches, reclaimed %s",
len(report.CachesDeleted), humanSize(report.SpaceReclaimed))
if len(report.CachesDeleted) > 0 {
l.Debugf("%s", sliceutils.BulletedIndentedStringList(report.CachesDeleted))
}
}
func prettyPrintContainersPruneReport(report types.ContainersPruneReport, l logger.Logger) {
if len(report.ContainersDeleted) == 0 && !l.Level().ShouldDisplay(logger.VerboseLvl) {
return
}
l.Infof("[Docker Prune] removed %d containers, reclaimed %s",
len(report.ContainersDeleted), humanSize(report.SpaceReclaimed))
if len(report.ContainersDeleted) > 0 {
l.Debugf(sliceutils.BulletedIndentedStringList(report.ContainersDeleted))
}
}
func humanSize(bytes uint64) string {
return units.HumanSize(float64(bytes))
}