add top-level "docker bake" command as alias for "docker buildx bake" #5947

thaJeztah · 2025-03-21T12:34:40Z

The docker buildx bake command has reached GA; this patch adds a top-level docker bake command as alias for docker buildx bake to improve discoverability and make it more convenient to use.

With this patch:

docker --help

Usage:  docker [OPTIONS] COMMAND

A self-sufficient runtime for containers

Common Commands:
  run         Create and run a new container from an image
  exec        Execute a command in a running container
  ps          List containers
  build       Build an image from a Dockerfile
  bake        Build from a file
  pull        Download an image from a registry
  push        Upload an image to a registry
  images      List images
...

The command is hidden if buildx is not installed;

docker --help
Usage:  docker [OPTIONS] COMMAND

A self-sufficient runtime for containers

Common Commands:
  run         Create and run a new container from an image
  exec        Execute a command in a running container
  ps          List containers
  build       Build an image from a Dockerfile
  pull        Download an image from a registry
  push        Upload an image to a registry
  images      List images
...

We can do some tweaking after this; currently it show an error in situations where buildx is missing. We don't account for "DOCKER_BUILDKIT=0", because this is a new feature that requires buildx, and cannot be "disabled";

buildx missing;

docker bake
ERROR: bake requires the buildx component but it is missing or broken.
       Install the buildx component to use bake:
       https://docs.docker.com/go/buildx/

BuildKit disabled:

DOCKER_BUILDKIT=0 docker bake
ERROR: bake requires the buildx component but it is missing or broken.

- Human readable description for the release notes

Add `docker bake` sub-command as alias for `docker buildx bake`

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

codecov-commenter · 2025-03-21T12:36:06Z

Codecov Report

Attention: Patch coverage is 23.33333% with 23 lines in your changes missing coverage. Please review.

Project coverage is 59.05%. Comparing base (e937b52) to head (adb0aba).
Report is 2 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #5947      +/-   ##
==========================================
- Coverage   59.10%   59.05%   -0.05%     
==========================================
  Files         357      357              
  Lines       29839    29843       +4     
==========================================
- Hits        17635    17624      -11     
- Misses      11228    11241      +13     
- Partials      976      978       +2

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

thaJeztah · 2025-03-21T12:44:02Z

docs/reference/commandline/docker.md

 | [`attach`](attach.md)         | Attach local standard input, output, and error streams to a running container |
+| [`bake`](bake.md)             | Build from a file                                                             |
 | [`build`](build.md)           | Build an image from a Dockerfile                                              |
 | [`builder`](builder.md)       | Manage builds                                                                 |


