container_backend

package
v2.73.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 2, 2026 License: Apache-2.0 Imports: 50 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	SSHHostAuthSockPath      = "/run/host-services/ssh-auth.sock"
	SSHContainerAuthSockPath = "/.werf/tmp/ssh-auth-sock"
)
View Source 
const (
	ErrPatchApplyCode = 42
)

Variables

View Source 
var (
	ErrUnsupportedFeature           = errors.New("unsupported feature")
	ErrCannotRemovePausedContainer  = errors.New("cannot remove paused container")
	ErrCannotRemoveRunningContainer = errors.New("cannot remove running container")
	ErrImageUsedByContainer         = types.ErrImageUsedByContainer
	ErrPruneIsAlreadyRunning        = errors.New("a prune operation is already running")
)
View Source 
var ErrPatchApply = errors.New(`cannot update source code added by git directive because the files being patched were modified by user commands in earlier stages (install, beforeSetup or setup)

Possible solutions:

  - If these files should not be changed, update the commands that modify them.

  - If these files should be changed, declare them explicitly using the stageDependencies.<install|beforeSetup|setup> directive. This ensures the files are updated before running user commands.

  - If these files are not needed, exclude them using the includePaths or excludePaths options under the git directive.`)

Functions

func CliErrorByCode added in v2.36.2 

func CliErrorByCode(err error) error

func ContainerLockName 

func ContainerLockName(containerName string) string

func Debug 

func Debug() bool

func ImageLockName 

func ImageLockName(imageName string) string

func IsStartContainerErr 

func IsStartContainerErr(err error) bool

https://docs.docker.com/engine/reference/run/#exit-status

func LogImageInfo 

func LogImageInfo(ctx context.Context, img LegacyImageInterface, prevStageImageSize int64, withPlatform bool, network string)

func LogImageName 

func LogImageName(ctx context.Context, name string)

func LogMultiplatformImageInfo 

func LogMultiplatformImageInfo(ctx context.Context, platforms []string)

func MutateAndPushImage added in v2.53.0 

func MutateAndPushImage(ctx context.Context, imageName, targetPlatform string, newConfig image.SpecConfig, backend BackendLoaderStorer) (string, error)

func PullImageFromRegistry added in v2.42.0 

func PullImageFromRegistry(ctx context.Context, containerBackend ContainerBackend, img LegacyImageInterface) error

func RegisterRunningContainer 

func RegisterRunningContainer(name string, ctx context.Context)

func SanitizeError added in v2.57.2 

func SanitizeError(err error) error

func ShelloutPack 

func ShelloutPack(command string) string

func TerminateRunningDockerContainers 

func TerminateRunningDockerContainers() error

func UnregisterRunningContainer 

func UnregisterRunningContainer(name string)

Types

type AddDataArchiveOptions 

type AddDataArchiveOptions struct {
	Owner, Group string
}

type ArchiveType 

type ArchiveType int
const (
	FileArchive ArchiveType = iota
	DirectoryArchive
)

func (ArchiveType) String 

func (i ArchiveType) String() string

type BackendLoaderStorer added in v2.53.0 

type BackendLoaderStorer interface {
	SaveImageToStream(ctx context.Context, imageName string) (io.ReadCloser, error)
	LoadImageFromStream(ctx context.Context, input io.Reader) (string, error)
}

type BuildContextArchiveCreateOptions 

type BuildContextArchiveCreateOptions struct {
	DockerfileRelToContextPath string
	ContextGitSubDir           string
	ContextAddFiles            []string
}

type BuildContextArchiver 

type BuildContextArchiver interface {
	Create(ctx context.Context, opts BuildContextArchiveCreateOptions) error
	Path() string
	ExtractOrGetExtractedDir(ctx context.Context) (string, error)
	CalculatePathsChecksum(ctx context.Context, paths []string) (string, error)
	CalculateGlobsChecksum(ctx context.Context, globs []string, checkForArchive bool) (string, error)
	CleanupExtractedDir(ctx context.Context)
}

type BuildDockerfileOpts 

type BuildDockerfileOpts struct {
	CommonOpts

	BuildContextArchive  BuildContextArchiver
	DockerfileCtxRelPath string
	Target               string
	BuildArgs            []string // {"key1=value1", "key2=value2", ... }
	AddHost              []string
	Network              string
	SSH                  string
	Labels               []string
	Tags                 []string
	Secrets              []string
}

type BuildDockerfileStageOptions 

type BuildDockerfileStageOptions struct {
	CommonOpts
	BuildContextArchive BuildContextArchiver
}

type BuildOptions 

type BuildOptions struct {
	TargetPlatform        string
	Network               string
	IntrospectBeforeError bool
	IntrospectAfterError  bool
}

type BuildStapelStageOptions 

type BuildStapelStageOptions struct {
	TargetPlatform string

	Labels      []string
	Volumes     []string
	Expose      []string
	Envs        map[string]string
	Cmd         []string
	Entrypoint  []string
	User        string
	Workdir     string
	Healthcheck string
	Network     string

	BuildVolumes []string
	Commands     []string

	DataArchiveSpecs      []DataArchiveSpec
	RemoveDataSpecs       []RemoveDataSpec
	DependencyImportSpecs []DependencyImportSpec
}

func (*BuildStapelStageOptions) AddBuildVolumes 

