Documentation
¶
Overview ¶
Package builder defines interfaces for any Docker builder to implement.
Historically, only server-side Dockerfile interpreters existed. This package allows for other implementations of Docker builders.
Index ¶
Constants ¶
const ( // DefaultDockerfileName is the Default filename with Docker commands, read by docker build DefaultDockerfileName string = "Dockerfile" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Backend ¶ added in v1.10.0
type Backend interface {
ImageBackend
ExecBackend
// Commit creates a new Docker image from an existing Docker container.
Commit(string, *backend.ContainerCommitConfig) (string, error)
// ContainerCreateWorkdir creates the workdir
ContainerCreateWorkdir(containerID string) error
CreateImage(config []byte, parent string, platform string) (Image, error)
ImageCacheBuilder
}
Backend abstracts calls to a Docker Daemon.
type ExecBackend ¶
type ExecBackend interface {
// ContainerAttachRaw attaches to container.
ContainerAttachRaw(cID string, stdin io.ReadCloser, stdout, stderr io.Writer, stream bool, attached chan struct{}) error
// ContainerCreate creates a new Docker container and returns potential warnings
ContainerCreate(config types.ContainerCreateConfig) (container.ContainerCreateCreatedBody, error)
// ContainerRm removes a container specified by `id`.
ContainerRm(name string, config *types.ContainerRmConfig) error
// ContainerKill stops the container execution abruptly.
ContainerKill(containerID string, sig uint64) error
// ContainerStart starts a new container
ContainerStart(containerID string, hostConfig *container.HostConfig, checkpoint string, checkpointDir string) error
// ContainerWait stops processing until the given container is stopped.
ContainerWait(ctx context.Context, name string, condition containerpkg.WaitCondition) (<-chan containerpkg.StateStatus, error)
}
ExecBackend contains the interface methods required for executing containers
type Image ¶ added in v1.10.0
type Image interface {
ImageID() string
RunConfig() *container.Config
MarshalJSON() ([]byte, error)
}
Image represents a Docker image used by the builder.
type ImageBackend ¶
type ImageBackend interface {
GetImageAndReleasableLayer(ctx context.Context, refOrID string, opts backend.GetImageAndLayerOptions) (Image, ReleaseableLayer, error)
}
ImageBackend are the interface methods required from an image component
type ImageCache ¶ added in v1.9.0
type ImageCache interface {
// GetCache returns a reference to a cached image whose parent equals `parent`
// and runconfig equals `cfg`. A cache miss is expected to return an empty ID and a nil error.
GetCache(parentID string, cfg *container.Config) (imageID string, err error)
}
ImageCache abstracts an image cache. (parent image, child runconfig) -> child image
type ImageCacheBuilder ¶ added in v1.13.0
type ImageCacheBuilder interface {
// MakeImageCache creates a stateful image cache.
MakeImageCache(cacheFrom []string, platform string) ImageCache
}
ImageCacheBuilder represents a generator for stateful image cache.
type ReleaseableLayer ¶
type ReleaseableLayer interface {
Release() error
Mount() (containerfs.ContainerFS, error)
Commit(platform string) (ReleaseableLayer, error)
DiffID() layer.DiffID
}
ReleaseableLayer is an image layer that can be mounted and released
type Source ¶
type Source interface {
// Root returns root path for accessing source
Root() containerfs.ContainerFS
// Close allows to signal that the filesystem tree won't be used anymore.
// For Context implementations using a temporary directory, it is recommended to
// delete the temporary directory in Close().
Close() error
// Hash returns a checksum for a file
Hash(path string) (string, error)
}
Source defines a location that can be used as a source for the ADD/COPY instructions in the builder.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package dockerfile is the evaluation step in the Dockerfile parse/evaluate pipeline.
|
Package dockerfile is the evaluation step in the Dockerfile parse/evaluate pipeline. |
|
command
Package command contains the set of Dockerfile commands.
|
Package command contains the set of Dockerfile commands. |
|
parser
Package parser implements a parser and parse tree dumper for Dockerfiles.
|
Package parser implements a parser and parse tree dumper for Dockerfiles. |
|
parser/dumper
command
|
|
|
Package remotecontext is a generated protocol buffer package.
|
Package remotecontext is a generated protocol buffer package. |