build

Documentation

Index

• Constants
• func Build(ctx context.Context, nodes []builder.Node, opt map[string]Options, ...) (resp map[string]*client.SolveResponse, err error)
• func BuildWithResultHandler(ctx context.Context, nodes []builder.Node, opt map[string]Options, ...) (resp map[string]*client.SolveResponse, err error)
• func Invoke(ctx context.Context, cfg ContainerConfig) error
• func LoadInputs(ctx context.Context, d driver.Driver, inp Inputs, pw progress.Writer, ...) (func(), error)
• type ContainerConfig
• type Inputs
• type NamedContext
• type Options
• type PrintFunc
• type ResultContext

Constants

const DockerfileLabel = "com.docker.image.source.entrypoint"

Functions

func Build

func Build(ctx context.Context, nodes []builder.Node, opt map[string]Options, docker *dockerutil.Client, configDir string, w progress.Writer) (resp map[string]*client.SolveResponse, err error)

func BuildWithResultHandler

func BuildWithResultHandler(ctx context.Context, nodes []builder.Node, opt map[string]Options, docker *dockerutil.Client, configDir string, w progress.Writer, resultHandleFunc func(driverIndex int, rCtx *ResultContext), allowNoOutput bool) (resp map[string]*client.SolveResponse, err error)

func Invoke

func Invoke(ctx context.Context, cfg ContainerConfig) error

Invoke invokes a build result as a container.

func LoadInputs

func LoadInputs(ctx context.Context, d driver.Driver, inp Inputs, pw progress.Writer, target *client.SolveOpt) (func(), error)

Types

type ContainerConfig

type ContainerConfig struct {
	ResultCtx *ResultContext

	Stdin  io.ReadCloser
	Stdout io.WriteCloser
	Stderr io.WriteCloser
	Tty    bool

	Entrypoint []string
	Cmd        []string
	Env        []string
	User       *string
	Cwd        *string
}

ContainerConfig is configuration for a container to run.

type Inputs

type Inputs struct {
	ContextPath      string
	DockerfilePath   string
	InStream         io.Reader
	ContextState     *llb.State
	DockerfileInline string
	NamedContexts    map[string]NamedContext
}

type NamedContext

type NamedContext struct {
	Path  string
	State *llb.State
}

type Options

type Options struct {
	Inputs Inputs

	Allow         []entitlements.Entitlement
	Attests       map[string]*string
	BuildArgs     map[string]string
	CacheFrom     []client.CacheOptionsEntry
	CacheTo       []client.CacheOptionsEntry
	CgroupParent  string
	Exports       []client.ExportEntry
	ExtraHosts    []string
	ImageIDFile   string
	Labels        map[string]string
	NetworkMode   string
	NoCache       bool
	NoCacheFilter []string
	Platforms     []specs.Platform
	Pull          bool
	Session       []session.Attachable
	ShmSize       opts.MemBytes
	Tags          []string
	Target        string
	Ulimits       *opts.UlimitOpt

	// Linked marks this target as exclusively linked (not requested by the user).
	Linked    bool
	PrintFunc *PrintFunc
}

type PrintFunc

type PrintFunc struct {
	Name   string
	Format string
}

type ResultContext

type ResultContext struct {
	Client *client.Client
	Res    *gateway.Result
}

ResultContext is a build result with the client that built it.