func (opts *BuildStapelStageOptions) AddBuildVolumes(volumes ...string) BuildStapelStageOptionsInterface

func (*BuildStapelStageOptions) AddCommands 

func (opts *BuildStapelStageOptions) AddCommands(commands ...string) BuildStapelStageOptionsInterface

func (*BuildStapelStageOptions) AddDataArchive 

func (opts *BuildStapelStageOptions) AddDataArchive(archive io.ReadCloser, archiveType ArchiveType, to string, o AddDataArchiveOptions) BuildStapelStageOptionsInterface

func (*BuildStapelStageOptions) AddDependencyImport 

func (opts *BuildStapelStageOptions) AddDependencyImport(imageName, fromPath, toPath string, includePaths, excludePaths []string, owner, group string) BuildStapelStageOptionsInterface

func (*BuildStapelStageOptions) AddEnvs 

func (opts *BuildStapelStageOptions) AddEnvs(envs map[string]string) BuildStapelStageOptionsInterface

func (*BuildStapelStageOptions) AddExpose 

func (opts *BuildStapelStageOptions) AddExpose(expose []string) BuildStapelStageOptionsInterface

func (*BuildStapelStageOptions) AddLabels 

func (opts *BuildStapelStageOptions) AddLabels(labels map[string]string) BuildStapelStageOptionsInterface

func (*BuildStapelStageOptions) AddVolumes 

func (opts *BuildStapelStageOptions) AddVolumes(volumes []string) BuildStapelStageOptionsInterface

func (*BuildStapelStageOptions) MountSSHAgentSocket added in v2.16.3 

func (opts *BuildStapelStageOptions) MountSSHAgentSocket(sshAuthSock string)

func (*BuildStapelStageOptions) RemoveData 

func (opts *BuildStapelStageOptions) RemoveData(removeType RemoveType, paths, keepParentDirs []string) BuildStapelStageOptionsInterface

func (*BuildStapelStageOptions) SetCmd 

func (opts *BuildStapelStageOptions) SetCmd(cmd []string) BuildStapelStageOptionsInterface

func (*BuildStapelStageOptions) SetEntrypoint 

func (opts *BuildStapelStageOptions) SetEntrypoint(entrypoint []string) BuildStapelStageOptionsInterface

func (*BuildStapelStageOptions) SetHealthcheck 

func (opts *BuildStapelStageOptions) SetHealthcheck(healthcheck string) BuildStapelStageOptionsInterface

func (*BuildStapelStageOptions) SetNetwork added in v2.62.0 

func (opts *BuildStapelStageOptions) SetNetwork(network string) BuildStapelStageOptionsInterface

func (*BuildStapelStageOptions) SetUser 

func (opts *BuildStapelStageOptions) SetUser(user string) BuildStapelStageOptionsInterface

func (*BuildStapelStageOptions) SetWorkdir 

func (opts *BuildStapelStageOptions) SetWorkdir(workdir string) BuildStapelStageOptionsInterface

type BuildStapelStageOptionsInterface 

type BuildStapelStageOptionsInterface interface {
	AddLabels(labels map[string]string) BuildStapelStageOptionsInterface
	AddVolumes(volumes []string) BuildStapelStageOptionsInterface
	AddExpose(expose []string) BuildStapelStageOptionsInterface
	AddEnvs(envs map[string]string) BuildStapelStageOptionsInterface
	SetCmd(cmd []string) BuildStapelStageOptionsInterface
	SetEntrypoint(entrypoint []string) BuildStapelStageOptionsInterface
	SetUser(user string) BuildStapelStageOptionsInterface
	SetWorkdir(workdir string) BuildStapelStageOptionsInterface
	SetHealthcheck(healthcheck string) BuildStapelStageOptionsInterface
	SetNetwork(network string) BuildStapelStageOptionsInterface

	AddBuildVolumes(volumes ...string) BuildStapelStageOptionsInterface
	AddCommands(commands ...string) BuildStapelStageOptionsInterface
	MountSSHAgentSocket(sshAuthSock string)

	AddDataArchive(archive io.ReadCloser, archiveType ArchiveType, to string, o AddDataArchiveOptions) BuildStapelStageOptionsInterface
	RemoveData(removeType RemoveType, paths, keepParentDirs []string) BuildStapelStageOptionsInterface
	AddDependencyImport(imageName, fromPath, toPath string, includePaths, excludePaths []string, owner, group string) BuildStapelStageOptionsInterface
}

type BuildahBackend 

type BuildahBackend struct {
	BuildahBackendOptions
	// contains filtered or unexported fields
}

func NewBuildahBackend 

func NewBuildahBackend(buildah buildah.Buildah, opts BuildahBackendOptions) *BuildahBackend

func (*BuildahBackend) BuildDockerfile 

func (backend *BuildahBackend) BuildDockerfile(ctx context.Context, dockerfileContent []byte, opts BuildDockerfileOpts) (string, error)

func (*BuildahBackend) BuildDockerfileStage 

func (backend *BuildahBackend) BuildDockerfileStage(ctx context.Context, baseImage string, opts BuildDockerfileStageOptions, instructions ...InstructionInterface) (string, error)

func (*BuildahBackend) BuildStapelStage 

