Add buildx build --opt (EXPERIMENTAL)

This allows opt-in to new features of BuildKit that are not officially exposed to buildx yet. Signed-off-by: Akihiro Suda <[email protected]>
docker · Feb 19, 2024 · 43210bd · 43210bd
1 parent c9d1c41
commit 43210bd
Show file tree

Hide file tree

Showing 7 changed files with 150 additions and 122 deletions.
diff --git a/build/build.go b/build/build.go
@@ -97,6 +97,8 @@ type Options struct {
 	PrintFunc    *PrintFunc
 	SourcePolicy *spb.Policy
 	GroupRef     string
+
+	RawOpts map[string]string
 }
 
 type PrintFunc struct {
@@ -226,6 +228,9 @@ func toSolveOpt(ctx context.Context, node builder.Node, multiDriver bool, opt Op
 		AllowedEntitlements: opt.Allow,
 		SourcePolicy:        opt.SourcePolicy,
 	}
+	if opt.RawOpts != nil {
+		so.FrontendAttrs = opt.RawOpts
+	}
 
 	if so.Ref == "" {
 		so.Ref = identity.NewID()

diff --git a/commands/build.go b/commands/build.go
@@ -105,6 +105,8 @@ type buildOptions struct {
 	control.ControlOptions
 
 	invokeConfig *invokeConfig
+
+	rawOpts []string
 }
 
 func (o *buildOptions) toControllerOptions() (*controllerapi.BuildOptions, error) {
@@ -120,6 +122,11 @@ func (o *buildOptions) toControllerOptions() (*controllerapi.BuildOptions, error
 		return nil, err
 	}
 
+	rawOpts, err := listToMap(o.rawOpts, true)
+	if err != nil {
+		return nil, err
+	}
+
 	opts := controllerapi.BuildOptions{
 		Allow:          o.allow,
 		Annotations:    o.annotations,
@@ -141,6 +148,7 @@ func (o *buildOptions) toControllerOptions() (*controllerapi.BuildOptions, error
 		Pull:           o.pull,
 		ExportPush:     o.exportPush,
 		ExportLoad:     o.exportLoad,
+		RawOpts:        rawOpts,
 	}
 
 	// TODO: extract env var parsing to a method easily usable by library consumers
@@ -590,7 +598,8 @@ func buildCmd(dockerCli command.Cli, rootOpts *rootOptions, debugConfig *debug.D
 
 	if isExperimental() {
 		flags.StringVar(&options.printFunc, "print", "", "Print result of information request (e.g., outline, targets)")
-		cobrautil.MarkFlagsExperimental(flags, "print")
+		flags.StringArrayVar(&options.rawOpts, "opt", []string{}, "Set BuildKit frontend option directly")
+		cobrautil.MarkFlagsExperimental(flags, "print", "opt")
 	}
 
 	flags.BoolVar(&options.exportPush, "push", false, `Shorthand for "--output=type=registry"`)

diff --git a/controller/build/build.go b/controller/build/build.go
@@ -67,6 +67,7 @@ func RunBuild(ctx context.Context, dockerCli command.Cli, in controllerapi.Build
 		Target:        in.Target,
 		Ulimits:       controllerUlimitOpt2DockerUlimit(in.Ulimits),
 		GroupRef:      in.GroupRef,
+		RawOpts:       in.RawOpts,
 	}
 
 	platforms, err := platformutil.Parse(in.Platforms)

diff --git a/controller/pb/controller.pb.go b/controller/pb/controller.pb.go
diff --git a/controller/pb/controller.proto b/controller/pb/controller.proto
@@ -80,6 +80,7 @@ message BuildOptions {
   string Ref = 29;
   string GroupRef = 30;
   repeated string Annotations = 31;
+  map<string, string> RawOpts = 32;
 }
 
 message ExportEntry {

diff --git a/docs/reference/buildx_build.md b/docs/reference/buildx_build.md
@@ -34,6 +34,7 @@ Start a build
 | `--network`                                                                                                                                                        | `string`      | `default` | Set the networking mode for the `RUN` instructions during build                                     |
 | `--no-cache`                                                                                                                                                       |               |           | Do not use cache when building the image                                                            |
 | [`--no-cache-filter`](#no-cache-filter)                                                                                                                            | `stringArray` |           | Do not cache specified stages                                                                       |
+| `--opt`                                                                                                                                                            | `stringArray` |           | Set BuildKit frontend option directly (EXPERIMENTAL)                                                |
 | [`-o`](#output), [`--output`](#output)                                                                                                                             | `stringArray` |           | Output destination (format: `type=local,dest=path`)                                                 |
 | [`--platform`](#platform)                                                                                                                                          | `stringArray` |           | Set target platform for build                                                                       |
 | `--print`                                                                                                                                                          | `string`      |           | Print result of information request (e.g., outline, targets) (EXPERIMENTAL)                         |

diff --git a/docs/reference/buildx_debug_build.md b/docs/reference/buildx_debug_build.md
@@ -30,6 +30,7 @@ Start a build
 | `--network`                                                                                                                                                        | `string`      | `default` | Set the networking mode for the `RUN` instructions during build                                     |
 | `--no-cache`                                                                                                                                                       |               |           | Do not use cache when building the image                                                            |
 | `--no-cache-filter`                                                                                                                                                | `stringArray` |           | Do not cache specified stages                                                                       |
+| `--opt`                                                                                                                                                            | `stringArray` |           | Set BuildKit frontend option directly (EXPERIMENTAL)                                                |
 | `-o`, `--output`                                                                                                                                                   | `stringArray` |           | Output destination (format: `type=local,dest=path`)                                                 |
 | `--platform`                                                                                                                                                       | `stringArray` |           | Set target platform for build                                                                       |
 | `--print`                                                                                                                                                          | `string`      |           | Print result of information request (e.g., outline, targets) (EXPERIMENTAL)                         |