Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AuxEmitter ¶
AuxEmitter is an interface for emitting aux messages during build progress
type BuildConfig ¶
type BuildConfig struct { Source io.ReadCloser ProgressWriter ProgressWriter Options *BuildOptions }
BuildConfig is the configuration used by a BuildManager to start a build
type BuildOptions ¶
type BuildOptions struct { Tags []string SuppressOutput bool RemoteContext string NoCache bool Remove bool ForceRemove bool PullParent bool Isolation container.Isolation CPUSetCPUs string CPUSetMems string CPUQuota int64 CPUPeriod int64 Memory int64 MemorySwap int64 CgroupParent string NetworkMode string ShmSize int64 Dockerfile string Ulimits []*container.Ulimit // BuildArgs needs to be a *string instead of just a string so that // we can tell the difference between "" (empty string) and no value // at all (nil). See the parsing of buildArgs in // api/server/router/build/build_routes.go for even more info. BuildArgs map[string]*string AuthConfigs map[string]registry.AuthConfig Context io.Reader Labels map[string]string // squash the resulting image's layers to the parent // preserves the original image and creates a new one from the parent with all // the changes applied to a single layer Squash bool // CacheFrom specifies images that are used for matching cache. Images // specified here do not need to have a valid parent chain to match cache. CacheFrom []string SecurityOpt []string ExtraHosts []string // List of extra hosts Target string SessionID string Platform string // Version specifies the version of the underlying builder to use Version build.BuilderVersion // BuildID is an optional identifier that can be passed together with the // build request. The same identifier can be used to gracefully cancel the // build with the cancel request. BuildID string // Outputs defines configurations for exporting build results. Only supported // in BuildKit mode Outputs []BuildOutput }
BuildOptions holds the information necessary to build images.
type BuildOutput ¶
BuildOutput defines configuration for exporting a build result
type CachePruneOptions ¶
type GetImageAndLayerOptions ¶
type GetImageAndLayerOptions struct { PullOption PullOption AuthConfig map[string]registry.AuthConfig Output io.Writer Platform *ocispec.Platform }
GetImageAndLayerOptions are the options supported by GetImageAndReleasableLayer
type ProgressWriter ¶
type ProgressWriter struct { Output io.Writer StdoutFormatter io.Writer StderrFormatter io.Writer AuxFormatter AuxEmitter ProgressReaderFunc func(io.ReadCloser) io.ReadCloser }
ProgressWriter is a data object to transport progress streams to the client
type PullOption ¶
type PullOption int
PullOption defines different modes for accessing images
const ( // PullOptionNoPull only returns local images PullOptionNoPull PullOption = iota // PullOptionForcePull always tries to pull a ref from the registry first PullOptionForcePull // PullOptionPreferLocal uses local image if it exists, otherwise pulls PullOptionPreferLocal )
Click to show internal directories.
Click to hide internal directories.