func (backend *BuildahBackend) BuildStapelStage(ctx context.Context, baseImage string, opts BuildStapelStageOptions) (string, error)

func (*BuildahBackend) CalculateDependencyImportChecksum 

func (backend *BuildahBackend) CalculateDependencyImportChecksum(ctx context.Context, dependencyImport DependencyImportSpec, opts CalculateDependencyImportChecksum) (string, error)

func (*BuildahBackend) ClaimTargetPlatforms 

func (backend *BuildahBackend) ClaimTargetPlatforms(ctx context.Context, targetPlatforms []string)

func (*BuildahBackend) Containers 

func (backend *BuildahBackend) Containers(ctx context.Context, opts ContainersOptions) (image.ContainerList, error)

func (*BuildahBackend) GetDefaultPlatform 

func (backend *BuildahBackend) GetDefaultPlatform() string

func (*BuildahBackend) GetImageInfo 

func (backend *BuildahBackend) GetImageInfo(ctx context.Context, ref string, opts GetImageInfoOpts) (*image.Info, error)

GetImageInfo returns nil, nil if image not found.

func (*BuildahBackend) GetRuntimePlatform 

func (backend *BuildahBackend) GetRuntimePlatform() string

func (*BuildahBackend) HasStapelBuildSupport 

func (backend *BuildahBackend) HasStapelBuildSupport() bool

func (*BuildahBackend) Images 

func (backend *BuildahBackend) Images(ctx context.Context, opts ImagesOptions) (image.ImagesList, error)

func (*BuildahBackend) Info added in v2.25.0 

func (backend *BuildahBackend) Info(ctx context.Context) (info.Info, error)

func (*BuildahBackend) LoadImageFromStream added in v2.53.0 

func (backend *BuildahBackend) LoadImageFromStream(ctx context.Context, input io.Reader) (string, error)

func (*BuildahBackend) PostManifest 

func (backend *BuildahBackend) PostManifest(ctx context.Context, ref string, opts PostManifestOpts) error

func (*BuildahBackend) PruneImages added in v2.32.0 

func (backend *BuildahBackend) PruneImages(ctx context.Context, options prune.Options) (prune.Report, error)

func (*BuildahBackend) PruneVolumes added in v2.32.0 

func (backend *BuildahBackend) PruneVolumes(_ context.Context, _ prune.Options) (prune.Report, error)

func (*BuildahBackend) Pull 

func (backend *BuildahBackend) Pull(ctx context.Context, ref string, opts PullOpts) error

func (*BuildahBackend) PullImageFromRegistry 

func (backend *BuildahBackend) PullImageFromRegistry(ctx context.Context, img LegacyImageInterface) error

func (*BuildahBackend) Push 

func (backend *BuildahBackend) Push(ctx context.Context, ref string, opts PushOpts) error

func (*BuildahBackend) RefreshImageObject 

func (backend *BuildahBackend) RefreshImageObject(ctx context.Context, img LegacyImageInterface) error

func (*BuildahBackend) RemoveHostDirs 

func (backend *BuildahBackend) RemoveHostDirs(ctx context.Context, mountDir string, dirs []string) error

func (*BuildahBackend) RemoveImage 

func (backend *BuildahBackend) RemoveImage(ctx context.Context, img LegacyImageInterface) error

func (*BuildahBackend) RenameImage 

func (backend *BuildahBackend) RenameImage(ctx context.Context, img LegacyImageInterface, newImageName string, removeOldName bool) error

func (*BuildahBackend) Rm 

func (backend *BuildahBackend) Rm(ctx context.Context, name string, opts RmOpts) error

func (*BuildahBackend) Rmi 

func (backend *BuildahBackend) Rmi(ctx context.Context, ref string, opts RmiOpts) error

func (*BuildahBackend) SaveImageToStream added in v2.53.0 

func (backend *BuildahBackend) SaveImageToStream(ctx context.Context, imageName string) (io.ReadCloser, error)

func (*BuildahBackend) String 

func (backend *BuildahBackend) String() string

func (*BuildahBackend) Tag 

func (backend *BuildahBackend) Tag(ctx context.Context, ref, newRef string, opts TagOpts) error

func (*BuildahBackend) TagImageByName 

func (backend *BuildahBackend) TagImageByName(ctx context.Context, img LegacyImageInterface) error

type BuildahBackendOptions 

type BuildahBackendOptions struct {
	TmpDir string
}

type CalculateDependencyImportChecksum 

type CalculateDependencyImportChecksum CommonOpts

type CommonOpts 

type CommonOpts struct {
	TargetPlatform string
}

type ContainerBackend 