Probably something we need to improve when generating these, and have an option to specify a custom target for these (so that bake can link to https://docs.docker.com/buildx/bake.md, and attach can link to docker container attach directly).

ISTR we had this for flags, but not sure now if we had it for commands.

crazy-max · 2025-03-24T08:31:37Z

cli/command/builder/cmd.go

+// alias for "docker buildx bake" if BuildKit is enabled (and the buildx plugin
+// installed).


How does it check if buildx plugin is installed? Through aliases annotation?

thaJeztah · 2025-04-11T11:59:42Z

How does it check if buildx plugin is installed? Through aliases annotation?

I just tested some permutations

We can do some tweaking after this; currently it shows deprecation warnings
in situations where buildx is missing, or DOCKER_BUILDKIT=0 is set;

buildx missing;

docker bake
DEPRECATED: The legacy builder is deprecated and will be removed in a future release.
            Install the buildx component to build images with BuildKit:
            https://docs.docker.com/go/buildx/

Usage:  docker bake [OPTIONS] [TARGET...]

Build from a file

Aliases:
  docker buildx bake

BuildKit disabled:

DOCKER_BUILDKIT=0 docker bake
DEPRECATED: The legacy builder is deprecated and will be removed in a future release.
            BuildKit is currently disabled; enable it by removing the DOCKER_BUILDKIT=0
            environment-variable.

Usage:  docker bake [OPTIONS] [TARGET...]

Build from a file

Aliases:
  docker buildx bake

thaJeztah · 2025-04-11T12:01:20Z

@vvoland @crazy-max let me know if that looks "good enough" for a start. I will try to make some tweaks after this to make the error-message more correct, but it should be more and more of a corner-case if buildx is missing.

crazy-max · 2025-04-11T12:08:18Z

buildx missing;
...
BuildKit disabled:

I think this should be a noop if buildx is missing or BuildKit disabled imo as there is no possibility to fallback to legacy builder with bake. Maybe we should error out in such case?

thaJeztah · 2025-04-11T13:11:14Z

I think this should be a noop if buildx is missing or BuildKit disabled imo as there is no possibility to fallback to legacy builder with bake. Maybe we should error out in such case?

Yeah, I could change the stub command to return an error; the tricky bit here is that all the warnings are printed in the complex logic we have to forward to buildx; we really need to look at that code again, as it's ... complex.

cli/cmd/docker/docker.go

Line 427 in c718d3f

args, os.Args, envs, err = processAliases(dockerCli, cmd, args, os.Args)

cli/cmd/docker/builder.go

Lines 45 to 134 in c718d3f

    
           func processBuilder(dockerCli command.Cli, cmd *cobra.Command, args, osargs []string) ([]string, []string, []string, error) { 
        
           	var buildKitDisabled, useBuilder, useAlias bool 
        
           	var envs []string 
        
           	// check DOCKER_BUILDKIT env var is not empty 
        
           	// if it is assume we want to use the builder component 
        
           	if v := os.Getenv("DOCKER_BUILDKIT"); v != "" { 
        
           		enabled, err := strconv.ParseBool(v) 
        
           		if err != nil { 
        
           			return args, osargs, nil, fmt.Errorf("DOCKER_BUILDKIT environment variable expects boolean value: %w", err) 
        
           		} 
        
           		if !enabled { 
        
           			buildKitDisabled = true 
        
           		} else { 
        
           			useBuilder = true 
        
           		} 
        
           	} 
        
           	// if a builder alias is defined, use it instead 
        
           	// of the default one 
        
           	builderAlias := builderDefaultPlugin 
        
           	aliasMap := dockerCli.ConfigFile().Aliases 
        
           	if v, ok := aliasMap[keyBuilderAlias]; ok { 
        
           		useBuilder = true 
        
           		useAlias = true 
        
           		builderAlias = v 
        
           	} 
        
           	// is this a build that should be forwarded to the builder? 
        
           	fwargs, fwosargs, fwcmdpath, forwarded := forwardBuilder(builderAlias, args, osargs) 
        
           	if !forwarded { 
        
           		return args, osargs, nil, nil 
        
           	} 
        
           	if !useBuilder { 
        
           		// Builder is not explicitly configured as an alias for buildx. 
        
           		// Detect whether we should use BuildKit, or fallback to the 
        
           		// legacy builder. 
        
           		if si := dockerCli.ServerInfo(); si.BuildkitVersion != types.BuilderBuildKit && si.OSType == "windows" { 
        
           			// The daemon didn't advertise BuildKit as the preferred builder, 
        
           			// so use the legacy builder, which is still the default for 
        
           			// Windows / WCOW. 
        
           			return args, osargs, nil, nil 
        
           		} 
        
           	} 
        
           	if buildKitDisabled { 
        
           		// When using a Linux daemon, print a warning that the legacy builder 
        
           		// is deprecated. For Windows / WCOW, BuildKit is still experimental, 
        
           		// so we don't print this warning, even if the daemon advertised that 
        
           		// it supports BuildKit. 
        
           		if dockerCli.ServerInfo().OSType != "windows" { 
        
           			_, _ = fmt.Fprintf(dockerCli.Err(), "%s\n\n", buildkitDisabledWarning) 
        
           		} 
        
           		return args, osargs, nil, nil 
        
           	} 
        
           	// check plugin is available if cmd forwarded 
        
           	plugin, perr := pluginmanager.GetPlugin(builderAlias, dockerCli, cmd.Root()) 
        
           	if perr == nil && plugin != nil { 
        
           		perr = plugin.Err 
        
           	} 
        
           	if perr != nil { 
        
           		// if builder is enforced with DOCKER_BUILDKIT=1, cmd must fail 
        
           		// if the plugin is missing or broken. 
        
           		if useBuilder { 
        
           			return args, osargs, nil, newBuilderError(buildxMissingError, perr) 
        
           		} 
        
           		// otherwise, display warning and continue 
        
           		_, _ = fmt.Fprintf(dockerCli.Err(), "%s\n\n", newBuilderError(buildxMissingWarning, perr)) 
        
           		return args, osargs, nil, nil 
        
           	} 
        
           	// If build subcommand is forwarded, user would expect "docker build" to 
        
           	// always create a local docker image (default context builder). This is 
        
           	// for better backward compatibility in case where a user could switch to 
        
           	// a docker container builder with "docker buildx --use foo" which does 
        
           	// not --load by default. Also makes sure that an arbitrary builder name 
        
           	// is not being set in the command line or in the environment before 
        
           	// setting the default context and keep "buildx install" behavior if being 
        
           	// set (builder alias). 
        
           	if forwarded && !useAlias && !hasBuilderName(args, os.Environ()) { 
        
           		envs = append([]string{"BUILDX_BUILDER=" + dockerCli.CurrentContext()}, envs...) 
        
           	} 
        
           	// overwrite the command path for this plugin using the alias name. 
        
           	cmd.Annotations[metadata.CommandAnnotationPluginCommandPath] = strings.Join(append([]string{cmd.CommandPath()}, fwcmdpath...), " ") 
        
           	return fwargs, fwosargs, envs, nil 
        
           }

thaJeztah · 2025-04-11T14:05:06Z

@crazy-max I pushed a temporary commit (to be squashed); to make it a hard failure; I think for this one we can ignore DOCKER_BUILDKIT=0 because it's new, and just requires buildx.

buildx missing;

docker bake
ERROR: bake requires the buildx component but it is missing or broken.
       Install the buildx component to use bake:
       https://docs.docker.com/go/buildx/

BuildKit disabled:

DOCKER_BUILDKIT=0 docker bake
ERROR: bake requires the buildx component but it is missing or broken.
       Install the buildx component to use bake:
       https://docs.docker.com/go/buildx/

Also added a check if buildx is installed to hide it from "docker --help", but maybe we shouldn't?

crazy-max · 2025-04-11T14:14:58Z

cmd/docker/docker.go

@@ -247,6 +247,13 @@ func setHelpFunc(dockerCli command.Cli, cmd *cobra.Command) {
 			}
 		}

