Documentation ¶
Index ¶
- func ContainerLockName(containerName string) string
- func Debug() bool
- func ImageLockName(imageName string) string
- func IsStartContainerErr(err error) bool
- func LogImageInfo(ctx context.Context, img LegacyImageInterface, prevStageImageSize int64)
- func LogImageName(ctx context.Context, name string)
- func RegisterRunningContainer(name string, ctx context.Context)
- func ShelloutPack(command string) string
- func TerminateRunningDockerContainers() error
- func UnregisterRunningContainer(name string)
- type AddDataArchiveOptions
- type ArchiveType
- type BuildContextArchiveCreateOptions
- type BuildContextArchiver
- type BuildDockerfileOpts
- type BuildDockerfileStageOptions
- type BuildOptions
- type BuildStapelStageOptions
- func (opts *BuildStapelStageOptions) AddBuildVolumes(volumes ...string) BuildStapelStageOptionsInterface
- func (opts *BuildStapelStageOptions) AddCommands(commands ...string) BuildStapelStageOptionsInterface
- func (opts *BuildStapelStageOptions) AddDataArchive(archive io.ReadCloser, archiveType ArchiveType, to string, ...) BuildStapelStageOptionsInterface
- func (opts *BuildStapelStageOptions) AddDependencyImport(imageName, fromPath, toPath string, includePaths, excludePaths []string, ...) BuildStapelStageOptionsInterface
- func (opts *BuildStapelStageOptions) AddEnvs(envs map[string]string) BuildStapelStageOptionsInterface
- func (opts *BuildStapelStageOptions) AddExpose(expose []string) BuildStapelStageOptionsInterface
- func (opts *BuildStapelStageOptions) AddLabels(labels map[string]string) BuildStapelStageOptionsInterface
- func (opts *BuildStapelStageOptions) AddVolumes(volumes []string) BuildStapelStageOptionsInterface
- func (opts *BuildStapelStageOptions) RemoveData(removeType RemoveType, paths, keepParentDirs []string) BuildStapelStageOptionsInterface
- func (opts *BuildStapelStageOptions) SetCmd(cmd []string) BuildStapelStageOptionsInterface
- func (opts *BuildStapelStageOptions) SetEntrypoint(entrypoint []string) BuildStapelStageOptionsInterface
- func (opts *BuildStapelStageOptions) SetHealthcheck(healthcheck string) BuildStapelStageOptionsInterface
- func (opts *BuildStapelStageOptions) SetUser(user string) BuildStapelStageOptionsInterface
- func (opts *BuildStapelStageOptions) SetWorkdir(workdir string) BuildStapelStageOptionsInterface
- type BuildStapelStageOptionsInterface
- type BuildahBackend
- func (runtime *BuildahBackend) BuildDockerfile(ctx context.Context, dockerfileContent []byte, opts BuildDockerfileOpts) (string, error)
- func (runtime *BuildahBackend) BuildDockerfileStage(ctx context.Context, baseImage string, opts BuildDockerfileStageOptions, ...) (string, error)
- func (runtime *BuildahBackend) BuildStapelStage(ctx context.Context, baseImage string, opts BuildStapelStageOptions) (string, error)
- func (runtime *BuildahBackend) CalculateDependencyImportChecksum(ctx context.Context, dependencyImport DependencyImportSpec) (string, error)
- func (runtime *BuildahBackend) GetImageInfo(ctx context.Context, ref string, opts GetImageInfoOpts) (*image.Info, error)
- func (runtime *BuildahBackend) HasStapelBuildSupport() bool
- func (runtime *BuildahBackend) IsTargetPlatformSupportedForDockerfile(targetPlatform string) bool
- func (runtime *BuildahBackend) IsTargetPlatformSupportedForStagedDockerfile(targetPlatform string) bool
- func (runtime *BuildahBackend) IsTargetPlatformSupportedForStapel(targetPlatform string) bool
- func (runtime *BuildahBackend) Pull(ctx context.Context, ref string, opts PullOpts) error
- func (runtime *BuildahBackend) PullImageFromRegistry(ctx context.Context, img LegacyImageInterface) error
- func (runtime *BuildahBackend) Push(ctx context.Context, ref string, opts PushOpts) error
- func (runtime *BuildahBackend) RefreshImageObject(ctx context.Context, img LegacyImageInterface) error
- func (runtime *BuildahBackend) RemoveHostDirs(ctx context.Context, mountDir string, dirs []string) error
- func (runtime *BuildahBackend) RemoveImage(ctx context.Context, img LegacyImageInterface) error
- func (runtime *BuildahBackend) RenameImage(ctx context.Context, img LegacyImageInterface, newImageName string, ...) error
- func (runtime *BuildahBackend) Rmi(ctx context.Context, ref string, opts RmiOpts) error
- func (runtime *BuildahBackend) ShouldCleanupDockerfileImage() bool
- func (runtime *BuildahBackend) String() string
- func (runtime *BuildahBackend) Tag(ctx context.Context, ref, newRef string, opts TagOpts) error
- type BuildahBackendOptions
- type CommonOpts
- type ContainerBackend
- type DataArchiveSpec
- type DependencyImportSpec
- type DockerServerBackend
- func (runtime *DockerServerBackend) BuildDockerfile(ctx context.Context, _ []byte, opts BuildDockerfileOpts) (string, error)
- func (runtime *DockerServerBackend) BuildDockerfileStage(ctx context.Context, baseImage string, opts BuildDockerfileStageOptions, ...) (string, error)
- func (runtime *DockerServerBackend) BuildStapelStage(ctx context.Context, baseImage string, opts BuildStapelStageOptions) (string, error)
- func (runtime *DockerServerBackend) CalculateDependencyImportChecksum(ctx context.Context, dependencyImport DependencyImportSpec) (string, error)
- func (runtime *DockerServerBackend) GetImageInfo(ctx context.Context, ref string, opts GetImageInfoOpts) (*image.Info, error)
- func (runtime *DockerServerBackend) GetImageInspect(ctx context.Context, ref string) (*types.ImageInspect, error)
- func (runtime *DockerServerBackend) HasStapelBuildSupport() bool
- func (runtime *DockerServerBackend) IsTargetPlatformSupportedForDockerfile(targetPlatform string) bool
- func (runtime *DockerServerBackend) IsTargetPlatformSupportedForStagedDockerfile(targetPlatform string) bool
- func (runtime *DockerServerBackend) IsTargetPlatformSupportedForStapel(targetPlatform string) bool
- func (runtime *DockerServerBackend) Pull(ctx context.Context, ref string, opts PullOpts) error
- func (runtime *DockerServerBackend) PullImageFromRegistry(ctx context.Context, img LegacyImageInterface) error
- func (runtime *DockerServerBackend) Push(ctx context.Context, ref string, opts PushOpts) error
- func (runtime *DockerServerBackend) PushBuiltImage(ctx context.Context, img LegacyImageInterface) error
- func (runtime *DockerServerBackend) PushImage(ctx context.Context, img LegacyImageInterface) error
- func (runtime *DockerServerBackend) RefreshImageObject(ctx context.Context, img LegacyImageInterface) error
- func (runtime *DockerServerBackend) RemoveHostDirs(ctx context.Context, mountDir string, dirs []string) error
- func (runtime *DockerServerBackend) RemoveImage(ctx context.Context, img LegacyImageInterface) error
- func (runtime *DockerServerBackend) RenameImage(ctx context.Context, img LegacyImageInterface, newImageName string, ...) error
- func (runtime *DockerServerBackend) Rmi(ctx context.Context, ref string, opts RmiOpts) error
- func (runtime *DockerServerBackend) ShouldCleanupDockerfileImage() bool
- func (runtime *DockerServerBackend) String() string
- func (runtime *DockerServerBackend) Tag(ctx context.Context, ref, newRef string, opts TagOpts) error
- func (runtime *DockerServerBackend) TagImageByName(ctx context.Context, img LegacyImageInterface) error
- type GetImageInfoOpts
- type ImageInterface
- type InstructionInterface
- type LegacyBuilderContainer
- type LegacyCommitChangeOptions
- type LegacyContainer
- type LegacyContainerOptions
- type LegacyImageInterface
- type LegacyStageImage
- func (i *LegacyStageImage) Build(ctx context.Context, options BuildOptions) error
- func (i *LegacyStageImage) BuilderContainer() LegacyBuilderContainer
- func (i *LegacyStageImage) BuiltID() string
- func (i *LegacyStageImage) Commit(ctx context.Context) error
- func (i *LegacyStageImage) Container() LegacyContainer
- func (i *LegacyStageImage) GetBuiltID() string
- func (i *LegacyStageImage) GetCopy() LegacyImageInterface
- func (i LegacyStageImage) GetFinalStageDescription() *image.StageDescription
- func (i *LegacyStageImage) GetID() string
- func (i *LegacyStageImage) GetInfo() *image.Info
- func (i LegacyStageImage) GetStageDescription() *image.StageDescription
- func (i *LegacyStageImage) Introspect(ctx context.Context) error
- func (i LegacyStageImage) IsExistsLocally() bool
- func (i *LegacyStageImage) MustGetBuiltID() string
- func (i *LegacyStageImage) MustResetInfo(ctx context.Context) error
- func (i LegacyStageImage) Name() string
- func (i *LegacyStageImage) Pull(ctx context.Context) error
- func (i *LegacyStageImage) Push(ctx context.Context) error
- func (i *LegacyStageImage) SetBuiltID(builtID string)
- func (i *LegacyStageImage) SetCommitChangeOptions(opts LegacyCommitChangeOptions)
- func (i LegacyStageImage) SetFinalStageDescription(stageDesc *image.StageDescription)
- func (i LegacyStageImage) SetInfo(info *image.Info)
- func (i LegacyStageImage) SetName(name string)
- func (i LegacyStageImage) SetStageDescription(stageDesc *image.StageDescription)
- func (i *LegacyStageImage) Tag(ctx context.Context, name string) error
- func (i *LegacyStageImage) TagBuiltImage(ctx context.Context) error
- func (i LegacyStageImage) UnsetInfo()
- type LegacyStageImageBuilderContainer
- func (c *LegacyStageImageBuilderContainer) AddEnv(envs map[string]string)
- func (c *LegacyStageImageBuilderContainer) AddExpose(exposes ...string)
- func (c *LegacyStageImageBuilderContainer) AddLabel(labels map[string]string)
- func (c *LegacyStageImageBuilderContainer) AddRunCommands(commands ...string)
- func (c *LegacyStageImageBuilderContainer) AddServiceRunCommands(commands ...string)
- func (c *LegacyStageImageBuilderContainer) AddVolume(volumes ...string)
- func (c *LegacyStageImageBuilderContainer) AddVolumeFrom(volumesFrom ...string)
- type LegacyStageImageContainer
- func (c *LegacyStageImageContainer) AddRunCommands(commands ...string)
- func (c *LegacyStageImageContainer) AddServiceRunCommands(commands ...string)
- func (c *LegacyStageImageContainer) CommitChangeOptions() LegacyContainerOptions
- func (c *LegacyStageImageContainer) Name() string
- func (c *LegacyStageImageContainer) RunOptions() LegacyContainerOptions
- func (c *LegacyStageImageContainer) ServiceCommitChangeOptions() LegacyContainerOptions
- func (c *LegacyStageImageContainer) UserCommitChanges() []string
- func (c *LegacyStageImageContainer) UserRunCommands() []string
- type LegacyStageImageContainerOptions
- func (co *LegacyStageImageContainerOptions) AddCmd(cmd string)
- func (co *LegacyStageImageContainerOptions) AddEntrypoint(entrypoint string)
- func (co *LegacyStageImageContainerOptions) AddEnv(envs map[string]string)
- func (co *LegacyStageImageContainerOptions) AddExpose(exposes ...string)
- func (co *LegacyStageImageContainerOptions) AddHealthCheck(check string)
- func (co *LegacyStageImageContainerOptions) AddLabel(labels map[string]string)
- func (co *LegacyStageImageContainerOptions) AddUser(user string)
- func (co *LegacyStageImageContainerOptions) AddVolume(volumes ...string)
- func (co *LegacyStageImageContainerOptions) AddVolumeFrom(volumesFrom ...string)
- func (co *LegacyStageImageContainerOptions) AddWorkdir(workdir string)
- type PerfCheckContainerBackend
- func (runtime *PerfCheckContainerBackend) BuildDockerfile(ctx context.Context, dockerfile []byte, opts BuildDockerfileOpts) (resID string, resErr error)
- func (runtime *PerfCheckContainerBackend) BuildDockerfileStage(ctx context.Context, baseImage string, opts BuildDockerfileStageOptions, ...) (resID string, resErr error)
- func (runtime *PerfCheckContainerBackend) BuildStapelStage(ctx context.Context, baseImage string, opts BuildStapelStageOptions) (resID string, resErr error)
- func (runtime *PerfCheckContainerBackend) CalculateDependencyImportChecksum(ctx context.Context, dependencyImport DependencyImportSpec) (resID string, resErr error)
- func (runtime *PerfCheckContainerBackend) GetImageInfo(ctx context.Context, ref string, opts GetImageInfoOpts) (resImg *image.Info, resErr error)
- func (runtime *PerfCheckContainerBackend) HasStapelBuildSupport() bool
- func (runtime *PerfCheckContainerBackend) IsTargetPlatformSupportedForDockerfile(targetPlatform string) bool
- func (runtime *PerfCheckContainerBackend) IsTargetPlatformSupportedForStagedDockerfile(targetPlatform string) bool
- func (runtime *PerfCheckContainerBackend) IsTargetPlatformSupportedForStapel(targetPlatform string) bool
- func (runtime *PerfCheckContainerBackend) Pull(ctx context.Context, ref string, opts PullOpts) (resErr error)
- func (runtime *PerfCheckContainerBackend) PullImageFromRegistry(ctx context.Context, img LegacyImageInterface) (resErr error)
- func (runtime *PerfCheckContainerBackend) Push(ctx context.Context, ref string, opts PushOpts) (resErr error)
- func (runtime *PerfCheckContainerBackend) RefreshImageObject(ctx context.Context, img LegacyImageInterface) (resErr error)
- func (runtime *PerfCheckContainerBackend) RemoveHostDirs(ctx context.Context, mountDir string, dirs []string) (resErr error)
- func (runtime *PerfCheckContainerBackend) RemoveImage(ctx context.Context, img LegacyImageInterface) (resErr error)
- func (runtime *PerfCheckContainerBackend) RenameImage(ctx context.Context, img LegacyImageInterface, newImageName string, ...) (resErr error)
- func (runtime *PerfCheckContainerBackend) Rmi(ctx context.Context, ref string, opts RmiOpts) (resErr error)
- func (runtime *PerfCheckContainerBackend) ShouldCleanupDockerfileImage() bool
- func (runtime *PerfCheckContainerBackend) String() string
- func (runtime *PerfCheckContainerBackend) Tag(ctx context.Context, ref, newRef string, opts TagOpts) (resErr error)
- type PullOpts
- type PushOpts
- type RemoveDataSpec
- type RemoveType
- type RmiOpts
- type TagOpts
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ContainerLockName ¶
func ImageLockName ¶
func IsStartContainerErr ¶
func LogImageInfo ¶
func LogImageInfo(ctx context.Context, img LegacyImageInterface, prevStageImageSize int64)
func LogImageName ¶
func RegisterRunningContainer ¶ added in v1.2.90
func ShelloutPack ¶
func TerminateRunningDockerContainers ¶ added in v1.2.90
func TerminateRunningDockerContainers() error
func UnregisterRunningContainer ¶ added in v1.2.90
func UnregisterRunningContainer(name string)
Types ¶
type AddDataArchiveOptions ¶ added in v1.2.175
type AddDataArchiveOptions struct {
Owner, Group string
}
type ArchiveType ¶ added in v1.2.88
type ArchiveType int
const ( FileArchive ArchiveType = iota DirectoryArchive )
func (ArchiveType) String ¶ added in v1.2.88
func (i ArchiveType) String() string
type BuildContextArchiveCreateOptions ¶ added in v1.2.182
type BuildContextArchiver ¶ added in v1.2.182
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 // TODO: remove this and instead write the []byte dockerfile to /Dockerfile in the ContextTar inDockerServerBackend.BuildDockerfile(). Target string BuildArgs []string // {"key1=value1", "key2=value2", ... } AddHost []string Network string SSH string Labels []string Tags []string }
type BuildDockerfileStageOptions ¶ added in v1.2.178
type BuildDockerfileStageOptions struct { CommonOpts BuildContextArchive BuildContextArchiver }
type BuildOptions ¶
type BuildStapelStageOptions ¶ added in v1.2.84
type BuildStapelStageOptions struct { Labels []string Volumes []string Expose []string Envs map[string]string Cmd []string Entrypoint []string User string Workdir string Healthcheck string BuildVolumes []string Commands []string DataArchiveSpecs []DataArchiveSpec RemoveDataSpecs []RemoveDataSpec DependencyImportSpecs []DependencyImportSpec }
func (*BuildStapelStageOptions) AddBuildVolumes ¶ added in v1.2.84
func (opts *BuildStapelStageOptions) AddBuildVolumes(volumes ...string) BuildStapelStageOptionsInterface
func (*BuildStapelStageOptions) AddCommands ¶ added in v1.2.88
func (opts *BuildStapelStageOptions) AddCommands(commands ...string) BuildStapelStageOptionsInterface
func (*BuildStapelStageOptions) AddDataArchive ¶ added in v1.2.88
func (opts *BuildStapelStageOptions) AddDataArchive(archive io.ReadCloser, archiveType ArchiveType, to string, o AddDataArchiveOptions) BuildStapelStageOptionsInterface
func (*BuildStapelStageOptions) AddDependencyImport ¶ added in v1.2.88
func (opts *BuildStapelStageOptions) AddDependencyImport(imageName, fromPath, toPath string, includePaths, excludePaths []string, owner, group string) BuildStapelStageOptionsInterface
func (*BuildStapelStageOptions) AddEnvs ¶ added in v1.2.85
func (opts *BuildStapelStageOptions) AddEnvs(envs map[string]string) BuildStapelStageOptionsInterface
func (*BuildStapelStageOptions) AddExpose ¶ added in v1.2.85
func (opts *BuildStapelStageOptions) AddExpose(expose []string) BuildStapelStageOptionsInterface
func (*BuildStapelStageOptions) AddLabels ¶ added in v1.2.84
func (opts *BuildStapelStageOptions) AddLabels(labels map[string]string) BuildStapelStageOptionsInterface
func (*BuildStapelStageOptions) AddVolumes ¶ added in v1.2.85
func (opts *BuildStapelStageOptions) AddVolumes(volumes []string) BuildStapelStageOptionsInterface
func (*BuildStapelStageOptions) RemoveData ¶ added in v1.2.88
func (opts *BuildStapelStageOptions) RemoveData(removeType RemoveType, paths, keepParentDirs []string) BuildStapelStageOptionsInterface
func (*BuildStapelStageOptions) SetCmd ¶ added in v1.2.85
func (opts *BuildStapelStageOptions) SetCmd(cmd []string) BuildStapelStageOptionsInterface
func (*BuildStapelStageOptions) SetEntrypoint ¶ added in v1.2.85
func (opts *BuildStapelStageOptions) SetEntrypoint(entrypoint []string) BuildStapelStageOptionsInterface
func (*BuildStapelStageOptions) SetHealthcheck ¶ added in v1.2.85
func (opts *BuildStapelStageOptions) SetHealthcheck(healthcheck string) BuildStapelStageOptionsInterface
func (*BuildStapelStageOptions) SetUser ¶ added in v1.2.85
func (opts *BuildStapelStageOptions) SetUser(user string) BuildStapelStageOptionsInterface
func (*BuildStapelStageOptions) SetWorkdir ¶ added in v1.2.85
func (opts *BuildStapelStageOptions) SetWorkdir(workdir string) BuildStapelStageOptionsInterface
type BuildStapelStageOptionsInterface ¶ added in v1.2.84
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 AddBuildVolumes(volumes ...string) BuildStapelStageOptionsInterface AddCommands(commands ...string) BuildStapelStageOptionsInterface 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 (runtime *BuildahBackend) BuildDockerfile(ctx context.Context, dockerfileContent []byte, opts BuildDockerfileOpts) (string, error)
func (*BuildahBackend) BuildDockerfileStage ¶ added in v1.2.178
func (runtime *BuildahBackend) BuildDockerfileStage(ctx context.Context, baseImage string, opts BuildDockerfileStageOptions, instructions ...InstructionInterface) (string, error)
func (*BuildahBackend) BuildStapelStage ¶
func (runtime *BuildahBackend) BuildStapelStage(ctx context.Context, baseImage string, opts BuildStapelStageOptions) (string, error)
func (*BuildahBackend) CalculateDependencyImportChecksum ¶ added in v1.2.88
func (runtime *BuildahBackend) CalculateDependencyImportChecksum(ctx context.Context, dependencyImport DependencyImportSpec) (string, error)
func (*BuildahBackend) GetImageInfo ¶
func (runtime *BuildahBackend) GetImageInfo(ctx context.Context, ref string, opts GetImageInfoOpts) (*image.Info, error)
GetImageInfo returns nil, nil if image not found.
func (*BuildahBackend) HasStapelBuildSupport ¶
func (runtime *BuildahBackend) HasStapelBuildSupport() bool
func (*BuildahBackend) IsTargetPlatformSupportedForDockerfile ¶ added in v1.2.208
func (runtime *BuildahBackend) IsTargetPlatformSupportedForDockerfile(targetPlatform string) bool
func (*BuildahBackend) IsTargetPlatformSupportedForStagedDockerfile ¶ added in v1.2.208
func (runtime *BuildahBackend) IsTargetPlatformSupportedForStagedDockerfile(targetPlatform string) bool
func (*BuildahBackend) IsTargetPlatformSupportedForStapel ¶ added in v1.2.208
func (runtime *BuildahBackend) IsTargetPlatformSupportedForStapel(targetPlatform string) bool
func (*BuildahBackend) PullImageFromRegistry ¶
func (runtime *BuildahBackend) PullImageFromRegistry(ctx context.Context, img LegacyImageInterface) error
func (*BuildahBackend) RefreshImageObject ¶
func (runtime *BuildahBackend) RefreshImageObject(ctx context.Context, img LegacyImageInterface) error
func (*BuildahBackend) RemoveHostDirs ¶ added in v1.2.117
func (*BuildahBackend) RemoveImage ¶
func (runtime *BuildahBackend) RemoveImage(ctx context.Context, img LegacyImageInterface) error
func (*BuildahBackend) RenameImage ¶
func (runtime *BuildahBackend) RenameImage(ctx context.Context, img LegacyImageInterface, newImageName string, removeOldName bool) error
func (*BuildahBackend) ShouldCleanupDockerfileImage ¶ added in v1.2.108
func (runtime *BuildahBackend) ShouldCleanupDockerfileImage() bool
func (*BuildahBackend) String ¶
func (runtime *BuildahBackend) String() string
type BuildahBackendOptions ¶ added in v1.2.104
type BuildahBackendOptions struct {
TmpDir string
}
type CommonOpts ¶
type CommonOpts struct{}
type ContainerBackend ¶
type ContainerBackend interface { 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 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) (string, error) HasStapelBuildSupport() bool IsTargetPlatformSupportedForStapel(targetPlatform string) bool IsTargetPlatformSupportedForStagedDockerfile(targetPlatform string) bool IsTargetPlatformSupportedForDockerfile(targetPlatform string) bool 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 ShouldCleanupDockerfileImage() bool 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 }
type DataArchiveSpec ¶ added in v1.2.88
type DataArchiveSpec struct { Archive io.ReadCloser Type ArchiveType To string Owner, Group string }
type DependencyImportSpec ¶ added in v1.2.88
type DockerServerBackend ¶
type DockerServerBackend struct{}
func NewDockerServerBackend ¶
func NewDockerServerBackend() *DockerServerBackend
func (*DockerServerBackend) BuildDockerfile ¶
func (runtime *DockerServerBackend) BuildDockerfile(ctx context.Context, _ []byte, opts BuildDockerfileOpts) (string, error)
func (*DockerServerBackend) BuildDockerfileStage ¶ added in v1.2.178
func (runtime *DockerServerBackend) BuildDockerfileStage(ctx context.Context, baseImage string, opts BuildDockerfileStageOptions, instructions ...InstructionInterface) (string, error)
func (*DockerServerBackend) BuildStapelStage ¶
func (runtime *DockerServerBackend) BuildStapelStage(ctx context.Context, baseImage string, opts BuildStapelStageOptions) (string, error)
func (*DockerServerBackend) CalculateDependencyImportChecksum ¶ added in v1.2.88
func (runtime *DockerServerBackend) CalculateDependencyImportChecksum(ctx context.Context, dependencyImport DependencyImportSpec) (string, error)
func (*DockerServerBackend) GetImageInfo ¶
func (runtime *DockerServerBackend) GetImageInfo(ctx context.Context, ref string, opts GetImageInfoOpts) (*image.Info, error)
func (*DockerServerBackend) GetImageInspect ¶
func (runtime *DockerServerBackend) GetImageInspect(ctx context.Context, ref string) (*types.ImageInspect, error)
GetImageInspect only available for DockerServerBackend
func (*DockerServerBackend) HasStapelBuildSupport ¶
func (runtime *DockerServerBackend) HasStapelBuildSupport() bool
func (*DockerServerBackend) IsTargetPlatformSupportedForDockerfile ¶ added in v1.2.208
func (runtime *DockerServerBackend) IsTargetPlatformSupportedForDockerfile(targetPlatform string) bool
func (*DockerServerBackend) IsTargetPlatformSupportedForStagedDockerfile ¶ added in v1.2.208
func (runtime *DockerServerBackend) IsTargetPlatformSupportedForStagedDockerfile(targetPlatform string) bool
func (*DockerServerBackend) IsTargetPlatformSupportedForStapel ¶ added in v1.2.208
func (runtime *DockerServerBackend) IsTargetPlatformSupportedForStapel(targetPlatform string) bool
func (*DockerServerBackend) PullImageFromRegistry ¶
func (runtime *DockerServerBackend) PullImageFromRegistry(ctx context.Context, img LegacyImageInterface) error
func (*DockerServerBackend) PushBuiltImage ¶
func (runtime *DockerServerBackend) PushBuiltImage(ctx context.Context, img LegacyImageInterface) error
PushBuiltImage is only available for DockerServerBackend
func (*DockerServerBackend) PushImage ¶
func (runtime *DockerServerBackend) PushImage(ctx context.Context, img LegacyImageInterface) error
func (*DockerServerBackend) RefreshImageObject ¶
func (runtime *DockerServerBackend) RefreshImageObject(ctx context.Context, img LegacyImageInterface) error
func (*DockerServerBackend) RemoveHostDirs ¶ added in v1.2.117
func (*DockerServerBackend) RemoveImage ¶
func (runtime *DockerServerBackend) RemoveImage(ctx context.Context, img LegacyImageInterface) error
func (*DockerServerBackend) RenameImage ¶
func (runtime *DockerServerBackend) RenameImage(ctx context.Context, img LegacyImageInterface, newImageName string, removeOldName bool) error
func (*DockerServerBackend) ShouldCleanupDockerfileImage ¶ added in v1.2.108
func (runtime *DockerServerBackend) ShouldCleanupDockerfileImage() bool
ShouldCleanupDockerfileImage for docker-server backend we should cleanup image built from dockerfrom tagged with tempID which is implementation detail of the BuildDockerfile.
func (*DockerServerBackend) String ¶
func (runtime *DockerServerBackend) String() string
func (*DockerServerBackend) TagImageByName ¶
func (runtime *DockerServerBackend) TagImageByName(ctx context.Context, img LegacyImageInterface) error
TagBuiltImageByName is only available for DockerServerBackend
type GetImageInfoOpts ¶
type GetImageInfoOpts struct {
CommonOpts
}
type ImageInterface ¶
type InstructionInterface ¶ added in v1.2.178
type LegacyBuilderContainer ¶
type LegacyCommitChangeOptions ¶ added in v1.2.118
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) }
type LegacyImageInterface ¶
type LegacyImageInterface interface { Name() string SetName(name string) Pull(ctx context.Context) error Push(ctx context.Context) error // 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) GetBuiltID() string BuiltID() string TagBuiltImage(ctx context.Context) error Introspect(ctx context.Context) error SetInfo(info *image.Info) IsExistsLocally() bool SetStageDescription(stage *image.StageDescription) GetStageDescription() *image.StageDescription GetFinalStageDescription() *image.StageDescription SetFinalStageDescription(stage *image.StageDescription) GetCopy() LegacyImageInterface }
type LegacyStageImage ¶
type LegacyStageImage struct {
// contains filtered or unexported fields
}
func NewLegacyStageImage ¶
func NewLegacyStageImage(fromImage *LegacyStageImage, name string, containerBackend ContainerBackend) *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) Container ¶
func (i *LegacyStageImage) Container() LegacyContainer
func (*LegacyStageImage) GetBuiltID ¶
func (i *LegacyStageImage) GetBuiltID() string
func (*LegacyStageImage) GetCopy ¶ added in v1.2.107
func (i *LegacyStageImage) GetCopy() LegacyImageInterface
func (LegacyStageImage) GetFinalStageDescription ¶ added in v1.2.192
func (i LegacyStageImage) GetFinalStageDescription() *image.StageDescription
func (*LegacyStageImage) GetID ¶
func (i *LegacyStageImage) GetID() string
func (*LegacyStageImage) GetInfo ¶
func (i *LegacyStageImage) GetInfo() *image.Info
func (LegacyStageImage) GetStageDescription ¶
func (i LegacyStageImage) GetStageDescription() *image.StageDescription
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) SetBuiltID ¶
func (i *LegacyStageImage) SetBuiltID(builtID string)
func (*LegacyStageImage) SetCommitChangeOptions ¶ added in v1.2.118
func (i *LegacyStageImage) SetCommitChangeOptions(opts LegacyCommitChangeOptions)
func (LegacyStageImage) SetFinalStageDescription ¶ added in v1.2.192
func (i LegacyStageImage) SetFinalStageDescription(stageDesc *image.StageDescription)
func (LegacyStageImage) SetStageDescription ¶
func (i LegacyStageImage) SetStageDescription(stageDesc *image.StageDescription)
func (*LegacyStageImage) Tag ¶
func (i *LegacyStageImage) Tag(ctx context.Context, name string) error
func (*LegacyStageImage) TagBuiltImage ¶
func (i *LegacyStageImage) TagBuiltImage(ctx context.Context) error
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)
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 // 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) 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 ¶ added in v1.2.178
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 ¶ added in v1.2.88
func (runtime *PerfCheckContainerBackend) CalculateDependencyImportChecksum(ctx context.Context, dependencyImport DependencyImportSpec) (resID string, resErr error)
func (*PerfCheckContainerBackend) GetImageInfo ¶
func (runtime *PerfCheckContainerBackend) GetImageInfo(ctx context.Context, ref string, opts GetImageInfoOpts) (resImg *image.Info, resErr error)
func (*PerfCheckContainerBackend) HasStapelBuildSupport ¶
func (runtime *PerfCheckContainerBackend) HasStapelBuildSupport() bool
func (*PerfCheckContainerBackend) IsTargetPlatformSupportedForDockerfile ¶ added in v1.2.208
func (runtime *PerfCheckContainerBackend) IsTargetPlatformSupportedForDockerfile(targetPlatform string) bool
func (*PerfCheckContainerBackend) IsTargetPlatformSupportedForStagedDockerfile ¶ added in v1.2.208
func (runtime *PerfCheckContainerBackend) IsTargetPlatformSupportedForStagedDockerfile(targetPlatform string) bool
func (*PerfCheckContainerBackend) IsTargetPlatformSupportedForStapel ¶ added in v1.2.208
func (runtime *PerfCheckContainerBackend) IsTargetPlatformSupportedForStapel(targetPlatform string) bool
func (*PerfCheckContainerBackend) PullImageFromRegistry ¶
func (runtime *PerfCheckContainerBackend) PullImageFromRegistry(ctx context.Context, img LegacyImageInterface) (resErr error)
func (*PerfCheckContainerBackend) RefreshImageObject ¶
func (runtime *PerfCheckContainerBackend) RefreshImageObject(ctx context.Context, img LegacyImageInterface) (resErr error)
func (*PerfCheckContainerBackend) RemoveHostDirs ¶ added in v1.2.117
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) ShouldCleanupDockerfileImage ¶ added in v1.2.108
func (runtime *PerfCheckContainerBackend) ShouldCleanupDockerfileImage() bool
func (*PerfCheckContainerBackend) String ¶
func (runtime *PerfCheckContainerBackend) String() string
type PullOpts ¶
type PullOpts struct {
CommonOpts
}
type PushOpts ¶
type PushOpts struct {
CommonOpts
}
type RemoveDataSpec ¶ added in v1.2.88
type RemoveDataSpec struct { Type RemoveType Paths []string KeepParentDirs []string }
type RemoveType ¶ added in v1.2.88
type RemoveType int
const ( RemoveExactPath RemoveType = iota RemoveExactPathWithEmptyParentDirs RemoveInsidePath )
func (RemoveType) String ¶ added in v1.2.88
func (i RemoveType) String() string
type RmiOpts ¶
type RmiOpts struct {
CommonOpts
}
type TagOpts ¶
type TagOpts struct {
CommonOpts
}
Source Files ¶
- archive_interface.go
- archivetype_string.go
- build_stapel_stage_options.go
- buildah_backend.go
- docker_running_containers.go
- docker_server_backend.go
- file_utils.go
- image_interface.go
- instruction.go
- interface.go
- legacy_base_image.go
- legacy_interface.go
- legacy_stage_image.go
- legacy_stage_image_builder_container.go
- legacy_stage_image_container.go
- legacy_stage_image_container_options.go
- lock.go
- perf_check_container_backend.go
- removetype_string.go
- utils.go
Click to show internal directories.
Click to hide internal directories.