type ContainerBackend interface {
	Info(ctx context.Context) (info.Info, error)

	Tag(ctx context.Context, ref, newRef string, opts TagOpts) error
	Push(ctx context.Context, ref string, opts PushOpts) error
	Pull(ctx context.Context, ref string, opts PullOpts) error
	Rmi(ctx context.Context, ref string, opts RmiOpts) error
	Rm(ctx context.Context, name string, opts RmOpts) error
	PostManifest(ctx context.Context, ref string, opts PostManifestOpts) error

	GetImageInfo(ctx context.Context, ref string, opts GetImageInfoOpts) (*image.Info, error)
	BuildDockerfile(ctx context.Context, dockerfile []byte, opts BuildDockerfileOpts) (string, error)
	BuildDockerfileStage(ctx context.Context, baseImage string, opts BuildDockerfileStageOptions, instructions ...InstructionInterface) (string, error)
	BuildStapelStage(ctx context.Context, baseImage string, opts BuildStapelStageOptions) (string, error)
	CalculateDependencyImportChecksum(ctx context.Context, dependencyImport DependencyImportSpec, opts CalculateDependencyImportChecksum) (string, error)

	HasStapelBuildSupport() bool
	GetDefaultPlatform() string
	GetRuntimePlatform() string

	Images(ctx context.Context, opts ImagesOptions) (image.ImagesList, error)
	Containers(ctx context.Context, opts ContainersOptions) (image.ContainerList, error)

	ClaimTargetPlatforms(ctx context.Context, targetPlatforms []string)

	// PruneImages removes all dangling images
	PruneImages(ctx context.Context, options prune.Options) (prune.Report, error)
	// PruneVolumes removes all anonymous volumes not used by at least one container
	PruneVolumes(ctx context.Context, options prune.Options) (prune.Report, error)

	String() string

	// TODO: Util method for cleanup, which possibly should be avoided in the future
	RemoveHostDirs(ctx context.Context, mountDir string, dirs []string) error

	// Legacy
	RefreshImageObject(ctx context.Context, img LegacyImageInterface) error
	PullImageFromRegistry(ctx context.Context, img LegacyImageInterface) error
	RenameImage(ctx context.Context, img LegacyImageInterface, newImageName string, removeOldName bool) error
	RemoveImage(ctx context.Context, img LegacyImageInterface) error
	TagImageByName(ctx context.Context, img LegacyImageInterface) error
	// Mutation
	SaveImageToStream(ctx context.Context, imageName string) (io.ReadCloser, error)
	LoadImageFromStream(ctx context.Context, input io.Reader) (string, error)
}

type ContainersOptions 

type ContainersOptions struct {
	CommonOpts
	Filters []image.ContainerFilter
}

type DataArchiveSpec 

type DataArchiveSpec struct {
	Archive      io.ReadCloser
	Type         ArchiveType
	To           string
	Owner, Group string
}

type DependencyImportSpec 

type DependencyImportSpec struct {
	ImageName    string
	FromPath     string
	ToPath       string
	IncludePaths []string
	ExcludePaths []string
	Owner        string
	Group        string
}

type DockerServerBackend 

type DockerServerBackend struct {
	// contains filtered or unexported fields
}

func NewDockerServerBackend 

func NewDockerServerBackend(locker lockgate.Locker) *DockerServerBackend

func (*DockerServerBackend) BuildDockerfile 

func (backend *DockerServerBackend) BuildDockerfile(ctx context.Context, _ []byte, opts BuildDockerfileOpts) (string, error)

func (*DockerServerBackend) BuildDockerfileStage 

func (backend *DockerServerBackend) BuildDockerfileStage(ctx context.Context, baseImage string, opts BuildDockerfileStageOptions, instructions ...InstructionInterface) (string, error)

func (*DockerServerBackend) BuildStapelStage 

func (backend *DockerServerBackend) BuildStapelStage(ctx context.Context, baseImage string, opts BuildStapelStageOptions) (string, error)

func (*DockerServerBackend) CalculateDependencyImportChecksum 

func (backend *DockerServerBackend) CalculateDependencyImportChecksum(ctx context.Context, dependencyImport DependencyImportSpec, opts CalculateDependencyImportChecksum) (string, error)

func (*DockerServerBackend) ClaimTargetPlatforms 

func (backend *DockerServerBackend) ClaimTargetPlatforms(ctx context.Context, targetPlatforms []string)

func (*DockerServerBackend) Containers 

func (backend *DockerServerBackend) Containers(ctx context.Context, opts ContainersOptions) (image.ContainerList, error)

func (*DockerServerBackend) GetDefaultPlatform 

func (backend *DockerServerBackend) GetDefaultPlatform() string

func (*DockerServerBackend) GetImageInfo 

func (backend *DockerServerBackend) GetImageInfo(ctx context.Context, ref string, opts GetImageInfoOpts) (*image.Info, error)

func (*DockerServerBackend) GetImageInspect 

func (backend *DockerServerBackend) GetImageInspect(ctx context.Context, ref string) (*types.ImageInspect, error)

GetImageInspect only available for DockerServerBackend

func (*DockerServerBackend) GetRuntimePlatform 

func (backend *DockerServerBackend) GetRuntimePlatform() string

func (*DockerServerBackend) HasStapelBuildSupport 

func (backend *DockerServerBackend) HasStapelBuildSupport() bool

func (*DockerServerBackend) Images 

func (backend *DockerServerBackend) Images(ctx context.Context, opts ImagesOptions) (image.ImagesList, error)

func (*DockerServerBackend) Info added in v2.25.0 

func (backend *DockerServerBackend) Info(ctx context.Context) (info.Info, error)

func (*DockerServerBackend) LoadImageFromStream added in v2.53.0 

func (backend *DockerServerBackend) LoadImageFromStream(ctx context.Context, input io.Reader) (string, error)

func (*DockerServerBackend) PostManifest 

func (backend *DockerServerBackend) PostManifest(ctx context.Context, ref string, opts PostManifestOpts) error

