driver: make buildkitd "config" and "flags" names consistent

Signed-off-by: CrazyMax <[email protected]>

builder/builder.go

@@ -332,16 +332,16 @@ func GetBuilders(dockerCli command.Cli, txn *store.Txn) ([]*Builder, error) {
 }
 
 type CreateOpts struct {
- Name string
- Driver string
- NodeName string
- Platforms []string
- Flags string
- ConfigFile string
- DriverOpts []string
- Use bool
- Endpoint string
- Append bool
+ Name  string
+ Driver  string
+ NodeName  string
+ Platforms  []string
+ BuildkitdFlags string
+ BuildkitdConfigFile string
+ DriverOpts  []string
+ Use  bool
+ Endpoint  string
+ Append  bool
 }
 
 func Create(ctx context.Context, txn *store.Txn, dockerCli command.Cli, opts CreateOpts) (*Builder, error) {
@@ -429,11 +429,11 @@ func Create(ctx context.Context, txn *store.Txn, dockerCli command.Cli, opts Cre
  }
  }
 
- var flags []string
- if opts.Flags != "" {
- flags, err = shlex.Split(opts.Flags)
+ var buildkitdFlags []string
+ if opts.BuildkitdFlags != "" {
+ buildkitdFlags, err = shlex.Split(opts.BuildkitdFlags)
  if err != nil {
- return nil, errors.Wrap(err, "failed to parse buildkit flags")
+ return nil, errors.Wrap(err, "failed to parse buildkitd flags")
  }
  }
 
@@ -493,21 +493,21 @@ func Create(ctx context.Context, txn *store.Txn, dockerCli command.Cli, opts Cre
  setEp = false
  }
 
- m, err := csvToMap(opts.DriverOpts)
+ driverOpts, err := csvToMap(opts.DriverOpts)
  if err != nil {
  return nil, err
  }
 
- configFile := opts.ConfigFile
- if configFile == "" {
- // if buildkit config is not provided, check if the default one is
- // available and use it
+ buildkitdConfigFile := opts.BuildkitdConfigFile
+ if buildkitdConfigFile == "" {
+ // if buildkit daemon config is not provided, check if the default one
+ // is available and use it
  if f, ok := confutil.DefaultConfigFile(dockerCli); ok {
- configFile = f
+ buildkitdConfigFile = f
  }
  }
 
- if err := ng.Update(opts.NodeName, ep, opts.Platforms, setEp, opts.Append, flags, configFile, m); err != nil {
+ if err := ng.Update(opts.NodeName, ep, opts.Platforms, setEp, opts.Append, buildkitdFlags, buildkitdConfigFile, driverOpts); err != nil {
  return nil, err
  }
 

builder/node.go

@@ -142,7 +142,7 @@ func (b *Builder) LoadNodes(ctx context.Context, opts ...LoadNodesOption) (_ []N
  }
  }
 
- d, err := driver.GetDriver(ctx, "buildx_buildkit_"+n.Name, factory, n.Endpoint, dockerapi, imageopt.Auth, kcc, n.Flags, n.Files, n.DriverOpts, n.Platforms, b.opts.contextPathHash, lno.dialMeta)
+ d, err := driver.GetDriver(ctx, "buildx_buildkit_"+n.Name, factory, n.Endpoint, dockerapi, imageopt.Auth, kcc, n.BuildkitdFlags, n.Files, n.DriverOpts, n.Platforms, b.opts.contextPathHash, lno.dialMeta)
  if err != nil {
  node.Err = err
  return nil
@@ -217,33 +217,33 @@ func (n *Node) MarshalJSON() ([]byte, error) {
  pp = append(pp, platforms.Format(p))
  }
  return json.Marshal(struct {
- Name string
- Endpoint string
- Flags []string `json:",omitempty"`
- DriverOpts map[string]string `json:",omitempty"`
- Files map[string][]byte `json:",omitempty"`
- Status string `json:",omitempty"`
- ProxyConfig map[string]string `json:",omitempty"`
- Version string `json:",omitempty"`
- Err string `json:",omitempty"`
- IDs []string `json:",omitempty"`
- Platforms []string `json:",omitempty"`
- GCPolicy []client.PruneInfo `json:",omitempty"`
- Labels map[string]string `json:",omitempty"`
+ Name  string
+ Endpoint  string
+ BuildkitdFlags []string `json:"Flags,omitempty"`
+ DriverOpts  map[string]string `json:",omitempty"`
+ Files  map[string][]byte `json:",omitempty"`
+ Status  string `json:",omitempty"`
+ ProxyConfig  map[string]string `json:",omitempty"`
+ Version  string `json:",omitempty"`
+ Err  string `json:",omitempty"`
+ IDs  []string `json:",omitempty"`
+ Platforms  []string `json:",omitempty"`
+ GCPolicy  []client.PruneInfo `json:",omitempty"`
+ Labels  map[string]string `json:",omitempty"`
  }{
- Name: n.Name,
- Endpoint: n.Endpoint,
- Flags: n.Flags,
- DriverOpts: n.DriverOpts,
- Files: n.Files,
- Status: status,
- ProxyConfig: n.ProxyConfig,
- Version: n.Version,
- Err: nerr,
- IDs: n.IDs,
- Platforms: pp,
- GCPolicy: n.GCPolicy,
- Labels: n.Labels,
+ Name:  n.Name,
+ Endpoint:  n.Endpoint,
+ BuildkitdFlags: n.BuildkitdFlags,
+ DriverOpts:  n.DriverOpts,
+ Files:  n.Files,
+ Status:  status,
+ ProxyConfig:  n.ProxyConfig,
+ Version:  n.Version,
+ Err:  nerr,
+ IDs:  n.IDs,
+ Platforms:  pp,
+ GCPolicy:  n.GCPolicy,
+ Labels:  n.Labels,
  })
 }
 

commands/create.go

@@ -16,17 +16,17 @@ import (
 )
 
 type createOptions struct {
- name string
- driver string
- nodeName string
- platform []string
- actionAppend bool
- actionLeave bool
- use bool
- flags string
- configFile string
- driverOpts []string
- bootstrap bool
+ name  string
+ driver  string
+ nodeName  string
+ platform  []string
+ actionAppend  bool
+ actionLeave  bool
+ use  bool
+ driverOpts  []string
+ buildkitdFlags  string
+ buildkitdConfigFile string
+ bootstrap  bool
  // upgrade bool // perform upgrade of the driver
 }
 
@@ -51,16 +51,16 @@ func runCreate(ctx context.Context, dockerCli command.Cli, in createOptions, arg
  }
 
  b, err := builder.Create(ctx, txn, dockerCli, builder.CreateOpts{
- Name: in.name,
- Driver: in.driver,
- NodeName: in.nodeName,
- Platforms: in.platform,
- Flags: in.flags,
- ConfigFile: in.configFile,
- DriverOpts: in.driverOpts,
- Use: in.use,
- Endpoint: ep,
- Append: in.actionAppend,
+ Name:  in.name,
+ Driver:  in.driver,
+ NodeName:  in.nodeName,
+ Platforms:  in.platform,
+ DriverOpts:  in.driverOpts,
+ BuildkitdFlags: in.buildkitdFlags,
+ BuildkitdConfigFile: in.buildkitdConfigFile,
+ Use:  in.use,
+ Endpoint:  ep,
+ Append:  in.actionAppend,
  })
  if err != nil {
  return err
@@ -106,12 +106,16 @@ func createCmd(dockerCli command.Cli) *cobra.Command {
  flags.StringVar(&options.name, "name", "", "Builder instance name")
  flags.StringVar(&options.driver, "driver", "", fmt.Sprintf("Driver to use (available: %s)", drivers.String()))
  flags.StringVar(&options.nodeName, "node", "", "Create/modify node with given name")
- flags.StringVar(&options.flags, "buildkitd-flags", "", "Flags for buildkitd daemon")
- flags.StringVar(&options.configFile, "config", "", "BuildKit config file")
  flags.StringArrayVar(&options.platform, "platform", []string{}, "Fixed platforms for current node")
  flags.StringArrayVar(&options.driverOpts, "driver-opt", []string{}, "Options for the driver")
- flags.BoolVar(&options.bootstrap, "bootstrap", false, "Boot builder after creation")
+ flags.StringVar(&options.buildkitdFlags, "buildkitd-flags", "", "BuildKit daemon flags")
+
+ // we allow for both "--config" and "--buildkitd-config", although the latter is the recommended way to avoid ambiguity.
+ flags.StringVar(&options.buildkitdConfigFile, "buildkitd-config", "", "BuildKit daemon config file")
+ flags.StringVar(&options.buildkitdConfigFile, "config", "", "BuildKit daemon config file")
+ flags.MarkHidden("config")
 
+ flags.BoolVar(&options.bootstrap, "bootstrap", false, "Boot builder after creation")
  flags.BoolVar(&options.actionAppend, "append", false, "Append a node to builder instead of changing it")
  flags.BoolVar(&options.actionLeave, "leave", false, "Remove a node from builder instead of changing it")
  flags.BoolVar(&options.use, "use", false, "Set the current builder instance")

commands/inspect.go

@@ -84,11 +84,11 @@ func runInspect(ctx context.Context, dockerCli command.Cli, in inspectOptions) e
  fmt.Fprintf(w, "Error:\t%s\n", err.Error())
  } else {
  fmt.Fprintf(w, "Status:\t%s\n", nodes[i].DriverInfo.Status)
- if len(n.Flags) > 0 {
- fmt.Fprintf(w, "Flags:\t%s\n", strings.Join(n.Flags, " "))
+ if len(n.BuildkitdFlags) > 0 {
+ fmt.Fprintf(w, "BuildKit daemon flags:\t%s\n", strings.Join(n.BuildkitdFlags, " "))
  }
  if nodes[i].Version != "" {
- fmt.Fprintf(w, "Buildkit:\t%s\n", nodes[i].Version)
+ fmt.Fprintf(w, "BuildKit version:\t%s\n", nodes[i].Version)
  }
  platforms := platformutil.FormatInGroups(n.Node.Platforms, n.Platforms)
  if len(platforms) > 0 {

docs/reference/buildx_create.md

@@ -9,19 +9,19 @@ Create a new builder instance
 
 ### Options
 
-| Name | Type | Default | Description |
-|:----------------------------------------|:--------------|:--------|:----------------------------------------------------------------------|
-| [`--append`](#append) | | | Append a node to builder instead of changing it |
-| `--bootstrap` | | | Boot builder after creation |
-| [`--buildkitd-flags`](#buildkitd-flags) | `string` | | Flags for buildkitd daemon |
-| [`--config`](#config)  | `string` | | BuildKit config file  |
-| [`--driver`](#driver) | `string` | | Driver to use (available: `docker-container`, `kubernetes`, `remote`) |
-| [`--driver-opt`](#driver-opt) | `stringArray` | | Options for the driver |
-| [`--leave`](#leave) | | | Remove a node from builder instead of changing it |
-| [`--name`](#name) | `string` | | Builder instance name |
-| [`--node`](#node) | `string` | | Create/modify node with given name |
-| [`--platform`](#platform) | `stringArray` | | Fixed platforms for current node |
-| [`--use`](#use) | | | Set the current builder instance |
+| Name  | Type | Default | Description |
+|:------------------------------------------|:--------------|:--------|:----------------------------------------------------------------------|
+| [`--append`](#append)  | | | Append a node to builder instead of changing it |
+| `--bootstrap`  | | | Boot builder after creation |
+| [`--buildkitd-config`](#buildkitd-config) | `string` | | BuildKit daemon config file |
+| [`--buildkitd-flags`](#buildkitd-flags) | `string` | | BuildKit daemon flags |
+| [`--driver`](#driver)  | `string` | | Driver to use (available: `docker-container`, `kubernetes`, `remote`) |
+| [`--driver-opt`](#driver-opt)  | `stringArray` | | Options for the driver |
+| [`--leave`](#leave)  | | | Remove a node from builder instead of changing it |
+| [`--name`](#name)  | `string` | | Builder instance name |
+| [`--node`](#node)  | `string` | | Create/modify node with given name |
+| [`--platform`](#platform)  | `stringArray` | | Fixed platforms for current node |
+| [`--use`](#use)  | | | Set the current builder instance |
 
 
 <!---MARKER_GEN_END-->
@@ -55,24 +55,10 @@ $ docker buildx create --name eager_beaver --append mycontext2
 eager_beaver
 ```
 
-### <a name="buildkitd-flags"></a> Specify options for the buildkitd daemon (--buildkitd-flags)
+### <a name="buildkitd-config"></a> Specify a configuration file for the BuildKit daemon (--buildkitd-config)
 
 ```text
---buildkitd-flags FLAGS
-```
-
-Adds flags when starting the buildkitd daemon. They take precedence over the
-configuration file specified by [`--config`](#config). See `buildkitd --help`
-for the available flags.
-
-```text
---buildkitd-flags '--debug --debugaddr 0.0.0.0:6666'
-```
-
-### <a name="config"></a> Specify a configuration file for the buildkitd daemon (--config)
-
-```text
---config FILE
+--buildkitd-config FILE
 ```
 
 Specifies the configuration file for the buildkitd daemon to use. The configuration
@@ -90,6 +76,20 @@ certificates for registries in the `buildkitd.toml` configuration, the files
 will be copied into the container under `/etc/buildkit/certs` and configuration
 will be updated to reflect that.
 
+### <a name="buildkitd-flags"></a> Specify options for the BuildKit daemon (--buildkitd-flags)
+
+```text
+--buildkitd-flags FLAGS
+```
+
+Adds flags when starting the buildkitd daemon. They take precedence over the
+configuration file specified by [`--buildkitd-config`](#buildkitd-config). See
+`buildkitd --help` for the available flags.
+
+```text
+--buildkitd-flags '--debug --debugaddr 0.0.0.0:6666'
+```
+
 ### <a name="driver"></a> Set the builder driver to use (--driver)
 
 ```text

driver/docker-container/driver.go

@@ -494,7 +494,7 @@ func writeConfigFiles(m map[string][]byte) (_ string, err error) {
 }
 
 func getBuildkitFlags(initConfig driver.InitConfig) []string {
- flags := initConfig.BuildkitFlags
+ flags := initConfig.BuildkitdFlags
  if _, ok := initConfig.Files[buildkitdConfigFile]; ok {
  // There's no way for us to determine the appropriate default configuration
  // path and the default path can vary depending on if the image is normal

driver/docker-container/factory.go

@@ -56,7 +56,7 @@ func (f *factory) New(ctx context.Context, cfg driver.InitConfig) (driver.Driver
  case k == "network":
  d.netMode = v
  if v == "host" {
- d.InitConfig.BuildkitFlags = append(d.InitConfig.BuildkitFlags, "--allow-insecure-entitlement=network.host")
+ d.InitConfig.BuildkitdFlags = append(d.InitConfig.BuildkitdFlags, "--allow-insecure-entitlement=network.host")
  }
  case k == "image":
  d.image = v

driver/kubernetes/factory.go

@@ -105,7 +105,7 @@ func (f *factory) processDriverOpts(deploymentName string, namespace string, cfg
  Name: deploymentName,
  Image: bkimage.DefaultImage,
  Replicas: 1,
- BuildkitFlags: cfg.BuildkitFlags,
+ BuildkitFlags: cfg.BuildkitdFlags,
  Rootless: false,
  Platforms: cfg.Platforms,
  ConfigFiles: cfg.Files,

driver/manager.go

@@ -52,7 +52,7 @@ type InitConfig struct {
  EndpointAddr string
  DockerAPI dockerclient.APIClient
  KubeClientConfig KubeClientConfig
- BuildkitFlags  []string
+ BuildkitdFlags []string
  Files map[string][]byte
  DriverOpts map[string]string
  Auth Auth
@@ -103,13 +103,13 @@ func GetFactory(name string, instanceRequired bool) (Factory, error) {
  return nil, errors.Errorf("failed to find driver %q", name)
 }
 
-func GetDriver(ctx context.Context, name string, f Factory, endpointAddr string, api dockerclient.APIClient, auth Auth, kcc KubeClientConfig, flags []string, files map[string][]byte, do map[string]string, platforms []specs.Platform, contextPathHash string, dialMeta map[string][]string) (*DriverHandle, error) {
+func GetDriver(ctx context.Context, name string, f Factory, endpointAddr string, api dockerclient.APIClient, auth Auth, kcc KubeClientConfig, buildkitdFlags []string, files map[string][]byte, do map[string]string, platforms []specs.Platform, contextPathHash string, dialMeta map[string][]string) (*DriverHandle, error) {
  ic := InitConfig{
  EndpointAddr: endpointAddr,
  DockerAPI: api,
  KubeClientConfig: kcc,
  Name: name,
- BuildkitFlags:  flags,
+ BuildkitdFlags: buildkitdFlags,
  DriverOpts: do,
  Auth: auth,
  Platforms: platforms,

driver/remote/factory.go

@@ -46,7 +46,7 @@ func (f *factory) New(ctx context.Context, cfg driver.InitConfig) (driver.Driver
  if len(cfg.Files) > 0 {
  return nil, errors.Errorf("setting config file is not supported for remote driver")
  }
- if len(cfg.BuildkitFlags) > 0 {
+ if len(cfg.BuildkitdFlags) > 0 {
  return nil, errors.Errorf("setting buildkit flags is not supported for remote driver")
  }
 

hack/test-driver

@@ -49,7 +49,7 @@ if [ "$DRIVER" != "docker" ]; then
  for platform in ${PLATFORMS//,/ }; do
  createFlags=""
  if [ -f "$BUILDKIT_CFG" ]; then
- createFlags="$createFlags --config=${BUILDKIT_CFG}"
+ createFlags="$createFlags --buildkitd-config=${BUILDKIT_CFG}"
  fi
  if [ "$firstNode" = "0" ]; then
  createFlags="$createFlags --append"
@@ -71,7 +71,7 @@ if [ "$DRIVER" != "docker" ]; then
  else
  createFlags=""
  if [ -f "$BUILDKIT_CFG" ]; then
- createFlags="$createFlags --config=${BUILDKIT_CFG}"
+ createFlags="$createFlags --buildkitd-config=${BUILDKIT_CFG}"
  fi
  buildxCmd create ${createFlags} \
  --bootstrap \