2019-03-24 12:30:29 +08:00
package commands
import (
2021-12-19 14:08:43 +08:00
"bytes"
2019-03-24 12:30:29 +08:00
"context"
2022-02-11 15:15:47 +08:00
"encoding/base64"
2022-05-24 19:00:55 +08:00
"encoding/csv"
2021-06-30 13:41:21 +08:00
"encoding/json"
2021-08-20 22:09:56 +08:00
"fmt"
2021-12-19 14:08:43 +08:00
"io"
2019-03-24 12:30:29 +08:00
"os"
2019-10-21 14:02:37 +08:00
"path/filepath"
2022-08-29 13:14:14 +08:00
"runtime"
2022-05-24 19:00:55 +08:00
"strconv"
2019-03-24 12:30:29 +08:00
"strings"
2022-05-24 19:00:55 +08:00
"sync"
2019-03-24 12:30:29 +08:00
2022-05-24 19:00:55 +08:00
"github.com/containerd/console"
2019-04-25 10:29:56 +08:00
"github.com/docker/buildx/build"
2022-12-06 02:57:35 +08:00
"github.com/docker/buildx/builder"
2022-08-29 13:14:14 +08:00
controllerapi "github.com/docker/buildx/commands/controller/pb"
2022-05-24 19:00:55 +08:00
"github.com/docker/buildx/monitor"
2022-12-07 18:44:33 +08:00
"github.com/docker/buildx/store"
"github.com/docker/buildx/store/storeutil"
2021-04-09 14:20:26 +08:00
"github.com/docker/buildx/util/buildflags"
2021-10-30 12:15:04 +08:00
"github.com/docker/buildx/util/confutil"
2022-11-28 22:47:40 +08:00
"github.com/docker/buildx/util/dockerutil"
2022-08-29 13:14:14 +08:00
"github.com/docker/buildx/util/ioset"
2019-04-25 10:29:56 +08:00
"github.com/docker/buildx/util/platformutil"
"github.com/docker/buildx/util/progress"
2021-07-03 12:39:57 +08:00
"github.com/docker/buildx/util/tracing"
2021-11-22 17:51:54 +08:00
"github.com/docker/cli-docs-tool/annotation"
2019-03-24 12:30:29 +08:00
"github.com/docker/cli/cli"
"github.com/docker/cli/cli/command"
2022-07-06 16:47:29 +08:00
"github.com/docker/cli/cli/config"
2021-10-26 18:53:35 +08:00
dockeropts "github.com/docker/cli/opts"
2021-12-16 13:02:31 +08:00
"github.com/docker/distribution/reference"
2021-06-30 13:41:21 +08:00
"github.com/docker/docker/pkg/ioutils"
2021-10-15 22:03:44 +08:00
"github.com/docker/go-units"
2019-04-17 14:15:58 +08:00
"github.com/moby/buildkit/client"
2019-03-24 12:30:29 +08:00
"github.com/moby/buildkit/session/auth/authprovider"
2021-12-19 14:08:43 +08:00
"github.com/moby/buildkit/solver/errdefs"
2019-03-24 12:30:29 +08:00
"github.com/moby/buildkit/util/appcontext"
2022-01-05 14:34:30 +08:00
"github.com/moby/buildkit/util/grpcerrors"
2021-12-19 14:08:43 +08:00
"github.com/morikuni/aec"
2019-04-17 01:55:13 +08:00
"github.com/pkg/errors"
2021-10-27 03:36:37 +08:00
"github.com/sirupsen/logrus"
2019-03-24 12:30:29 +08:00
"github.com/spf13/cobra"
2019-04-05 15:04:19 +08:00
"github.com/spf13/pflag"
2022-01-05 14:34:30 +08:00
"google.golang.org/grpc/codes"
2019-03-24 12:30:29 +08:00
)
2021-06-30 13:41:21 +08:00
const defaultTargetName = "default"
2019-03-24 12:30:29 +08:00
type buildOptions struct {
2021-06-30 13:41:21 +08:00
progress string
2022-08-29 13:14:14 +08:00
invoke string
serverConfig string
root string
detach bool
controllerapi . BuildOptions
2019-04-05 15:04:19 +08:00
}
2022-08-29 13:14:14 +08:00
func runBuild ( dockerCli command . Cli , in buildOptions ) error {
2019-03-24 12:30:29 +08:00
ctx := appcontext . Context ( )
2021-07-03 12:39:57 +08:00
ctx , end , err := tracing . TraceCurrentCommand ( ctx , "build" )
if err != nil {
return err
}
defer func ( ) {
end ( err )
} ( )
2022-08-29 13:14:14 +08:00
_ , err = runBuildWithContext ( ctx , dockerCli , in . BuildOptions , os . Stdin , in . progress , nil )
return err
}
2019-10-17 06:10:17 +08:00
2022-08-29 13:14:14 +08:00
func runBuildWithContext ( ctx context . Context , dockerCli command . Cli , in controllerapi . BuildOptions , inStream io . Reader , progressMode string , statusChan chan * client . SolveStatus ) ( res * build . ResultContext , err error ) {
if in . Opts . NoCache && len ( in . NoCacheFilter ) > 0 {
return nil , errors . Errorf ( "--no-cache and --no-cache-filter cannot currently be used together" )
2022-01-21 01:50:33 +08:00
}
2022-08-29 13:14:14 +08:00
if in . Quiet && progressMode != progress . PrinterModeAuto && progressMode != progress . PrinterModeQuiet {
return nil , errors . Errorf ( "progress=%s and quiet cannot be used together" , progressMode )
} else if in . Quiet {
progressMode = "quiet"
2021-08-19 11:05:15 +08:00
}
2022-08-29 13:14:14 +08:00
contexts , err := parseContextNames ( in . Contexts )
2021-12-16 13:02:31 +08:00
if err != nil {
2022-08-29 13:14:14 +08:00
return nil , err
2021-12-16 13:02:31 +08:00
}
2022-08-29 13:14:14 +08:00
printFunc , err := parsePrintFunc ( in . PrintFunc )
2022-08-05 15:25:39 +08:00
if err != nil {
2022-08-29 13:14:14 +08:00
return nil , err
2022-08-05 15:25:39 +08:00
}
2019-03-24 12:30:29 +08:00
opts := build . Options {
Inputs : build . Inputs {
2022-08-29 13:14:14 +08:00
ContextPath : in . ContextPath ,
DockerfilePath : in . DockerfileName ,
InStream : inStream ,
2021-12-16 13:02:31 +08:00
NamedContexts : contexts ,
2019-03-24 12:30:29 +08:00
} ,
2022-08-29 13:14:14 +08:00
BuildArgs : listToMap ( in . BuildArgs , true ) ,
ExtraHosts : in . ExtraHosts ,
ImageIDFile : in . ImageIDFile ,
Labels : listToMap ( in . Labels , false ) ,
NetworkMode : in . NetworkMode ,
NoCache : in . Opts . NoCache ,
NoCacheFilter : in . NoCacheFilter ,
Pull : in . Opts . Pull ,
ShmSize : dockeropts . MemBytes ( in . ShmSize ) ,
Tags : in . Tags ,
Target : in . Target ,
Ulimits : controllerUlimitOpt2DockerUlimit ( in . Ulimits ) ,
2022-08-05 15:25:39 +08:00
PrintFunc : printFunc ,
2019-03-24 12:30:29 +08:00
}
2022-08-29 13:14:14 +08:00
platforms , err := platformutil . Parse ( in . Platforms )
2019-03-24 12:30:29 +08:00
if err != nil {
2022-08-29 13:14:14 +08:00
return nil , err
2019-03-24 12:30:29 +08:00
}
opts . Platforms = platforms
2022-07-06 16:47:29 +08:00
dockerConfig := config . LoadDefaultConfigFile ( os . Stderr )
opts . Session = append ( opts . Session , authprovider . NewDockerAuthProvider ( dockerConfig ) )
2019-03-24 12:30:29 +08:00
2022-08-29 13:14:14 +08:00
secrets , err := buildflags . ParseSecretSpecs ( in . Secrets )
2019-03-24 12:30:29 +08:00
if err != nil {
2022-08-29 13:14:14 +08:00
return nil , err
2019-03-24 12:30:29 +08:00
}
opts . Session = append ( opts . Session , secrets )
2022-08-29 13:14:14 +08:00
sshSpecs := in . SSH
if len ( sshSpecs ) == 0 && buildflags . IsGitSSH ( in . ContextPath ) {
2021-04-02 02:08:56 +08:00
sshSpecs = [ ] string { "default" }
}
2021-04-09 14:20:26 +08:00
ssh , err := buildflags . ParseSSHSpecs ( sshSpecs )
2019-03-24 12:30:29 +08:00
if err != nil {
2022-08-29 13:14:14 +08:00
return nil , err
2019-03-24 12:30:29 +08:00
}
opts . Session = append ( opts . Session , ssh )
2022-08-29 13:14:14 +08:00
outputs , err := buildflags . ParseOutputs ( in . Outputs )
2019-03-24 12:30:29 +08:00
if err != nil {
2022-08-29 13:14:14 +08:00
return nil , err
2019-03-24 12:30:29 +08:00
}
2022-08-29 13:14:14 +08:00
if in . Opts . ExportPush {
if in . Opts . ExportLoad {
return nil , errors . Errorf ( "push and load may not be set together at the moment" )
2019-04-17 14:15:58 +08:00
}
if len ( outputs ) == 0 {
outputs = [ ] client . ExportEntry { {
Type : "image" ,
Attrs : map [ string ] string {
"push" : "true" ,
} ,
} }
} else {
switch outputs [ 0 ] . Type {
case "image" :
outputs [ 0 ] . Attrs [ "push" ] = "true"
default :
2022-08-29 13:14:14 +08:00
return nil , errors . Errorf ( "push and %q output can't be used together" , outputs [ 0 ] . Type )
2019-04-17 14:15:58 +08:00
}
}
}
2022-08-29 13:14:14 +08:00
if in . Opts . ExportLoad {
2019-04-17 14:15:58 +08:00
if len ( outputs ) == 0 {
outputs = [ ] client . ExportEntry { {
Type : "docker" ,
Attrs : map [ string ] string { } ,
} }
} else {
switch outputs [ 0 ] . Type {
case "docker" :
default :
2022-08-29 13:14:14 +08:00
return nil , errors . Errorf ( "load and %q output can't be used together" , outputs [ 0 ] . Type )
2019-04-17 14:15:58 +08:00
}
}
}
2019-03-24 12:30:29 +08:00
opts . Exports = outputs
2022-08-29 13:14:14 +08:00
inAttests := append ( [ ] string { } , in . Attests ... )
if in . Opts . Provenance != "" {
inAttests = append ( inAttests , buildflags . CanonicalizeAttest ( "provenance" , in . Opts . Provenance ) )
2022-12-08 02:44:11 +08:00
}
2022-08-29 13:14:14 +08:00
if in . Opts . SBOM != "" {
inAttests = append ( inAttests , buildflags . CanonicalizeAttest ( "sbom" , in . Opts . SBOM ) )
2022-12-08 02:44:11 +08:00
}
opts . Attests , err = buildflags . ParseAttests ( inAttests )
if err != nil {
2022-08-29 13:14:14 +08:00
return nil , err
2022-12-08 02:44:11 +08:00
}
2022-08-29 13:14:14 +08:00
cacheImports , err := buildflags . ParseCacheEntry ( in . CacheFrom )
2019-04-18 14:07:01 +08:00
if err != nil {
2022-08-29 13:14:14 +08:00
return nil , err
2019-04-18 14:07:01 +08:00
}
opts . CacheFrom = cacheImports
2022-08-29 13:14:14 +08:00
cacheExports , err := buildflags . ParseCacheEntry ( in . CacheTo )
2019-04-18 14:07:01 +08:00
if err != nil {
2022-08-29 13:14:14 +08:00
return nil , err
2019-04-18 14:07:01 +08:00
}
opts . CacheTo = cacheExports
2022-08-29 13:14:14 +08:00
allow , err := buildflags . ParseEntitlements ( in . Allow )
2019-07-09 06:58:38 +08:00
if err != nil {
2022-08-29 13:14:14 +08:00
return nil , err
2019-07-09 06:58:38 +08:00
}
opts . Allow = allow
2019-10-21 14:02:37 +08:00
// key string used for kubernetes "sticky" mode
2022-08-29 13:14:14 +08:00
contextPathHash , err := filepath . Abs ( in . ContextPath )
2019-10-21 14:02:37 +08:00
if err != nil {
2022-08-29 13:14:14 +08:00
contextPathHash = in . ContextPath
2019-10-21 14:02:37 +08:00
}
2022-12-06 02:57:35 +08:00
b , err := builder . New ( dockerCli ,
2022-08-29 13:14:14 +08:00
builder . WithName ( in . Opts . Builder ) ,
2022-12-06 02:57:35 +08:00
builder . WithContextPathHash ( contextPathHash ) ,
)
if err != nil {
2022-08-29 13:14:14 +08:00
return nil , err
2022-12-06 02:57:35 +08:00
}
2022-12-07 18:44:33 +08:00
if err = updateLastActivity ( dockerCli , b . NodeGroup ) ; err != nil {
2022-08-29 13:14:14 +08:00
return nil , errors . Wrapf ( err , "failed to update builder last activity time" )
2022-12-07 18:44:33 +08:00
}
2022-12-06 02:57:35 +08:00
nodes , err := b . LoadNodes ( ctx , false )
if err != nil {
2022-08-29 13:14:14 +08:00
return nil , err
2022-12-06 02:57:35 +08:00
}
2022-08-29 13:14:14 +08:00
imageID , res , err := buildTargets ( ctx , dockerCli , nodes , map [ string ] build . Options { defaultTargetName : opts } , progressMode , in . Opts . MetadataFile , statusChan )
2022-02-23 13:55:44 +08:00
err = wrapBuildError ( err , false )
2021-08-20 22:09:56 +08:00
if err != nil {
2022-08-29 13:14:14 +08:00
return nil , err
2022-05-24 19:00:55 +08:00
}
2022-08-29 13:14:14 +08:00
if in . Quiet {
2021-08-20 22:09:56 +08:00
fmt . Println ( imageID )
}
2022-08-29 13:14:14 +08:00
return res , nil
2019-04-05 15:04:19 +08:00
}
2022-08-29 13:14:14 +08:00
func buildTargets ( ctx context . Context , dockerCli command . Cli , nodes [ ] builder . Node , opts map [ string ] build . Options , progressMode string , metadataFile string , statusChan chan * client . SolveStatus ) ( imageID string , res * build . ResultContext , err error ) {
2019-03-24 12:30:29 +08:00
ctx2 , cancel := context . WithCancel ( context . TODO ( ) )
defer cancel ( )
2021-08-19 11:05:15 +08:00
2022-10-25 17:55:36 +08:00
printer , err := progress . NewPrinter ( ctx2 , os . Stderr , os . Stderr , progressMode )
if err != nil {
return "" , nil , err
}
2020-09-21 10:46:39 +08:00
2022-05-24 19:00:55 +08:00
var mu sync . Mutex
var idx int
2022-08-29 13:14:14 +08:00
resp , err := build . BuildWithResultHandler ( ctx , nodes , opts , dockerutil . NewClient ( dockerCli ) , confutil . ConfigDir ( dockerCli ) , progress . Tee ( printer , statusChan ) , func ( driverIndex int , gotRes * build . ResultContext ) {
2022-05-24 19:00:55 +08:00
mu . Lock ( )
defer mu . Unlock ( )
if res == nil || driverIndex < idx {
idx , res = driverIndex , gotRes
}
2022-08-29 13:14:14 +08:00
} )
2020-09-21 10:46:39 +08:00
err1 := printer . Wait ( )
if err == nil {
err = err1
}
2021-06-30 13:41:21 +08:00
if err != nil {
2022-05-24 19:00:55 +08:00
return "" , nil , err
2021-06-30 13:41:21 +08:00
}
if len ( metadataFile ) > 0 && resp != nil {
2022-02-11 15:15:47 +08:00
if err := writeMetadataFile ( metadataFile , decodeExporterResponse ( resp [ defaultTargetName ] . ExporterResponse ) ) ; err != nil {
2022-05-24 19:00:55 +08:00
return "" , nil , err
2021-06-30 13:41:21 +08:00
}
}
2019-03-24 12:30:29 +08:00
2021-12-19 14:08:43 +08:00
printWarnings ( os . Stderr , printer . Warnings ( ) , progressMode )
2022-05-05 09:48:50 +08:00
for k := range resp {
2022-08-05 15:25:39 +08:00
if opts [ k ] . PrintFunc != nil {
2022-05-05 09:48:50 +08:00
if err := printResult ( opts [ k ] . PrintFunc , resp [ k ] . ExporterResponse ) ; err != nil {
return "" , nil , err
}
}
}
2022-05-24 19:00:55 +08:00
return resp [ defaultTargetName ] . ExporterResponse [ "containerimage.digest" ] , res , err
}
2021-12-19 14:08:43 +08:00
func printWarnings ( w io . Writer , warnings [ ] client . VertexWarning , mode string ) {
if len ( warnings ) == 0 || mode == progress . PrinterModeQuiet {
return
}
fmt . Fprintf ( w , "\n " )
sb := & bytes . Buffer { }
if len ( warnings ) == 1 {
fmt . Fprintf ( sb , "1 warning found" )
} else {
fmt . Fprintf ( sb , "%d warnings found" , len ( warnings ) )
}
if logrus . GetLevel ( ) < logrus . DebugLevel {
fmt . Fprintf ( sb , " (use --debug to expand)" )
}
fmt . Fprintf ( sb , ":\n" )
fmt . Fprint ( w , aec . Apply ( sb . String ( ) , aec . YellowF ) )
for _ , warn := range warnings {
fmt . Fprintf ( w , " - %s\n" , warn . Short )
if logrus . GetLevel ( ) < logrus . DebugLevel {
continue
}
for _ , d := range warn . Detail {
fmt . Fprintf ( w , "%s\n" , d )
}
if warn . URL != "" {
fmt . Fprintf ( w , "More info: %s\n" , warn . URL )
}
if warn . SourceInfo != nil && warn . Range != nil {
src := errdefs . Source {
Info : warn . SourceInfo ,
Ranges : warn . Range ,
}
src . Print ( w )
}
fmt . Fprintf ( w , "\n" )
}
}
2020-04-28 05:37:17 +08:00
func buildCmd ( dockerCli command . Cli , rootOpts * rootOptions ) * cobra . Command {
2021-10-15 22:03:44 +08:00
options := newBuildOptions ( )
2022-08-29 13:14:14 +08:00
cFlags := & commonFlags { }
2019-03-24 12:30:29 +08:00
cmd := & cobra . Command {
Use : "build [OPTIONS] PATH | URL | -" ,
Aliases : [ ] string { "b" } ,
Short : "Start a build" ,
Args : cli . ExactArgs ( 1 ) ,
2020-05-01 04:01:45 +08:00
RunE : func ( cmd * cobra . Command , args [ ] string ) error {
2022-08-29 13:14:14 +08:00
options . ContextPath = args [ 0 ]
options . Opts . Builder = rootOpts . builder
options . Opts . MetadataFile = cFlags . metadataFile
options . Opts . NoCache = false
if cFlags . noCache != nil {
options . Opts . NoCache = * cFlags . noCache
}
options . Opts . Pull = false
if cFlags . pull != nil {
options . Opts . Pull = * cFlags . pull
}
options . progress = cFlags . progress
2021-10-27 03:36:37 +08:00
cmd . Flags ( ) . VisitAll ( checkWarnedFlags )
2022-08-29 13:14:14 +08:00
if isExperimental ( ) {
return launchControllerAndRunBuild ( dockerCli , options )
}
2020-05-01 04:01:45 +08:00
return runBuild ( dockerCli , options )
} ,
2019-03-24 12:30:29 +08:00
}
2021-10-26 18:53:35 +08:00
var platformsDefault [ ] string
if v := os . Getenv ( "DOCKER_DEFAULT_PLATFORM" ) ; v != "" {
platformsDefault = [ ] string { v }
}
2019-03-24 12:30:29 +08:00
flags := cmd . Flags ( )
2022-08-29 13:14:14 +08:00
flags . StringSliceVar ( & options . ExtraHosts , "add-host" , [ ] string { } , ` Add a custom host-to-IP mapping (format: "host:ip") ` )
2023-01-07 22:11:30 +08:00
flags . SetAnnotation ( "add-host" , annotation . ExternalURL , [ ] string { "https://docs.docker.com/engine/reference/commandline/build/#add-host" } )
2021-10-26 18:53:35 +08:00
2022-08-29 13:14:14 +08:00
flags . StringSliceVar ( & options . Allow , "allow" , [ ] string { } , ` Allow extra privileged entitlement (e.g., "network.host", "security.insecure") ` )
2019-04-17 14:15:58 +08:00
2022-08-29 13:14:14 +08:00
flags . StringArrayVar ( & options . BuildArgs , "build-arg" , [ ] string { } , "Set build-time variables" )
2021-03-24 02:07:57 +08:00
2022-08-29 13:14:14 +08:00
flags . StringArrayVar ( & options . CacheFrom , "cache-from" , [ ] string { } , ` External cache sources (e.g., "user/app:cache", "type=local,src=path/to/dir") ` )
2021-10-26 18:53:35 +08:00
2022-08-29 13:14:14 +08:00
flags . StringArrayVar ( & options . CacheTo , "cache-to" , [ ] string { } , ` Cache export destinations (e.g., "user/app:cache", "type=local,dest=path/to/dir") ` )
2021-10-26 18:53:35 +08:00
2022-08-29 13:14:14 +08:00
flags . StringVar ( & options . CgroupParent , "cgroup-parent" , "" , "Optional parent cgroup for the container" )
2023-01-07 22:11:30 +08:00
flags . SetAnnotation ( "cgroup-parent" , annotation . ExternalURL , [ ] string { "https://docs.docker.com/engine/reference/commandline/build/#cgroup-parent" } )
2021-10-29 01:34:33 +08:00
2022-08-29 13:14:14 +08:00
flags . StringArrayVar ( & options . Contexts , "build-context" , [ ] string { } , "Additional build contexts (e.g., name=path)" )
2021-12-16 13:02:31 +08:00
2022-08-29 13:14:14 +08:00
flags . StringVarP ( & options . DockerfileName , "file" , "f" , "" , ` Name of the Dockerfile (default: "PATH/Dockerfile") ` )
2023-01-07 22:11:30 +08:00
flags . SetAnnotation ( "file" , annotation . ExternalURL , [ ] string { "https://docs.docker.com/engine/reference/commandline/build/#file" } )
2019-04-17 01:55:13 +08:00
2022-08-29 13:14:14 +08:00
flags . StringVar ( & options . ImageIDFile , "iidfile" , "" , "Write the image ID to the file" )
2021-10-26 18:53:35 +08:00
2022-08-29 13:14:14 +08:00
flags . StringArrayVar ( & options . Labels , "label" , [ ] string { } , "Set metadata for an image" )
2019-04-17 01:55:13 +08:00
2022-08-29 13:14:14 +08:00
flags . BoolVar ( & options . Opts . ExportLoad , "load" , false , ` Shorthand for "--output=type=docker" ` )
2019-03-24 12:30:29 +08:00
2022-08-29 13:14:14 +08:00
flags . StringVar ( & options . NetworkMode , "network" , "default" , ` Set the networking mode for the "RUN" instructions during build ` )
2019-04-17 01:55:13 +08:00
2022-08-29 13:14:14 +08:00
flags . StringArrayVar ( & options . NoCacheFilter , "no-cache-filter" , [ ] string { } , "Do not cache specified stages" )
2021-11-23 12:21:35 +08:00
2022-08-29 13:14:14 +08:00
flags . StringArrayVarP ( & options . Outputs , "output" , "o" , [ ] string { } , ` Output destination (format: "type=local,dest=path") ` )
2021-10-26 18:53:35 +08:00
2022-08-29 13:14:14 +08:00
flags . StringArrayVar ( & options . Platforms , "platform" , platformsDefault , "Set target platform for build" )
2021-10-26 18:53:35 +08:00
2022-05-05 09:48:50 +08:00
if isExperimental ( ) {
2022-08-29 13:14:14 +08:00
flags . StringVar ( & options . PrintFunc , "print" , "" , "Print result of information request (e.g., outline, targets) [experimental]" )
2022-05-05 09:48:50 +08:00
}
2022-08-29 13:14:14 +08:00
flags . BoolVar ( & options . Opts . ExportPush , "push" , false , ` Shorthand for "--output=type=registry" ` )
2019-07-09 06:58:38 +08:00
2022-08-29 13:14:14 +08:00
flags . BoolVarP ( & options . Quiet , "quiet" , "q" , false , "Suppress the build output and print image ID on success" )
2021-10-26 18:53:35 +08:00
2022-08-29 13:14:14 +08:00
flags . StringArrayVar ( & options . Secrets , "secret" , [ ] string { } , ` Secret to expose to the build (format: "id=mysecret[,src=/local/secret]") ` )
2021-10-26 18:53:35 +08:00
2022-08-29 13:14:14 +08:00
flags . Var ( newShmSize ( & options ) , "shm-size" , ` Size of "/dev/shm" ` )
2021-10-26 18:53:35 +08:00
2022-08-29 13:14:14 +08:00
flags . StringArrayVar ( & options . SSH , "ssh" , [ ] string { } , ` SSH agent socket or keys to expose to the build (format: "default|<id>[=<socket>|<key>[,<key>]]") ` )
2021-10-26 18:53:35 +08:00
2022-08-29 13:14:14 +08:00
flags . StringArrayVarP ( & options . Tags , "tag" , "t" , [ ] string { } , ` Name and optionally a tag (format: "name:tag") ` )
2023-01-07 22:11:30 +08:00
flags . SetAnnotation ( "tag" , annotation . ExternalURL , [ ] string { "https://docs.docker.com/engine/reference/commandline/build/#tag" } )
2021-10-26 18:53:35 +08:00
2022-08-29 13:14:14 +08:00
flags . StringVar ( & options . Target , "target" , "" , "Set the target build stage to build" )
2023-01-07 22:11:30 +08:00
flags . SetAnnotation ( "target" , annotation . ExternalURL , [ ] string { "https://docs.docker.com/engine/reference/commandline/build/#target" } )
2021-10-26 18:53:35 +08:00
2022-08-29 13:14:14 +08:00
flags . Var ( newUlimits ( & options ) , "ulimit" , "Ulimit options" )
2021-08-19 11:05:15 +08:00
2022-08-29 13:14:14 +08:00
flags . StringArrayVar ( & options . Attests , "attest" , [ ] string { } , ` Attestation parameters (format: "type=sbom,generator=image") ` )
flags . StringVar ( & options . Opts . SBOM , "sbom" , "" , ` Shorthand for "--attest=type=sbom" ` )
flags . StringVar ( & options . Opts . Provenance , "provenance" , "" , ` Shortand for "--attest=type=provenance" ` )
2022-12-08 02:44:11 +08:00
2022-05-05 09:48:50 +08:00
if isExperimental ( ) {
2022-08-16 18:07:36 +08:00
flags . StringVar ( & options . invoke , "invoke" , "" , "Invoke a command after the build [experimental]" )
2022-08-29 13:14:14 +08:00
flags . StringVar ( & options . root , "root" , "" , "Specify root directory of server to connect [experimental]" )
flags . BoolVar ( & options . detach , "detach" , runtime . GOOS == "linux" , "Detach buildx server (supported only on linux) [experimental]" )
flags . StringVar ( & options . serverConfig , "server-config" , "" , "Specify buildx server config file (used only when launching new server) [experimental]" )
2022-05-24 19:00:55 +08:00
}
2019-04-17 01:55:13 +08:00
// hidden flags
var ignore string
var ignoreSlice [ ] string
var ignoreBool bool
var ignoreInt int64
2021-10-26 18:53:35 +08:00
2019-04-17 01:55:13 +08:00
flags . BoolVar ( & ignoreBool , "compress" , false , "Compress the build context using gzip" )
flags . MarkHidden ( "compress" )
2021-10-26 18:53:35 +08:00
flags . StringVar ( & ignore , "isolation" , "" , "Container isolation technology" )
flags . MarkHidden ( "isolation" )
2021-10-27 03:36:37 +08:00
flags . SetAnnotation ( "isolation" , "flag-warn" , [ ] string { "isolation flag is deprecated with BuildKit." } )
2021-10-26 18:53:35 +08:00
flags . StringSliceVar ( & ignoreSlice , "security-opt" , [ ] string { } , "Security options" )
flags . MarkHidden ( "security-opt" )
2021-10-27 03:36:37 +08:00
flags . SetAnnotation ( "security-opt" , "flag-warn" , [ ] string { ` security-opt flag is deprecated. "RUN --security=insecure" should be used with BuildKit. ` } )
flags . BoolVar ( & ignoreBool , "squash" , false , "Squash newly built layers into a single new layer" )
flags . MarkHidden ( "squash" )
flags . SetAnnotation ( "squash" , "flag-warn" , [ ] string { "experimental flag squash is removed with BuildKit. You should squash inside build using a multi-stage Dockerfile for efficiency." } )
2021-10-26 18:53:35 +08:00
2019-04-17 01:55:13 +08:00
flags . StringVarP ( & ignore , "memory" , "m" , "" , "Memory limit" )
flags . MarkHidden ( "memory" )
2021-10-26 18:53:35 +08:00
2021-11-22 17:51:54 +08:00
flags . StringVar ( & ignore , "memory-swap" , "" , ` Swap limit equal to memory plus swap: "-1" to enable unlimited swap ` )
2019-04-17 01:55:13 +08:00
flags . MarkHidden ( "memory-swap" )
2021-10-26 18:53:35 +08:00
2019-04-17 01:55:13 +08:00
flags . Int64VarP ( & ignoreInt , "cpu-shares" , "c" , 0 , "CPU shares (relative weight)" )
flags . MarkHidden ( "cpu-shares" )
2021-10-26 18:53:35 +08:00
2019-04-17 01:55:13 +08:00
flags . Int64Var ( & ignoreInt , "cpu-period" , 0 , "Limit the CPU CFS (Completely Fair Scheduler) period" )
flags . MarkHidden ( "cpu-period" )
2021-10-26 18:53:35 +08:00
2019-04-17 01:55:13 +08:00
flags . Int64Var ( & ignoreInt , "cpu-quota" , 0 , "Limit the CPU CFS (Completely Fair Scheduler) quota" )
flags . MarkHidden ( "cpu-quota" )
2021-10-26 18:53:35 +08:00
2021-11-22 17:51:54 +08:00
flags . StringVar ( & ignore , "cpuset-cpus" , "" , ` CPUs in which to allow execution ("0-3", "0,1") ` )
2019-04-17 01:55:13 +08:00
flags . MarkHidden ( "cpuset-cpus" )
2021-10-26 18:53:35 +08:00
2021-11-22 17:51:54 +08:00
flags . StringVar ( & ignore , "cpuset-mems" , "" , ` MEMs in which to allow execution ("0-3", "0,1") ` )
2019-04-17 01:55:13 +08:00
flags . MarkHidden ( "cpuset-mems" )
2021-10-26 18:53:35 +08:00
2019-05-15 09:06:23 +08:00
flags . BoolVar ( & ignoreBool , "rm" , true , "Remove intermediate containers after a successful build" )
flags . MarkHidden ( "rm" )
2021-10-26 18:53:35 +08:00
2019-05-15 09:06:23 +08:00
flags . BoolVar ( & ignoreBool , "force-rm" , false , "Always remove intermediate containers" )
flags . MarkHidden ( "force-rm" )
2019-03-24 12:30:29 +08:00
2022-08-29 13:14:14 +08:00
commonBuildFlags ( cFlags , flags )
2019-03-24 12:30:29 +08:00
return cmd
}
2022-08-29 13:14:14 +08:00
// comomnFlags is a set of flags commonly shared among subcommands.
type commonFlags struct {
metadataFile string
progress string
noCache * bool
pull * bool
}
func commonBuildFlags ( options * commonFlags , flags * pflag . FlagSet ) {
2020-05-01 03:25:30 +08:00
options . noCache = flags . Bool ( "no-cache" , false , "Do not use cache when building the image" )
2021-11-22 17:51:54 +08:00
flags . StringVar ( & options . progress , "progress" , "auto" , ` Set type of progress output ("auto", "plain", "tty"). Use plain to show container output ` )
2022-02-26 12:39:42 +08:00
options . pull = flags . Bool ( "pull" , false , "Always attempt to pull all referenced images" )
2021-06-30 13:41:21 +08:00
flags . StringVar ( & options . metadataFile , "metadata-file" , "" , "Write build result metadata to the file" )
2019-04-05 15:04:19 +08:00
}
2021-10-27 03:36:37 +08:00
func checkWarnedFlags ( f * pflag . Flag ) {
if ! f . Changed {
return
}
for t , m := range f . Annotations {
switch t {
case "flag-warn" :
logrus . Warn ( m [ 0 ] )
}
}
}
2019-07-31 07:32:36 +08:00
func listToMap ( values [ ] string , defaultEnv bool ) map [ string ] string {
2019-03-24 12:30:29 +08:00
result := make ( map [ string ] string , len ( values ) )
for _ , value := range values {
kv := strings . SplitN ( value , "=" , 2 )
if len ( kv ) == 1 {
2019-07-31 07:32:36 +08:00
if defaultEnv {
2020-01-07 04:02:06 +08:00
v , ok := os . LookupEnv ( kv [ 0 ] )
if ok {
result [ kv [ 0 ] ] = v
}
2019-07-31 07:32:36 +08:00
} else {
result [ kv [ 0 ] ] = ""
}
2019-03-24 12:30:29 +08:00
} else {
result [ kv [ 0 ] ] = kv [ 1 ]
}
}
return result
}
2021-12-16 13:02:31 +08:00
2022-02-24 15:09:46 +08:00
func parseContextNames ( values [ ] string ) ( map [ string ] build . NamedContext , error ) {
2021-12-16 13:02:31 +08:00
if len ( values ) == 0 {
return nil , nil
}
2022-02-24 15:09:46 +08:00
result := make ( map [ string ] build . NamedContext , len ( values ) )
2021-12-16 13:02:31 +08:00
for _ , value := range values {
kv := strings . SplitN ( value , "=" , 2 )
if len ( kv ) != 2 {
return nil , errors . Errorf ( "invalid context value: %s, expected key=value" , value )
}
named , err := reference . ParseNormalizedNamed ( kv [ 0 ] )
if err != nil {
return nil , errors . Wrapf ( err , "invalid context name %s" , kv [ 0 ] )
}
name := strings . TrimSuffix ( reference . FamiliarString ( named ) , ":latest" )
2022-02-24 15:09:46 +08:00
result [ name ] = build . NamedContext { Path : kv [ 1 ] }
2021-12-16 13:02:31 +08:00
}
return result , nil
}
2022-01-05 14:34:30 +08:00
2022-08-05 15:25:39 +08:00
func parsePrintFunc ( str string ) ( * build . PrintFunc , error ) {
if str == "" {
return nil , nil
}
csvReader := csv . NewReader ( strings . NewReader ( str ) )
fields , err := csvReader . Read ( )
if err != nil {
return nil , err
}
f := & build . PrintFunc { }
for _ , field := range fields {
parts := strings . SplitN ( field , "=" , 2 )
if len ( parts ) == 2 {
if parts [ 0 ] == "format" {
f . Format = parts [ 1 ]
} else {
return nil , errors . Errorf ( "invalid print field: %s" , field )
}
} else {
if f . Name != "" {
return nil , errors . Errorf ( "invalid print value: %s" , str )
}
f . Name = field
}
}
return f , nil
}
2022-02-11 15:15:47 +08:00
func writeMetadataFile ( filename string , dt interface { } ) error {
b , err := json . MarshalIndent ( dt , "" , " " )
if err != nil {
return err
}
return ioutils . AtomicWriteFile ( filename , b , 0644 )
}
func decodeExporterResponse ( exporterResponse map [ string ] string ) map [ string ] interface { } {
out := make ( map [ string ] interface { } )
for k , v := range exporterResponse {
dt , err := base64 . StdEncoding . DecodeString ( v )
if err != nil {
out [ k ] = v
continue
}
var raw map [ string ] interface { }
if err = json . Unmarshal ( dt , & raw ) ; err != nil || len ( raw ) == 0 {
out [ k ] = v
continue
}
out [ k ] = json . RawMessage ( dt )
}
return out
}
2022-02-23 13:55:44 +08:00
func wrapBuildError ( err error , bake bool ) error {
2022-01-05 14:34:30 +08:00
if err == nil {
return nil
}
st , ok := grpcerrors . AsGRPCStatus ( err )
if ok {
if st . Code ( ) == codes . Unimplemented && strings . Contains ( st . Message ( ) , "unsupported frontend capability moby.buildkit.frontend.contexts" ) {
2022-02-23 13:55:44 +08:00
msg := "current frontend does not support --build-context."
if bake {
msg = "current frontend does not support defining additional contexts for targets."
}
msg += " Named contexts are supported since Dockerfile v1.4. Use #syntax directive in Dockerfile or update to latest BuildKit."
return & wrapped { err , msg }
2022-01-05 14:34:30 +08:00
}
}
return err
}
type wrapped struct {
err error
msg string
}
func ( w * wrapped ) Error ( ) string {
return w . msg
}
func ( w * wrapped ) Unwrap ( ) error {
return w . err
}
2022-05-05 09:48:50 +08:00
func isExperimental ( ) bool {
2022-08-12 09:45:08 +08:00
if v , ok := os . LookupEnv ( "BUILDX_EXPERIMENTAL" ) ; ok {
2022-05-05 09:48:50 +08:00
vv , _ := strconv . ParseBool ( v )
return vv
}
return false
}
2022-12-07 18:44:33 +08:00
func updateLastActivity ( dockerCli command . Cli , ng * store . NodeGroup ) error {
txn , release , err := storeutil . GetStore ( dockerCli )
if err != nil {
return err
}
defer release ( )
return txn . UpdateLastActivity ( ng )
}
2022-08-29 13:14:14 +08:00
func launchControllerAndRunBuild ( dockerCli command . Cli , options buildOptions ) error {
ctx := context . TODO ( )
if options . Quiet && options . progress != "auto" && options . progress != "quiet" {
return errors . Errorf ( "progress=%s and quiet cannot be used together" , options . progress )
} else if options . Quiet {
options . progress = "quiet"
}
if options . invoke != "" && ( options . DockerfileName == "-" || options . ContextPath == "-" ) {
// stdin must be usable for monitor
return errors . Errorf ( "Dockerfile or context from stdin is not supported with invoke" )
}
var invokeConfig controllerapi . ContainerConfig
if inv := options . invoke ; inv != "" {
var err error
invokeConfig , err = parseInvokeConfig ( inv ) // TODO: produce *controller.ContainerConfig directly.
if err != nil {
return err
}
}
var c monitor . BuildxController
var err error
if options . detach {
logrus . Infof ( "connecting to buildx server" )
c , err = newRemoteBuildxController ( ctx , dockerCli , options )
if err != nil {
return fmt . Errorf ( "failed to use buildx server; use --detach=false: %w" , err )
}
} else {
logrus . Infof ( "launching local buildx controller" )
c = newLocalBuildxController ( ctx , dockerCli )
}
defer func ( ) {
if err := c . Close ( ) ; err != nil {
logrus . Warnf ( "failed to close server connection %v" , err )
}
} ( )
f := ioset . NewSingleForwarder ( )
pr , pw := io . Pipe ( )
f . SetWriter ( pw , func ( ) io . WriteCloser {
pw . Close ( ) // propagate EOF
logrus . Debug ( "propagating stdin close" )
return nil
} )
f . SetReader ( os . Stdin )
// Start build
ref , err := c . Build ( ctx , options . BuildOptions , pr , os . Stdout , os . Stderr , options . progress )
if err != nil {
return fmt . Errorf ( "failed to build: %w" , err ) // TODO: allow invoke even on error
}
if err := pw . Close ( ) ; err != nil {
logrus . Debug ( "failed to close stdin pipe writer" )
}
if err := pr . Close ( ) ; err != nil {
logrus . Debug ( "failed to close stdin pipe reader" )
}
// post-build operations
if options . invoke != "" {
pr2 , pw2 := io . Pipe ( )
f . SetWriter ( pw2 , func ( ) io . WriteCloser {
pw2 . Close ( ) // propagate EOF
return nil
} )
con := console . Current ( )
if err := con . SetRaw ( ) ; err != nil {
if err := c . Disconnect ( ctx , ref ) ; err != nil {
logrus . Warnf ( "disconnect error: %v" , err )
}
return errors . Errorf ( "failed to configure terminal: %v" , err )
}
err = monitor . RunMonitor ( ctx , ref , options . BuildOptions , invokeConfig , c , options . progress , pr2 , os . Stdout , os . Stderr )
con . Reset ( )
if err := pw2 . Close ( ) ; err != nil {
logrus . Debug ( "failed to close monitor stdin pipe reader" )
}
if err != nil {
logrus . Warnf ( "failed to run monitor: %v" , err )
}
} else {
if err := c . Disconnect ( ctx , ref ) ; err != nil {
logrus . Warnf ( "disconnect error: %v" , err )
}
// If "invoke" isn't specified, further inspection ins't provided. Finish the buildx server.
if err := c . Kill ( ctx ) ; err != nil {
return err
}
}
return nil
}
func parseInvokeConfig ( invoke string ) ( cfg controllerapi . ContainerConfig , err error ) {
cfg . Tty = true
if invoke == "default" {
return cfg , nil
}
csvReader := csv . NewReader ( strings . NewReader ( invoke ) )
fields , err := csvReader . Read ( )
if err != nil {
return cfg , err
}
if len ( fields ) == 1 && ! strings . Contains ( fields [ 0 ] , "=" ) {
cfg . Cmd = [ ] string { fields [ 0 ] }
return cfg , nil
}
cfg . NoUser = true
cfg . NoCwd = true
for _ , field := range fields {
parts := strings . SplitN ( field , "=" , 2 )
if len ( parts ) != 2 {
return cfg , errors . Errorf ( "invalid value %s" , field )
}
key := strings . ToLower ( parts [ 0 ] )
value := parts [ 1 ]
switch key {
case "args" :
cfg . Cmd = append ( cfg . Cmd , value ) // TODO: support JSON
case "entrypoint" :
cfg . Entrypoint = append ( cfg . Entrypoint , value ) // TODO: support JSON
case "env" :
cfg . Env = append ( cfg . Env , value )
case "user" :
cfg . User = value
cfg . NoUser = false
case "cwd" :
cfg . Cwd = value
cfg . NoCwd = false
case "tty" :
cfg . Tty , err = strconv . ParseBool ( value )
if err != nil {
return cfg , errors . Errorf ( "failed to parse tty: %v" , err )
}
default :
return cfg , errors . Errorf ( "unknown key %q" , key )
}
}
return cfg , nil
}
func controllerUlimitOpt2DockerUlimit ( u * controllerapi . UlimitOpt ) * dockeropts . UlimitOpt {
if u == nil {
return nil
}
values := make ( map [ string ] * units . Ulimit )
for k , v := range u . Values {
values [ k ] = & units . Ulimit {
Name : v . Name ,
Hard : v . Hard ,
Soft : v . Soft ,
}
}
return dockeropts . NewUlimitOpt ( & values )
}
func newBuildOptions ( ) buildOptions {
return buildOptions {
BuildOptions : controllerapi . BuildOptions {
Opts : & controllerapi . CommonOptions { } ,
} ,
}
}
func newUlimits ( opt * buildOptions ) * ulimits {
ul := make ( map [ string ] * units . Ulimit )
return & ulimits { opt : opt , org : dockeropts . NewUlimitOpt ( & ul ) }
}
type ulimits struct {
opt * buildOptions
org * dockeropts . UlimitOpt
}
func ( u * ulimits ) sync ( ) {
du := & controllerapi . UlimitOpt {
Values : make ( map [ string ] * controllerapi . Ulimit ) ,
}
for _ , l := range u . org . GetList ( ) {
du . Values [ l . Name ] = & controllerapi . Ulimit {
Name : l . Name ,
Hard : l . Hard ,
Soft : l . Soft ,
}
}
u . opt . Ulimits = du
}
func ( u * ulimits ) String ( ) string {
return u . org . String ( )
}
func ( u * ulimits ) Set ( v string ) error {
err := u . org . Set ( v )
u . sync ( )
return err
}
func ( u * ulimits ) Type ( ) string {
return u . org . Type ( )
}
func newShmSize ( opt * buildOptions ) * shmSize {
return & shmSize { opt : opt }
}
type shmSize struct {
opt * buildOptions
org dockeropts . MemBytes
}
func ( s * shmSize ) sync ( ) {
s . opt . ShmSize = s . org . Value ( )
}
func ( s * shmSize ) String ( ) string {
return s . org . String ( )
}
func ( s * shmSize ) Set ( v string ) error {
err := s . org . Set ( v )
s . sync ( )
return err
}
func ( s * shmSize ) Type ( ) string {
return s . org . Type ( )
}