func (*DockerServerBackend) PruneImages added in v2.32.0 

func (backend *DockerServerBackend) PruneImages(ctx context.Context, options prune.Options) (prune.Report, error)

func (*DockerServerBackend) PruneVolumes added in v2.32.0 

func (backend *DockerServerBackend) PruneVolumes(ctx context.Context, options prune.Options) (prune.Report, error)

func (*DockerServerBackend) Pull 

func (backend *DockerServerBackend) Pull(ctx context.Context, ref string, opts PullOpts) error

func (*DockerServerBackend) PullImageFromRegistry 

func (backend *DockerServerBackend) PullImageFromRegistry(ctx context.Context, img LegacyImageInterface) error

func (*DockerServerBackend) Push 

func (backend *DockerServerBackend) Push(ctx context.Context, ref string, opts PushOpts) error

func (*DockerServerBackend) PushImage 

func (backend *DockerServerBackend) PushImage(ctx context.Context, img LegacyImageInterface) error

func (*DockerServerBackend) RefreshImageObject 

func (backend *DockerServerBackend) RefreshImageObject(ctx context.Context, img LegacyImageInterface) error

func (*DockerServerBackend) RemoveHostDirs 

func (backend *DockerServerBackend) RemoveHostDirs(ctx context.Context, mountDir string, dirs []string) error

func (*DockerServerBackend) RemoveImage 

func (backend *DockerServerBackend) RemoveImage(ctx context.Context, img LegacyImageInterface) error

func (*DockerServerBackend) RenameImage 

func (backend *DockerServerBackend) RenameImage(ctx context.Context, img LegacyImageInterface, newImageName string, removeOldName bool) error

FIXME(multiarch): targetPlatform support needed?

func (*DockerServerBackend) Rm 

func (backend *DockerServerBackend) Rm(ctx context.Context, ref string, opts RmOpts) error

func (*DockerServerBackend) Rmi 

func (backend *DockerServerBackend) Rmi(ctx context.Context, ref string, opts RmiOpts) error

func (*DockerServerBackend) SaveImageToStream added in v2.53.0 

func (backend *DockerServerBackend) SaveImageToStream(ctx context.Context, imageName string) (io.ReadCloser, error)

func (*DockerServerBackend) String 

func (backend *DockerServerBackend) String() string

func (*DockerServerBackend) Tag 

func (backend *DockerServerBackend) Tag(ctx context.Context, ref, newRef string, opts TagOpts) error

func (*DockerServerBackend) TagImageByName 

func (backend *DockerServerBackend) TagImageByName(ctx context.Context, img LegacyImageInterface) error

type GetImageInfoOpts 

type GetImageInfoOpts CommonOpts

type ImageInterface 

type ImageInterface interface {
	Name() string
	SetName(name string)

	SetBuiltID(builtID string)
	BuiltID() string
}

type ImagesOptions 

type ImagesOptions struct {
	CommonOpts
	Filters []util.Pair[string, string]
}

type InstructionInterface 

type InstructionInterface interface {
	Name() string
	Apply(ctx context.Context, containerName string, drv buildah.Buildah, drvOpts buildah.CommonOpts, buildContextArchive BuildContextArchiver) error
	UsesBuildContext() bool
}

type LegacyBuilderContainer 

type LegacyBuilderContainer interface {
	AddServiceRunCommands(commands ...string)
	AddRunCommands(commands ...string)

	AddVolume(volumes ...string)
	AddVolumeFrom(volumesFrom ...string)
	AddExpose(exposes ...string)
	AddEnv(envs map[string]string)
	AddLabel(labels map[string]string)
	MountSSHAgentSocket(sshAuthSock string)
}

type LegacyCommitChangeOptions 

type LegacyCommitChangeOptions struct {
	ExactValues bool
}

type LegacyContainer 

type LegacyContainer interface {
	Name() string

	UserRunCommands() []string
	UserCommitChanges() []string

	AddServiceRunCommands(commands ...string)
	AddRunCommands(commands ...string)

	RunOptions() LegacyContainerOptions
	CommitChangeOptions() LegacyContainerOptions
	ServiceCommitChangeOptions() LegacyContainerOptions
}

type LegacyContainerOptions 

type LegacyContainerOptions interface {
	AddVolume(volumes ...string)
	AddVolumeFrom(volumesFrom ...string)
	AddExpose(exposes ...string)
	AddEnv(envs map[string]string)
	AddLabel(labels map[string]string)
	AddCmd(cmd string)
	AddWorkdir(workdir string)
	AddUser(user string)
	AddEntrypoint(entrypoint string)
	AddHealthCheck(check string)
	AddNetwork(network string)
}

type LegacyImageInterface 

type LegacyImageInterface interface {
	Name() string
	SetName(name string)

	GetTargetPlatform() string

	Pull(ctx context.Context) error
	Push(ctx context.Context) error

	SetBuildServiceLabels(labels map[string]string)
	GetBuildServiceLabels() map[string]string

	// TODO: build specifics for stapel builder and dockerfile builder
	// TODO: should be under a single separate interface
	Container() LegacyContainer
	BuilderContainer() LegacyBuilderContainer
	SetCommitChangeOptions(opts LegacyCommitChangeOptions)

	Build(context.Context, BuildOptions) error
	SetBuiltID(builtID string)
	BuiltID() string

	Introspect(ctx context.Context) error

	SetInfo(info *image.Info)

	IsExistsLocally() bool

	SetStageDesc(*image.StageDesc)
	GetStageDesc() *image.StageDesc

	GetFinalStageDesc() *image.StageDesc
	SetFinalStageDesc(*image.StageDesc)

	GetCopy() LegacyImageInterface
}

