builder: wire up new gc types for buildkit prune functionality #48720

jsternberg · 2024-10-21T20:39:22Z

- What I did

This wires up the new gc types that buildkit exposes in version 0.17. The previous flag, KeepBytes, was renamed to ReservedBytes and two new options, MaxUsed and MinFree were added.

MaxUsed corresponds to the maximum amount of space that buildkit will
use for the build cache and MinFree amount of free disk space for the
system to prevent the cache from using that space. This allows greater
configuration of the cache storage usage when used in situations where
docker is not the only service on the system using disk space.

Fixes #48639.

- How I did it

Modified the areas marked by @thaJeztah in #48639.

- How to verify it

Added some test cases to check that the old and new config options work.

- Description for the changelog

`docker buildx prune` now supports `reserved-space`, `max-used-space` and `min-free-space`, `keep-bytes` filters.
API: `POST /build/prune` renames `keep-bytes` to `reserved-space` and now supports additional prune parameters `max-used-space` and `min-free-space`.

- A picture of a cute animal (not mandatory but encouraged)

tonistiigi · 2024-10-21T20:50:45Z

builder/builder-next/worker/gc.go

-const defaultCap int64 = 2e9 // 2GB
+const (
+	defaultReservedSpaceBytes int64 = 2e9  // 2GB
+	defaultMaxUsedSpaceBytes  int64 = 10e9 // 10GB


If for some reason the disk size can not be detected then maxused and minfree should be left empty.

tonistiigi · 2024-10-21T20:51:57Z

builder/builder-next/worker/gc_windows.go

-	return defaultCap
+import "github.com/containerd/errdefs"
+
+func detectDiskSize(_ string) (int64, error) {


In buildkit we do have windows implementation and it seems to be in a reusable function.

Switched to using this implementation. It also means I can just delete both of these files.

jsternberg · 2024-10-22T16:22:53Z

Updated the swagger API and found a few additional places I missed by grepping for keep-storage.

jsternberg · 2024-10-24T14:58:28Z

Updated the default gc policy code after some offline feedback from @tonistiigi.

vvoland · 2024-10-25T11:55:57Z

api/server/router/build/build_routes.go

+		bs, err := strconv.Atoi(fv)
+		if err != nil {
+			return invalidParam{errors.Wrapf(err, "keep-storage is in bytes and expects an integer, got %v", fv)}
+		}


As this is a new API-level feature - we should either:

Not backport this to 27.x

Ship API v1.48 in 27.4 and move the current 1.48 API features to 1.49

cc @thaJeztah

Looks like this one dropped of my radar 🙈

Yes, I'm considering to skip this one for 27.4; IIUC, without this patch, things continue to work "as before", just the new options not being exposed (?).

For these changes above though, possibly we need some API-version gates? (need to look closer)

thompson-shaun · 2025-01-16T17:05:44Z

Since we're only targeting v28 are we ok to merge this?

@jsternberg can we get this to a green/merge state?

jsternberg · 2025-01-16T21:10:12Z

This is rebased now. The failing test doesn't seem to be related.

builder/builder-next/worker/gc.go

thompson-shaun · 2025-01-17T17:23:13Z

@vvoland @thaJeztah - API version check?

vvoland

New options should be API version gated.

docs/api/version-history.md also needs an entry for the newly supported options

jsternberg · 2025-01-21T17:55:52Z

@vvoland done. I've never done it before so please double check that I did it correctly.

If this is API version-gated, do we need the fallback code for keep-bytes to keep functioning?

vvoland

Thanks, looks good but spotted some minor issues.

Could you also update the description for the release notes to be more human-facing?
Mostly thinking about showing the user how to use it. Something along the lines of "docker buildx prune now supports X, Y and Y",

api/swagger.yaml

api/types/types.go

jsternberg · 2025-01-22T18:07:53Z

Done.

api/types/types.go

vvoland · 2025-01-27T11:06:09Z

api/types/types.go

+	Filters       filters.Args

-	// FIXME(thaJeztah): add new options; see https://github.com/moby/moby/issues/48639
+	KeepStorage int64 // Deprecated: deprecated in API 1.48.


for a follow up, should also update: https://github.com/docker/cli/blob/master/docs/deprecated.md

vvoland · 2025-01-27T11:08:28Z

client/build_prune.go

 	if opts.All {
 		query.Set("all", "1")
 	}
-	query.Set("keep-storage", strconv.Itoa(int(opts.KeepStorage)))


We're still keeping KeepStorage as deprecated, so we should still set it.

Restored this code.

This wires up the new gc types that buildkit exposes in version 0.17. The previous flag, `KeepBytes`, was renamed to `ReservedBytes` and two new options, `MaxUsed` and `MinFree` were added. `MaxUsed` corresponds to the maximum amount of space that buildkit will use for the build cache and `MinFree` amount of free disk space for the system to prevent the cache from using that space. This allows greater configuration of the cache storage usage when used in situations where docker is not the only service on the system using disk space. Signed-off-by: Jonathan A. Sternberg <[email protected]>

vvoland

LGTM, thanks!

tonistiigi reviewed Oct 21, 2024

View reviewed changes

jsternberg force-pushed the buildkit-gc-options branch 3 times, most recently from 8423932 to 78356dd Compare October 22, 2024 16:21

jsternberg force-pushed the buildkit-gc-options branch 3 times, most recently from acd6af2 to 4e3c41c Compare October 22, 2024 18:07

jsternberg marked this pull request as ready for review October 22, 2024 18:34

thaJeztah added area/builder Build status/2-code-review impact/changelog area/daemon Core Engine area/builder/buildkit Build process/cherry-pick/27.x labels Oct 23, 2024

thaJeztah added this to the 28.0.0 milestone Oct 23, 2024

jsternberg force-pushed the buildkit-gc-options branch from 4e3c41c to d6b6b79 Compare October 24, 2024 14:52

jsternberg requested a review from tonistiigi October 24, 2024 14:58

vvoland reviewed Oct 25, 2024

View reviewed changes

tonistiigi mentioned this pull request Dec 12, 2024

build: update gc documentation docker/docs#21617

Merged

thompson-shaun removed the process/cherry-pick/27.x label Jan 16, 2025

jsternberg force-pushed the buildkit-gc-options branch from d6b6b79 to c3646c4 Compare January 16, 2025 18:56

jsternberg force-pushed the buildkit-gc-options branch 2 times, most recently from 54b8050 to 998dca6 Compare January 16, 2025 22:03

tonistiigi approved these changes Jan 16, 2025

View reviewed changes

builder/builder-next/worker/gc.go Outdated Show resolved Hide resolved

vvoland requested changes Jan 21, 2025

View reviewed changes

vvoland reviewed Jan 22, 2025

View reviewed changes

api/swagger.yaml Show resolved Hide resolved

api/types/types.go Show resolved Hide resolved

jsternberg force-pushed the buildkit-gc-options branch from 7e90232 to f818f19 Compare January 22, 2025 18:06

vvoland requested changes Jan 23, 2025

View reviewed changes

api/types/types.go Show resolved Hide resolved

jsternberg force-pushed the buildkit-gc-options branch from f818f19 to 68e1fca Compare January 23, 2025 15:09

jsternberg requested a review from vvoland January 24, 2025 21:22

vvoland requested changes Jan 27, 2025

View reviewed changes

thaJeztah added the release-blocker PRs we want to block a release on label Jan 30, 2025

jsternberg force-pushed the buildkit-gc-options branch from 68e1fca to 8e52968 Compare January 30, 2025 15:54

jsternberg requested a review from vvoland January 30, 2025 15:54

thompson-shaun assigned vvoland Jan 30, 2025

vvoland approved these changes Jan 30, 2025

View reviewed changes

vvoland merged commit 72b8351 into moby:master Feb 3, 2025
153 checks passed

jsternberg deleted the buildkit-gc-options branch February 3, 2025 23:25

crazy-max mentioned this pull request Oct 27, 2025

docs: update buildgc example config to use new buildkit v0.17 options docker/cli#6579

Merged

builder: wire up new gc types for buildkit prune functionality #48720

builder: wire up new gc types for buildkit prune functionality #48720

Uh oh!

Conversation

jsternberg commented Oct 21, 2024 • edited by vvoland Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jsternberg commented Oct 22, 2024

Uh oh!

jsternberg commented Oct 24, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

thompson-shaun commented Jan 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jsternberg commented Jan 16, 2025

Uh oh!

Uh oh!

thompson-shaun commented Jan 17, 2025

Uh oh!

vvoland left a comment

Choose a reason for hiding this comment

Uh oh!

jsternberg commented Jan 21, 2025

Uh oh!

vvoland left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

jsternberg commented Jan 22, 2025

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

vvoland left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

jsternberg commented Oct 21, 2024 •

edited by vvoland

Loading

thompson-shaun commented Jan 16, 2025 •

edited

Loading