+		// FIXME(thaJeztah): need a better way for this; hiding the command here, so that it's present" by default for generating docs etc.


Yes this looks good for now

Let me squash the commits; it's not "perfect", but we can tweak more

The [`docker buildx bake`][1] command has reached GA; this patch adds a top-level `docker bake` command as alias for `docker buildx bake` to improve discoverability and make it more convenient to use. With this patch: docker --help Usage: docker [OPTIONS] COMMAND A self-sufficient runtime for containers Common Commands: run Create and run a new container from an image exec Execute a command in a running container ps List containers build Build an image from a Dockerfile bake Build from a file pull Download an image from a registry push Upload an image to a registry images List images ... The command is hidden if buildx is not installed; docker --help Usage: docker [OPTIONS] COMMAND A self-sufficient runtime for containers Common Commands: run Create and run a new container from an image exec Execute a command in a running container ps List containers build Build an image from a Dockerfile pull Download an image from a registry push Upload an image to a registry images List images ... We can do some tweaking after this; currently it show an error in situations where buildx is missing. We don't account for "DOCKER_BUILDKIT=0", because this is a new feature that requires buildx, and cannot be "disabled"; buildx missing; docker bake ERROR: bake requires the buildx component but it is missing or broken. Install the buildx component to use bake: https://docs.docker.com/go/buildx/ BuildKit disabled: DOCKER_BUILDKIT=0 docker bake ERROR: bake requires the buildx component but it is missing or broken. Install the buildx component to use bake: https://docs.docker.com/go/buildx/ [1]: https://www.docker.com/blog/ga-launch-docker-bake/ Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

thaJeztah · 2025-04-11T14:30:06Z

cli/command/builder/cmd.go