type LegacyStageImage 

type LegacyStageImage struct {
	// contains filtered or unexported fields
}

func NewLegacyStageImage 

func NewLegacyStageImage(fromImage *LegacyStageImage, name string, containerBackend ContainerBackend, targetPlatform string) *LegacyStageImage

func (*LegacyStageImage) Build 

func (i *LegacyStageImage) Build(ctx context.Context, options BuildOptions) error

func (*LegacyStageImage) BuilderContainer 

func (i *LegacyStageImage) BuilderContainer() LegacyBuilderContainer

func (*LegacyStageImage) BuiltID 

func (i *LegacyStageImage) BuiltID() string

func (*LegacyStageImage) Commit 

func (i *LegacyStageImage) Commit(ctx context.Context) error

func (*LegacyStageImage) Container 

func (i *LegacyStageImage) Container() LegacyContainer

func (*LegacyStageImage) GetBuildServiceLabels added in v2.24.0 

func (i *LegacyStageImage) GetBuildServiceLabels() map[string]string

func (*LegacyStageImage) GetCopy 

func (i *LegacyStageImage) GetCopy() LegacyImageInterface

func (LegacyStageImage) GetFinalStageDesc added in v2.14.0 

func (i LegacyStageImage) GetFinalStageDesc() *image.StageDesc

func (*LegacyStageImage) GetID 

func (i *LegacyStageImage) GetID() string

func (*LegacyStageImage) GetInfo 

func (i *LegacyStageImage) GetInfo() *image.Info

func (LegacyStageImage) GetStageDesc added in v2.14.0 

func (i LegacyStageImage) GetStageDesc() *image.StageDesc

func (*LegacyStageImage) GetTargetPlatform 

func (i *LegacyStageImage) GetTargetPlatform() string

func (*LegacyStageImage) Introspect 

func (i *LegacyStageImage) Introspect(ctx context.Context) error

func (LegacyStageImage) IsExistsLocally 

func (i LegacyStageImage) IsExistsLocally() bool

func (*LegacyStageImage) MustGetBuiltID 

func (i *LegacyStageImage) MustGetBuiltID() string

func (*LegacyStageImage) MustResetInfo 

func (i *LegacyStageImage) MustResetInfo(ctx context.Context) error

func (LegacyStageImage) Name 

func (i LegacyStageImage) Name() string

func (*LegacyStageImage) Pull 

func (i *LegacyStageImage) Pull(ctx context.Context) error

func (*LegacyStageImage) Push 

func (i *LegacyStageImage) Push(ctx context.Context) error

func (*LegacyStageImage) SetBuildServiceLabels added in v2.24.0 

func (i *LegacyStageImage) SetBuildServiceLabels(labels map[string]string)

func (*LegacyStageImage) SetBuiltID 

func (i *LegacyStageImage) SetBuiltID(builtID string)

func (*LegacyStageImage) SetCommitChangeOptions 

func (i *LegacyStageImage) SetCommitChangeOptions(opts LegacyCommitChangeOptions)

func (LegacyStageImage) SetFinalStageDesc added in v2.14.0 

func (i LegacyStageImage) SetFinalStageDesc(stageDesc *image.StageDesc)

func (LegacyStageImage) SetInfo 

func (i LegacyStageImage) SetInfo(info *image.Info)

func (LegacyStageImage) SetName 

func (i LegacyStageImage) SetName(name string)

func (LegacyStageImage) SetStageDesc added in v2.14.0 

func (i LegacyStageImage) SetStageDesc(stageDesc *image.StageDesc)

func (*LegacyStageImage) Tag 

func (i *LegacyStageImage) Tag(ctx context.Context, name string) error

func (LegacyStageImage) UnsetInfo 

func (i LegacyStageImage) UnsetInfo()

type LegacyStageImageBuilderContainer 

type LegacyStageImageBuilderContainer struct {
	// contains filtered or unexported fields
}

func (*LegacyStageImageBuilderContainer) AddEnv 

func (c *LegacyStageImageBuilderContainer) AddEnv(envs map[string]string)

func (*LegacyStageImageBuilderContainer) AddExpose 

func (c *LegacyStageImageBuilderContainer) AddExpose(exposes ...string)

func (*LegacyStageImageBuilderContainer) AddLabel 

func (c *LegacyStageImageBuilderContainer) AddLabel(labels map[string]string)

func (*LegacyStageImageBuilderContainer) AddRunCommands 

func (c *LegacyStageImageBuilderContainer) AddRunCommands(commands ...string)

func (*LegacyStageImageBuilderContainer) AddServiceRunCommands 

func (c *LegacyStageImageBuilderContainer) AddServiceRunCommands(commands ...string)

func (*LegacyStageImageBuilderContainer) AddVolume 

func (c *LegacyStageImageBuilderContainer) AddVolume(volumes ...string)

func (*LegacyStageImageBuilderContainer) AddVolumeFrom 

func (c *LegacyStageImageBuilderContainer) AddVolumeFrom(volumesFrom ...string)

func (*LegacyStageImageBuilderContainer) MountSSHAgentSocket added in v2.16.3 

func (c *LegacyStageImageBuilderContainer) MountSSHAgentSocket(sshAuthSock string)

type LegacyStageImageContainer 

type LegacyStageImageContainer struct {
	// contains filtered or unexported fields
}

func (*LegacyStageImageContainer) AddRunCommands 

func (c *LegacyStageImageContainer) AddRunCommands(commands ...string)

func (*LegacyStageImageContainer) AddServiceRunCommands 

func (c *LegacyStageImageContainer) AddServiceRunCommands(commands ...string)

func (*LegacyStageImageContainer) CommitChangeOptions 

func (c *LegacyStageImageContainer) CommitChangeOptions() LegacyContainerOptions

func (*LegacyStageImageContainer) Name 

func (c *LegacyStageImageContainer) Name() string

func (*LegacyStageImageContainer) RunOptions 

func (c *LegacyStageImageContainer) RunOptions() LegacyContainerOptions

func (*LegacyStageImageContainer) ServiceCommitChangeOptions 

func (c *LegacyStageImageContainer) ServiceCommitChangeOptions() LegacyContainerOptions

func (*LegacyStageImageContainer) UserCommitChanges 

func (c *LegacyStageImageContainer) UserCommitChanges() []string

func (*LegacyStageImageContainer) UserRunCommands 

func (c *LegacyStageImageContainer) UserRunCommands() []string

type LegacyStageImageContainerOptions 

type LegacyStageImageContainerOptions struct {
	Volume      []string
	VolumesFrom []string
	Expose      []string
	Env         map[string]string
	Label       map[string]string
	Cmd         string
	Workdir     string
	User        string
	Entrypoint  string
	HealthCheck string
	Network     string
	// contains filtered or unexported fields
}

func (*LegacyStageImageContainerOptions) AddCmd 

func (co *LegacyStageImageContainerOptions) AddCmd(cmd string)

func (*LegacyStageImageContainerOptions) AddEntrypoint 

func (co *LegacyStageImageContainerOptions) AddEntrypoint(entrypoint string)

func (*LegacyStageImageContainerOptions) AddEnv 

func (co *LegacyStageImageContainerOptions) AddEnv(envs map[string]string)

func (*LegacyStageImageContainerOptions) AddExpose 

func (co *LegacyStageImageContainerOptions) AddExpose(exposes ...string)

func (*LegacyStageImageContainerOptions) AddHealthCheck 

func (co *LegacyStageImageContainerOptions) AddHealthCheck(check string)

func (*LegacyStageImageContainerOptions) AddLabel 

func (co *LegacyStageImageContainerOptions) AddLabel(labels map[string]string)

func (*LegacyStageImageContainerOptions) AddNetwork added in v2.62.0 

func (co *LegacyStageImageContainerOptions) AddNetwork(network string)

func (*LegacyStageImageContainerOptions) AddUser 

func (co *LegacyStageImageContainerOptions) AddUser(user string)

func (*LegacyStageImageContainerOptions) AddVolume 

func (co *LegacyStageImageContainerOptions) AddVolume(volumes ...string)

func (*LegacyStageImageContainerOptions) AddVolumeFrom 

func (co *LegacyStageImageContainerOptions) AddVolumeFrom(volumesFrom ...string)

func (*LegacyStageImageContainerOptions) AddWorkdir 

func (co *LegacyStageImageContainerOptions) AddWorkdir(workdir string)

type PerfCheckContainerBackend 

type PerfCheckContainerBackend struct {
	ContainerBackend ContainerBackend
}

func NewPerfCheckContainerBackend 

func NewPerfCheckContainerBackend(containerBackend ContainerBackend) *PerfCheckContainerBackend

func (*PerfCheckContainerBackend) BuildDockerfile 

func (runtime *PerfCheckContainerBackend) BuildDockerfile(ctx context.Context, dockerfile []byte, opts BuildDockerfileOpts) (resID string, resErr error)

func (*PerfCheckContainerBackend) BuildDockerfileStage 

func (runtime *PerfCheckContainerBackend) BuildDockerfileStage(ctx context.Context, baseImage string, opts BuildDockerfileStageOptions, instructions ...InstructionInterface) (resID string, resErr error)

func (*PerfCheckContainerBackend) BuildStapelStage 

func (runtime *PerfCheckContainerBackend) BuildStapelStage(ctx context.Context, baseImage string, opts BuildStapelStageOptions) (resID string, resErr error)

func (*PerfCheckContainerBackend) CalculateDependencyImportChecksum 

func (runtime *PerfCheckContainerBackend) CalculateDependencyImportChecksum(ctx context.Context, dependencyImport DependencyImportSpec, opts CalculateDependencyImportChecksum) (resID string, resErr error)

func (*PerfCheckContainerBackend) ClaimTargetPlatforms 

func (runtime *PerfCheckContainerBackend) ClaimTargetPlatforms(ctx context.Context, targetPlatforms []string)

func (*PerfCheckContainerBackend) Containers 

func (runtime *PerfCheckContainerBackend) Containers(ctx context.Context, opts ContainersOptions) (res image.ContainerList, resErr error)