+// This command is a placeholder / stub that is dynamically replaced by an
+// alias for "docker buildx bake" if BuildKit is enabled (and the buildx plugin
+// installed).
+func NewBakeStubCommand(dockerCLI command.Streams) *cobra.Command {


LOL; thanks @robmry !

Changed this NewBakeStubComment -> NewBakeStubCommand (I blame autocorrect 😂)

thaJeztah added impact/changelog kind/enhancement area/builder area/builder/buildkit area/ux labels Mar 21, 2025

thaJeztah force-pushed the docker_bake branch 2 times, most recently from 842d655 to 5c4d0bc Compare March 21, 2025 12:42

thaJeztah commented Mar 21, 2025

View reviewed changes

crazy-max reviewed Mar 24, 2025

View reviewed changes

thaJeztah marked this pull request as ready for review March 25, 2025 00:36

thaJeztah requested a review from a team as a code owner March 25, 2025 00:36

thaJeztah force-pushed the docker_bake branch from 5c4d0bc to 28c59ce Compare April 11, 2025 11:58

thaJeztah force-pushed the docker_bake branch from 4b8fdf4 to b64bf13 Compare April 11, 2025 13:38

crazy-max reviewed Apr 11, 2025

View reviewed changes

thaJeztah force-pushed the docker_bake branch 3 times, most recently from c494926 to ec664ee Compare April 11, 2025 14:24

thaJeztah force-pushed the docker_bake branch from ec664ee to adb0aba Compare April 11, 2025 14:28

thaJeztah commented Apr 11, 2025

View reviewed changes

vvoland added this to the 28.1.0 milestone Apr 11, 2025

robmry approved these changes Apr 11, 2025

View reviewed changes

thaJeztah requested a review from vvoland April 11, 2025 14:43

vvoland approved these changes Apr 11, 2025

View reviewed changes

vvoland merged commit c528504 into docker:master Apr 11, 2025
87 checks passed

thaJeztah deleted the docker_bake branch April 11, 2025 14:45

vvoland added kind/feature and removed kind/enhancement labels Apr 11, 2025

thaJeztah self-assigned this May 16, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

add top-level "docker bake" command as alias for "docker buildx bake" #5947

add top-level "docker bake" command as alias for "docker buildx bake" #5947

Uh oh!

thaJeztah commented Mar 21, 2025 •

edited by vvoland

Loading

Uh oh!

codecov-commenter commented Mar 21, 2025 •

edited

Loading

Uh oh!

thaJeztah Mar 21, 2025

Uh oh!

crazy-max Mar 24, 2025

Uh oh!

thaJeztah commented Apr 11, 2025

Uh oh!

thaJeztah commented Apr 11, 2025

Uh oh!

crazy-max commented Apr 11, 2025

Uh oh!

thaJeztah commented Apr 11, 2025

Uh oh!

thaJeztah commented Apr 11, 2025

Uh oh!

crazy-max Apr 11, 2025

Uh oh!

thaJeztah Apr 11, 2025

Uh oh!

thaJeztah Apr 11, 2025

Uh oh!

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

		// alias for "docker buildx bake" if BuildKit is enabled (and the buildx plugin
		// installed).

add top-level "docker bake" command as alias for "docker buildx bake" #5947

add top-level "docker bake" command as alias for "docker buildx bake" #5947

Uh oh!

Conversation

thaJeztah commented Mar 21, 2025 • edited by vvoland Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov-commenter commented Mar 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

thaJeztah Mar 21, 2025

Choose a reason for hiding this comment

Uh oh!

crazy-max Mar 24, 2025

Choose a reason for hiding this comment

Uh oh!

thaJeztah commented Apr 11, 2025

Uh oh!

thaJeztah commented Apr 11, 2025

Uh oh!

crazy-max commented Apr 11, 2025

Uh oh!

thaJeztah commented Apr 11, 2025

Uh oh!

thaJeztah commented Apr 11, 2025

Uh oh!

crazy-max Apr 11, 2025

Choose a reason for hiding this comment

Uh oh!

thaJeztah Apr 11, 2025

Choose a reason for hiding this comment

Uh oh!

thaJeztah Apr 11, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

thaJeztah commented Mar 21, 2025 •

edited by vvoland

Loading

codecov-commenter commented Mar 21, 2025 •

edited

Loading