func (*PerfCheckContainerBackend) GetDefaultPlatform 

func (runtime *PerfCheckContainerBackend) GetDefaultPlatform() string

func (*PerfCheckContainerBackend) GetImageInfo 

func (runtime *PerfCheckContainerBackend) GetImageInfo(ctx context.Context, ref string, opts GetImageInfoOpts) (resImg *image.Info, resErr error)

func (*PerfCheckContainerBackend) GetRuntimePlatform 

func (runtime *PerfCheckContainerBackend) GetRuntimePlatform() string

func (*PerfCheckContainerBackend) HasStapelBuildSupport 

func (runtime *PerfCheckContainerBackend) HasStapelBuildSupport() bool

func (*PerfCheckContainerBackend) Images 

func (runtime *PerfCheckContainerBackend) Images(ctx context.Context, opts ImagesOptions) (res image.ImagesList, resErr error)

func (*PerfCheckContainerBackend) Info added in v2.25.0 

func (runtime *PerfCheckContainerBackend) Info(ctx context.Context) (info.Info, error)

func (*PerfCheckContainerBackend) LoadImageFromStream added in v2.53.0 

func (runtime *PerfCheckContainerBackend) LoadImageFromStream(ctx context.Context, input io.Reader) (string, error)

func (*PerfCheckContainerBackend) PostManifest 

func (runtime *PerfCheckContainerBackend) PostManifest(ctx context.Context, ref string, opts PostManifestOpts) (resErr error)

func (*PerfCheckContainerBackend) PruneImages added in v2.32.0 

func (runtime *PerfCheckContainerBackend) PruneImages(ctx context.Context, options prune.Options) (report prune.Report, err error)

func (*PerfCheckContainerBackend) PruneVolumes added in v2.32.0 

func (runtime *PerfCheckContainerBackend) PruneVolumes(ctx context.Context, options prune.Options) (report prune.Report, err error)

func (*PerfCheckContainerBackend) Pull 

func (runtime *PerfCheckContainerBackend) Pull(ctx context.Context, ref string, opts PullOpts) (resErr error)

func (*PerfCheckContainerBackend) PullImageFromRegistry 

func (runtime *PerfCheckContainerBackend) PullImageFromRegistry(ctx context.Context, img LegacyImageInterface) (resErr error)

func (*PerfCheckContainerBackend) Push 

func (runtime *PerfCheckContainerBackend) Push(ctx context.Context, ref string, opts PushOpts) (resErr error)

func (*PerfCheckContainerBackend) RefreshImageObject 

func (runtime *PerfCheckContainerBackend) RefreshImageObject(ctx context.Context, img LegacyImageInterface) (resErr error)

func (*PerfCheckContainerBackend) RemoveHostDirs 

func (runtime *PerfCheckContainerBackend) RemoveHostDirs(ctx context.Context, mountDir string, dirs []string) (resErr error)

func (*PerfCheckContainerBackend) RemoveImage 

func (runtime *PerfCheckContainerBackend) RemoveImage(ctx context.Context, img LegacyImageInterface) (resErr error)

func (*PerfCheckContainerBackend) RenameImage 

func (runtime *PerfCheckContainerBackend) RenameImage(ctx context.Context, img LegacyImageInterface, newImageName string, removeOldName bool) (resErr error)

func (*PerfCheckContainerBackend) Rm 

func (runtime *PerfCheckContainerBackend) Rm(ctx context.Context, name string, opts RmOpts) (resErr error)

func (*PerfCheckContainerBackend) Rmi 

func (runtime *PerfCheckContainerBackend) Rmi(ctx context.Context, ref string, opts RmiOpts) (resErr error)

func (*PerfCheckContainerBackend) SaveImageToStream added in v2.53.0 

func (runtime *PerfCheckContainerBackend) SaveImageToStream(ctx context.Context, imageName string) (io.ReadCloser, error)

func (*PerfCheckContainerBackend) String 

func (runtime *PerfCheckContainerBackend) String() string

func (*PerfCheckContainerBackend) Tag 

func (runtime *PerfCheckContainerBackend) Tag(ctx context.Context, ref, newRef string, opts TagOpts) (resErr error)

func (*PerfCheckContainerBackend) TagImageByName 

func (runtime *PerfCheckContainerBackend) TagImageByName(ctx context.Context, img LegacyImageInterface) (resErr error)

type PostManifestOpts 

type PostManifestOpts struct {
	CommonOpts
	Labels    []string
	Manifests []*image.Info
}

type PullOpts 

type PullOpts CommonOpts

type PushOpts 

type PushOpts CommonOpts

type RemoveDataSpec 

type RemoveDataSpec struct {
	Type           RemoveType
	Paths          []string
	KeepParentDirs []string
}

type RemoveType 

type RemoveType int
const (
	RemoveExactPath RemoveType = iota
	RemoveExactPathWithEmptyParentDirs
	RemoveInsidePath
)

func (RemoveType) String 

func (i RemoveType) String() string

type RmOpts 

type RmOpts struct {
	CommonOpts
	Force bool
}

type RmiOpts 

type RmiOpts struct {
	CommonOpts
	Force bool
}

type TagOpts 

type TagOpts CommonOpts

Source Files

View all Source files

Directories

Path Synopsis
thirdparty
platformutil

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.