stage

package
v3.8.0 Latest Latest
Warning

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

 Go to latest Published: Oct 9, 2026 License: Apache-2.0 Imports: 48 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var AllStages = []StageName{
	From,
	BeforeInstall,
	DependenciesBeforeInstall,
	GitArchive,
	Install,
	DependenciesAfterInstall,
	BeforeSetup,
	DependenciesBeforeSetup,
	Setup,
	DependenciesAfterSetup,
	GitCache,
	GitLatestPatch,

	Dockerfile,
	ImageSpec,
}
View Source 
var ErrInvalidBaseImage = errors.New("invalid base image")

Functions

func GetDependenciesArgsKeys 

func GetDependenciesArgsKeys(dependencies []*config.Dependency) (res []string)

func IsErrInvalidBaseImage 

func IsErrInvalidBaseImage(err error) bool

func ResolveDependenciesArgs 

func ResolveDependenciesArgs(targetPlatform string, dependencies []*config.Dependency, c Conveyor) map[string]string

func ResolveDependenciesArgsForContent 

func ResolveDependenciesArgsForContent(dependencies []*config.Dependency) map[string]string

ResolveDependenciesArgsForContent resolves dependency build args to stable placeholders derived from the dependency image name, for use in content digests. The real values (ResolveDependenciesArgs) carry the built image name, tag and registry digest, all of which change on every rebuild of the dependency image.

Types

type BaseStage 

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

func NewBaseStage 

func NewBaseStage(name StageName, options *BaseStageOptions) *BaseStage

func (*BaseStage) ExpandDependencies 

func (s *BaseStage) ExpandDependencies(ctx context.Context, c Conveyor, baseEnv map[string]string) error

func (*BaseStage) FetchDependencies 

func (s *BaseStage) FetchDependencies(_ context.Context, _ Conveyor, _ container_backend.ContainerBackend, _ docker_registry.GenericApiInterface) error

func (*BaseStage) GetContentDependencies 

func (s *BaseStage) GetContentDependencies(ctx context.Context, c Conveyor, buildContextArchive container_backend.BuildContextArchiver) (string, error)

func (*BaseStage) GetContentDigest 

func (s *BaseStage) GetContentDigest() string

func (*BaseStage) GetDependencies 

func (s *BaseStage) GetDependencies(ctx context.Context, c Conveyor, cb container_backend.ContainerBackend, prevImage, prevBuiltImage *StageImage, buildContextArchive container_backend.BuildContextArchiver) (string, error)

func (*BaseStage) GetDigest 

func (s *BaseStage) GetDigest() string

func (*BaseStage) GetGitMappings 

func (s *BaseStage) GetGitMappings() []*GitMapping

func (*BaseStage) GetMeta 

func (s *BaseStage) GetMeta() *StageMeta

func (*BaseStage) GetNextStageDependencies 

func (s *BaseStage) GetNextStageDependencies(_ context.Context, _ Conveyor) (string, error)

func (*BaseStage) GetStageImage 

func (s *BaseStage) GetStageImage() *StageImage

func (*BaseStage) HasPrevStage 

func (s *BaseStage) HasPrevStage() bool

func (*BaseStage) ImageName 

func (s *BaseStage) ImageName() string

func (*BaseStage) IsBuildable 

func (s *BaseStage) IsBuildable() bool

func (*BaseStage) IsContentAnchor 

func (s *BaseStage) IsContentAnchor() bool

func (*BaseStage) IsEmpty 

func (s *BaseStage) IsEmpty(_ context.Context, _ Conveyor, _ *StageImage) (bool, error)

func (*BaseStage) IsMutable 

func (s *BaseStage) IsMutable() bool

func (*BaseStage) IsStapelStage 

func (s *BaseStage) IsStapelStage() bool

func (*BaseStage) LogDetailedName 

func (s *BaseStage) LogDetailedName() string

func (*BaseStage) LogName 

func (s *BaseStage) LogName() string

func (*BaseStage) MutateImage 

func (s *BaseStage) MutateImage(_ context.Context, _ ImageMutatorPusher, _, _ *StageImage) error

func (*BaseStage) Name 

func (s *BaseStage) Name() StageName

func (*BaseStage) PreRun 

func (s *BaseStage) PreRun(_ context.Context, _ Conveyor) error

func (*BaseStage) PrepareImage 

func (s *BaseStage) PrepareImage(ctx context.Context, c Conveyor, cb container_backend.ContainerBackend, prevBuiltImage, stageImage *StageImage, buildContextArchive container_backend.BuildContextArchiver) error

func (*BaseStage) SelectSuitableStageDesc 

func (s *BaseStage) SelectSuitableStageDesc(ctx context.Context, c Conveyor, stageDescSet image.StageDescSet) (*image.StageDesc, error)

func (*BaseStage) SetContentAnchor 

func (s *BaseStage) SetContentAnchor(v bool)

func (*BaseStage) SetContentDigest 

func (s *BaseStage) SetContentDigest(contentDigest string)

func (*BaseStage) SetDigest 

func (s *BaseStage) SetDigest(digest string)

func (*BaseStage) SetGitMappings 

func (s *BaseStage) SetGitMappings(gitMappings []*GitMapping)

func (*BaseStage) SetMeta 

func (s *BaseStage) SetMeta(meta *StageMeta)

func (*BaseStage) SetStageImage 

func (s *BaseStage) SetStageImage(stageImage *StageImage)

func (*BaseStage) TargetPlatform 

func (s *BaseStage) TargetPlatform() string

func (*BaseStage) UsesBuildContext 

func (s *BaseStage) UsesBuildContext() bool

type BaseStageOptions 

type BaseStageOptions struct {
	LogName           string
	TargetPlatform    string
	ImageName         string
	ImageCacheVersion string
	ConfigMounts      []*config.Mount
	ImageTmpDir       string
	ContainerWerfDir  string
	ProjectName       string
	Network           string
}

type BeforeInstallStage 

type BeforeInstallStage struct {
	*UserStage
}

func GenerateBeforeInstallStage 

func GenerateBeforeInstallStage(ctx context.Context, imageBaseConfig *config.StapelImageBase, baseStageOptions *BaseStageOptions) *BeforeInstallStage

func (*BeforeInstallStage) GetContentDependencies 

func (s *BeforeInstallStage) GetContentDependencies(ctx context.Context, c Conveyor, buildContextArchive container_backend.BuildContextArchiver) (string, error)

func (*BeforeInstallStage) GetDependencies 

func (s *BeforeInstallStage) GetDependencies(ctx context.Context, c Conveyor, cb container_backend.ContainerBackend, prevImage, prevBuiltImage *StageImage, buildContextArchive container_backend.BuildContextArchiver) (string, error)

func (*BeforeInstallStage) PrepareImage 

func (s *BeforeInstallStage) PrepareImage(ctx context.Context, c Conveyor, cb container_backend.ContainerBackend, prevBuiltImage, stageImage *StageImage, buildContextArchive container_backend.BuildContextArchiver) error

type BeforeSetupStage 

type BeforeSetupStage struct {
	*UserWithGitPatchStage
}

func GenerateBeforeSetupStage 

func GenerateBeforeSetupStage(ctx context.Context, imageBaseConfig *config.StapelImageBase, gitPatchStageOptions *NewGitPatchStageOptions, baseStageOptions *BaseStageOptions) *BeforeSetupStage

func (*BeforeSetupStage) GetDependencies 

func (s *BeforeSetupStage) GetDependencies(ctx context.Context, c Conveyor, cb container_backend.ContainerBackend, prevImage, prevBuiltImage *StageImage, buildContextArchive container_backend.BuildContextArchiver) (string, error)

func (*BeforeSetupStage) PrepareImage 

func (s *BeforeSetupStage) PrepareImage(ctx context.Context, c Conveyor, cb container_backend.ContainerBackend, prevBuiltImage, stageImage *StageImage, buildContextArchive container_backend.BuildContextArchiver) error

type ContainerBackendStub 

type ContainerBackendStub struct {
	container_backend.ContainerBackend
	// contains filtered or unexported fields
}

func NewContainerBackendStub 

func NewContainerBackendStub() *ContainerBackendStub

func (*ContainerBackendStub) GetImageInfo 

func (containerBackend *ContainerBackendStub) GetImageInfo(ctx context.Context, ref string, opts container_backend.GetImageInfoOpts) (*image.Info, error)

func (*ContainerBackendStub) HasContainerRootMountSupport 

func (containerBackend *ContainerBackendStub) HasContainerRootMountSupport() bool

func (*ContainerBackendStub) Pull 

func (containerBackend *ContainerBackendStub) Pull(ctx context.Context, ref string, opts container_backend.PullOpts) error

type ContainerFileDescriptor 

type ContainerFileDescriptor struct {
	FilePath          string
	ContainerFilePath string
}

func (*ContainerFileDescriptor) Open 

func (f *ContainerFileDescriptor) Open(flag int, perm os.FileMode) (*os.File, error)

type ContextChecksum 

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

func NewContextChecksum 

func NewContextChecksum(dockerignorePathMatcher path_matcher.PathMatcher) *ContextChecksum

type Conveyor 

type Conveyor interface {
	GetImageContentTagStageID(targetPlatform, imageName string) string
	GetImageContentTagDigest(targetPlatform, imageName string) string
	GetImageContentTagName(targetPlatform, imageName string) string

	GetImportServer(ctx context.Context, targetPlatform, imageName string, fromExternalImage bool) (import_server.ImportServer, error)

	GiterminismManager() giterminism_manager.Interface

	UseLegacyStapelBuilder(cb container_backend.ContainerBackend) bool
}

type ConveyorStub 

type ConveyorStub struct {
	Conveyor
	// contains filtered or unexported fields
}

func NewConveyorStub 

func NewConveyorStub(giterminismManager *GiterminismManagerStub, lastStageImageNameByImageName, lastStageImageDigestByImageName map[string]string) *ConveyorStub

func (*ConveyorStub) GetImageContentTagDigest 

func (c *ConveyorStub) GetImageContentTagDigest(targetPlatform, imageName string) string

func (*ConveyorStub) GetImageContentTagName 

func (c *ConveyorStub) GetImageContentTagName(targetPlatform, imageName string) string

func (*ConveyorStub) GetImageContentTagStageID 

func (c *ConveyorStub) GetImageContentTagStageID(targetPlatform, imageName string) string

func (*ConveyorStub) GiterminismManager 

func (c *ConveyorStub) GiterminismManager() giterminism_manager.Interface

func (*ConveyorStub) UseLegacyStapelBuilder 

func (c *ConveyorStub) UseLegacyStapelBuilder(cr container_backend.ContainerBackend) bool

type DependenciesAfterInstallStage 

type DependenciesAfterInstallStage struct {
	*DependenciesStage
}

func GenerateDependenciesAfterInstallStage 

func GenerateDependenciesAfterInstallStage(imageBaseConfig *config.StapelImageBase, baseStageOptions *BaseStageOptions) *DependenciesAfterInstallStage

type DependenciesAfterSetupStage 

type DependenciesAfterSetupStage struct {
	*DependenciesStage
}

func GenerateDependenciesAfterSetupStage 

func GenerateDependenciesAfterSetupStage(imageBaseConfig *config.StapelImageBase, baseStageOptions *BaseStageOptions) *DependenciesAfterSetupStage

type DependenciesBeforeInstallStage 

type DependenciesBeforeInstallStage struct {
	*DependenciesStage
}

func GenerateDependenciesBeforeInstallStage 

func GenerateDependenciesBeforeInstallStage(imageBaseConfig *config.StapelImageBase, baseStageOptions *BaseStageOptions) *DependenciesBeforeInstallStage

type DependenciesBeforeSetupStage 

type DependenciesBeforeSetupStage struct {
	*DependenciesStage
}

func GenerateDependenciesBeforeSetupStage 

func GenerateDependenciesBeforeSetupStage(imageBaseConfig *config.StapelImageBase, baseStageOptions *BaseStageOptions) *DependenciesBeforeSetupStage

type DependenciesStage 

type DependenciesStage struct {
	*BaseStage
	// contains filtered or unexported fields
}

func (*DependenciesStage) GetContentDependencies 

func (s *DependenciesStage) GetContentDependencies(_ context.Context, _ Conveyor, _ container_backend.BuildContextArchiver) (string, error)

GetContentDependencies identifies source and dependency images by their config names instead of their built stage IDs: the content of those images is folded into the anchor digest as a dependency input, and a stage ID changes on every rebuild of the referenced image.

func (*DependenciesStage) GetDependencies 

func (s *DependenciesStage) GetDependencies(ctx context.Context, c Conveyor, _ container_backend.ContainerBackend, _, _ *StageImage, _ container_backend.BuildContextArchiver) (string, error)

func (*DependenciesStage) PrepareImage 

func (s *DependenciesStage) PrepareImage(ctx context.Context, c Conveyor, cb container_backend.ContainerBackend, prevBuiltImage, stageImage *StageImage, buildContextArchive container_backend.BuildContextArchiver) error

type DockerRegistryApiStub 

type DockerRegistryApiStub struct {
	docker_registry.GenericApiInterface
}

func NewDockerRegistryApiStub 

func NewDockerRegistryApiStub() *DockerRegistryApiStub

func (*DockerRegistryApiStub) GetRepoImageConfigFile 

func (dockerRegistry *DockerRegistryApiStub) GetRepoImageConfigFile(ctx context.Context, reference string) (*v1.ConfigFile, error)

type DockerRunArgs 

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

func NewDockerRunArgs 

func NewDockerRunArgs(dockerfile []byte, dockerfilePath, target, context string, contextAddFiles []string, buildArgs map[string]interface{}, addHost []string, ssh string, secrets []string) *DockerRunArgs

type DockerStages 

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

func NewDockerStages 

func NewDockerStages(dockerStages []instructions.Stage, dockerBuildArgsHash map[string]string, dockerMetaArgs []instructions.ArgCommand, dockerTargetStageIndex int) *DockerStages

func (*DockerStages) AddDockerStageEnv 

func (ds *DockerStages) AddDockerStageEnv(dockerStageID int, key, value string) (string, string, error)

func (*DockerStages) DockerStageArgsHash 

func (ds *DockerStages) DockerStageArgsHash(dockerStageID int) map[string]string

func (*DockerStages) DockerStageEnvs 

func (ds *DockerStages) DockerStageEnvs(dockerStageID int) map[string]string

func (*DockerStages) ShlexProcessWordWithMetaArgs 

func (ds *DockerStages) ShlexProcessWordWithMetaArgs(value string, resolvedDockerMetaArgsHash map[string]string) (string, error)

func (*DockerStages) ShlexProcessWordWithStageArgsAndEnvs 

func (ds *DockerStages) ShlexProcessWordWithStageArgsAndEnvs(dockerStageID int, value string) (string, error)

func (*DockerStages) ShlexProcessWordWithStageEnvs 

func (ds *DockerStages) ShlexProcessWordWithStageEnvs(dockerStageID int, value string) (string, error)

type FromStage 

type FromStage struct {
	*BaseStage
	// contains filtered or unexported fields
}

func GenerateFromStage 

func GenerateFromStage(imageBaseConfig *config.StapelImageBase, baseImageRepoId, imageCacheVersion string, baseStageOptions *BaseStageOptions) *FromStage

func (*FromStage) GetContentDependencies 

func (s *FromStage) GetContentDependencies(_ context.Context, _ Conveyor, _ container_backend.BuildContextArchiver) (string, error)

GetContentDependencies identifies the base image by its config name instead of its built stage ID: the base image's own content is folded into the anchor digest as a dependency input, and the stage ID changes on every rebuild.

func (*FromStage) GetDependencies 

func (s *FromStage) GetDependencies(_ context.Context, c Conveyor, _ container_backend.ContainerBackend, _, _ *StageImage, _ container_backend.BuildContextArchiver) (string, error)

func (*FromStage) HasPrevStage 

func (s *FromStage) HasPrevStage() bool

func (*FromStage) IsBuildable 

func (s *FromStage) IsBuildable() bool

func (*FromStage) IsMutable 

func (s *FromStage) IsMutable() bool

func (*FromStage) MutateImage 

func (s *FromStage) MutateImage(ctx context.Context, storage ImageMutatorPusher, prevBuiltImage, stageImage *StageImage) error

func (*FromStage) PrepareImage 

func (s *FromStage) PrepareImage(ctx context.Context, c Conveyor, cb container_backend.ContainerBackend, prevBuiltImage, stageImage *StageImage, _ container_backend.BuildContextArchiver) error

type FullDockerfileStage 

type FullDockerfileStage struct {
	*DockerRunArgs
	*DockerStages
	*ContextChecksum
	*BaseStage
	// contains filtered or unexported fields
}

func GenerateFullDockerfileStage 

func GenerateFullDockerfileStage(dockerRunArgs *DockerRunArgs, dockerStages *DockerStages, contextChecksum *ContextChecksum, baseStageOptions *BaseStageOptions, dependencies []*config.Dependency, imageCacheVersion string) *FullDockerfileStage

func (*FullDockerfileStage) FetchDependencies 

func (s *FullDockerfileStage) FetchDependencies(_ context.Context, _ Conveyor, _ container_backend.ContainerBackend, _ docker_registry.GenericApiInterface) error

func (*FullDockerfileStage) GetContentDependencies 

func (s *FullDockerfileStage) GetContentDependencies(ctx context.Context, c Conveyor, _ container_backend.BuildContextArchiver) (string, error)

GetContentDependencies resolves dependency build args to stable placeholders instead of the built image names, tags and registry digests of the dependency images: their content is folded into the anchor digest as a dependency input, and those values change on every rebuild of the dependency image.

func (*FullDockerfileStage) GetDependencies 

func (s *FullDockerfileStage) GetDependencies(ctx context.Context, c Conveyor, _ container_backend.ContainerBackend, _, _ *StageImage, _ container_backend.BuildContextArchiver) (string, error)

func (*FullDockerfileStage) HasPrevStage 

func (s *FullDockerfileStage) HasPrevStage() bool

func (*FullDockerfileStage) IsStapelStage 

func (s *FullDockerfileStage) IsStapelStage() bool

func (*FullDockerfileStage) MutateImage 

func (s *FullDockerfileStage) MutateImage(_ context.Context, _ ImageMutatorPusher, _, _ *StageImage) error

func (*FullDockerfileStage) PrepareImage 

func (s *FullDockerfileStage) PrepareImage(ctx context.Context, c Conveyor, cb container_backend.ContainerBackend, prevBuiltImage, stageImage *StageImage, buildContextArchive container_backend.BuildContextArchiver) error

func (*FullDockerfileStage) SetupDockerImageBuilder 

func (s *FullDockerfileStage) SetupDockerImageBuilder(b stage_builder.DockerfileBuilderInterface, c Conveyor) error

func (*FullDockerfileStage) UsesBuildContext 

func (s *FullDockerfileStage) UsesBuildContext() bool

type GitArchiveStage 

type GitArchiveStage struct {
	*GitStage

	ArchivesDir          string
	ScriptsDir           string
	ContainerArchivesDir string
	ContainerScriptsDir  string
}

func NewGitArchiveStage 

func NewGitArchiveStage(gitArchiveStageOptions *NewGitArchiveStageOptions, baseStageOptions *BaseStageOptions) *GitArchiveStage

func (*GitArchiveStage) GetContentDependencies 

func (s *GitArchiveStage) GetContentDependencies(ctx context.Context, c Conveyor, buildContextArchive container_backend.BuildContextArchiver) (string, error)

GetContentDependencies checksums all git-tracked files for the content digest. This is the only git stage that contributes file content: GitCache and GitLatestPatch return empty context dependencies because their file changes are already covered here.

func (*GitArchiveStage) GetDependencies 

func (s *GitArchiveStage) GetDependencies(ctx context.Context, c Conveyor, cb container_backend.ContainerBackend, prevImage, prevBuiltImage *StageImage, buildContextArchive container_backend.BuildContextArchiver) (string, error)

TODO: 1.3 add git mapping type (dir, file, ...) to gitArchive stage digest

func (*GitArchiveStage) GetNextStageDependencies 

func (s *GitArchiveStage) GetNextStageDependencies(ctx context.Context, c Conveyor) (string, error)

func (*GitArchiveStage) IsEmpty 

func (s *GitArchiveStage) IsEmpty(ctx context.Context, c Conveyor, stageImage *StageImage) (bool, error)

func (*GitArchiveStage) PrepareImage 

func (s *GitArchiveStage) PrepareImage(ctx context.Context, c Conveyor, cb container_backend.ContainerBackend, prevBuiltImage, stageImage *StageImage, buildContextArchive container_backend.BuildContextArchiver) error

type GitCacheStage 

type GitCacheStage struct {
	*GitPatchStage
}

func NewGitCacheStage 

func NewGitCacheStage(gitPatchStageOptions *NewGitPatchStageOptions, baseStageOptions *BaseStageOptions) *GitCacheStage

func (*GitCacheStage) GetContentDependencies 

func (s *GitCacheStage) GetContentDependencies(ctx context.Context, c Conveyor, buildContextArchive container_backend.BuildContextArchiver) (string, error)

GetContentDependencies returns empty: all git file content is already checksummed by GitArchiveStage.GetContentDependencies.

func (*GitCacheStage) GetDependencies 

func (s *GitCacheStage) GetDependencies(ctx context.Context, c Conveyor, cb container_backend.ContainerBackend, prevImage, prevBuiltImage *StageImage, buildContextArchive container_backend.BuildContextArchiver) (string, error)

func (*GitCacheStage) GetNextStageDependencies 

func (s *GitCacheStage) GetNextStageDependencies(ctx context.Context, c Conveyor) (string, error)

func (*GitCacheStage) IsEmpty 

func (s *GitCacheStage) IsEmpty(ctx context.Context, c Conveyor, prevBuiltImage *StageImage) (bool, error)

type GitLatestPatchStage 

type GitLatestPatchStage struct {
	*GitPatchStage
}

func NewGitLatestPatchStage 

func NewGitLatestPatchStage(gitPatchStageOptions *NewGitPatchStageOptions, baseStageOptions *BaseStageOptions) *GitLatestPatchStage

func (*GitLatestPatchStage) GetContentDependencies 

func (s *GitLatestPatchStage) GetContentDependencies(ctx context.Context, c Conveyor, buildContextArchive container_backend.BuildContextArchiver) (string, error)

GetContentDependencies returns empty: all git file content is already checksummed by GitArchiveStage.GetContentDependencies.

func (*GitLatestPatchStage) GetDependencies 

func (s *GitLatestPatchStage) GetDependencies(ctx context.Context, c Conveyor, cb container_backend.ContainerBackend, prevImage, prevBuiltImage *StageImage, buildContextArchive container_backend.BuildContextArchiver) (string, error)

func (*GitLatestPatchStage) GetNextStageDependencies 

func (s *GitLatestPatchStage) GetNextStageDependencies(ctx context.Context, c Conveyor) (string, error)

func (*GitLatestPatchStage) IsEmpty 

func (s *GitLatestPatchStage) IsEmpty(ctx context.Context, c Conveyor, prevBuiltImage *StageImage) (bool, error)

IsEmpty for a content anchor is always false: even when the git patch is empty, the stage must still publish under the image content tag, so it goes through the normal build+push path (buildStage adds a UI note).

func (*GitLatestPatchStage) IsGitPatchEmpty 

func (s *GitLatestPatchStage) IsGitPatchEmpty(ctx context.Context, c Conveyor, prevBuiltImage *StageImage) (bool, error)

type GitMapping 

type GitMapping struct {
	Name               string
	As                 string
	Branch             string
	Tag                string
	Commit             string
	Add                string
	To                 string
	Owner              string
	Group              string
	IncludePaths       []string
	ExcludePaths       []string
	StagesDependencies map[StageName][]string

	ContainerPatchesDir  string
	ContainerArchivesDir string
	ScriptsDir           string
	ContainerScriptsDir  string

	BaseCommitByPrevBuiltImageName map[string]string
	// contains filtered or unexported fields
}

func NewGitMapping 

func NewGitMapping() *GitMapping

func (*GitMapping) AddGitCommitToImageLabels 

func (gm *GitMapping) AddGitCommitToImageLabels(ctx context.Context, c Conveyor, cb container_backend.ContainerBackend, stageImage *StageImage, commitInfo ImageCommitInfo)

func (*GitMapping) GetBaseCommitForPrevBuiltImage 

func (gm *GitMapping) GetBaseCommitForPrevBuiltImage(ctx context.Context, c Conveyor, prevBuiltImage *StageImage) (string, error)

func (*GitMapping) GetBuiltImageCommitInfo 

func (gm *GitMapping) GetBuiltImageCommitInfo(builtImageLabels map[string]string) (ImageCommitInfo, error)

func (*GitMapping) GetFullName 

func (gm *GitMapping) GetFullName() string

func (*GitMapping) GetLatestCommitInfo 

func (gm *GitMapping) GetLatestCommitInfo(ctx context.Context, c Conveyor) (ImageCommitInfo, error)

func (*GitMapping) GetParamshash 

func (gm *GitMapping) GetParamshash() string

func (*GitMapping) GetPatchContent 

func (gm *GitMapping) GetPatchContent(ctx context.Context, c Conveyor, prevBuiltImage *StageImage) (string, error)

func (*GitMapping) GitRepo 

func (gm *GitMapping) GitRepo() git_repo.GitRepo

func (*GitMapping) ImageGitCommitLabel 

func (gm *GitMapping) ImageGitCommitLabel() string

func (*GitMapping) IsLocal 

func (gm *GitMapping) IsLocal() bool

func (*GitMapping) IsPatchEmpty 

func (gm *GitMapping) IsPatchEmpty(ctx context.Context, c Conveyor, prevBuiltImage *StageImage) (bool, error)

func (*GitMapping) PatchSize 

func (gm *GitMapping) PatchSize(ctx context.Context, c Conveyor, fromCommit string) (int64, error)

func (*GitMapping) PrepareArchiveForImage 

func (gm *GitMapping) PrepareArchiveForImage(ctx context.Context, c Conveyor, cb container_backend.ContainerBackend, stageImage *StageImage) error

func (*GitMapping) PreparePatchForImage 

func (gm *GitMapping) PreparePatchForImage(ctx context.Context, c Conveyor, cb container_backend.ContainerBackend, prevBuiltImage, stageImage *StageImage) error

func (*GitMapping) SetGitRepo 

func (gm *GitMapping) SetGitRepo(gitRepo git_repo.GitRepo)

func (*GitMapping) StageDependenciesChecksum 

func (gm *GitMapping) StageDependenciesChecksum(ctx context.Context, c Conveyor, stageName StageName) (string, error)

type GitPatchStage 

type GitPatchStage struct {
	*GitStage

	ScriptsDir           string
	ContainerPatchesDir  string
	ContainerArchivesDir string
	ContainerScriptsDir  string
}

func (*GitPatchStage) IsEmpty 

func (s *GitPatchStage) IsEmpty(ctx context.Context, c Conveyor, prevBuiltImage *StageImage) (bool, error)

func (*GitPatchStage) PrepareImage 

func (s *GitPatchStage) PrepareImage(ctx context.Context, c Conveyor, cb container_backend.ContainerBackend, prevBuiltImage, stageImage *StageImage, buildContextArchive container_backend.BuildContextArchiver) error

type GitRepoArchiveStub 

type GitRepoArchiveStub struct {
	git_repo.Archive
}

func NewGitRepoArchiveStub 

func NewGitRepoArchiveStub() *GitRepoArchiveStub

func (*GitRepoArchiveStub) GetFilePath 

func (archive *GitRepoArchiveStub) GetFilePath() string

type GitStage 

type GitStage struct {
	*BaseStage
}

func (*GitStage) IsEmpty 

func (s *GitStage) IsEmpty(ctx context.Context, _ Conveyor, _ *StageImage) (bool, error)

func (*GitStage) PrepareImage 

func (s *GitStage) PrepareImage(ctx context.Context, c Conveyor, cb container_backend.ContainerBackend, prevBuiltImage, stageImage *StageImage, buildContextArchive container_backend.BuildContextArchiver) error

func (*GitStage) SelectSuitableStageDesc 

func (s *GitStage) SelectSuitableStageDesc(ctx context.Context, c Conveyor, stageDescSet image.StageDescSet) (*image.StageDesc, error)

type GiterminismInspectorStub 

type GiterminismInspectorStub struct {
	giterminism_manager.Inspector
}

func NewGiterminismInspectorStub 

func NewGiterminismInspectorStub() *GiterminismInspectorStub

func (*GiterminismInspectorStub) InspectBuildContextFiles 

func (inspector *GiterminismInspectorStub) InspectBuildContextFiles(ctx context.Context, matcher path_matcher.PathMatcher) error

type GiterminismManagerStub 

type GiterminismManagerStub struct {
	giterminism_manager.Interface
	// contains filtered or unexported fields
}

func NewGiterminismManagerStub 

func NewGiterminismManagerStub(localGitRepo git_repo.GitRepo, inspector giterminism_manager.Inspector) *GiterminismManagerStub

func (*GiterminismManagerStub) Dev 

func (manager *GiterminismManagerStub) Dev() bool

func (*GiterminismManagerStub) HeadCommit 

func (manager *GiterminismManagerStub) HeadCommit(ctx context.Context) string

func (*GiterminismManagerStub) Inspector 

func (manager *GiterminismManagerStub) Inspector() giterminism_manager.Inspector

func (*GiterminismManagerStub) LocalGitRepo 

func (manager *GiterminismManagerStub) LocalGitRepo() git_repo.GitRepo

func (*GiterminismManagerStub) RelativeToGitProjectDir 

func (manager *GiterminismManagerStub) RelativeToGitProjectDir() string

type ImageCommitInfo 

type ImageCommitInfo struct {
	Commit string
}

type ImageMutatorPusher 

type ImageMutatorPusher interface {
	MutateAndPushImage(ctx context.Context, src, dest string, newConfig image.SpecConfig, stageImage container_backend.LegacyImageInterface) error
}

type ImageSpecStage 

type ImageSpecStage struct {
	*BaseStage
	// contains filtered or unexported fields
}

func GenerateImageSpecStage 

func GenerateImageSpecStage(imageSpec *config.ImageSpec, baseStageOptions *BaseStageOptions) *ImageSpecStage

func (*ImageSpecStage) GetContentDependencies 

func (s *ImageSpecStage) GetContentDependencies(ctx context.Context, c Conveyor, buildContextArchive container_backend.BuildContextArchiver) (string, error)

func (*ImageSpecStage) GetDependencies 

func (s *ImageSpecStage) GetDependencies(_ context.Context, _ Conveyor, _ container_backend.ContainerBackend, _, _ *StageImage, _ container_backend.BuildContextArchiver) (string, error)

func (*ImageSpecStage) IsBuildable 

func (s *ImageSpecStage) IsBuildable() bool

func (*ImageSpecStage) IsMutable 

func (s *ImageSpecStage) IsMutable() bool

func (*ImageSpecStage) MutateImage 

func (s *ImageSpecStage) MutateImage(ctx context.Context, storage ImageMutatorPusher, prevBuiltImage, stageImage *StageImage) error

func (*ImageSpecStage) PrepareImage 

func (s *ImageSpecStage) PrepareImage(ctx context.Context, _ Conveyor, _ container_backend.ContainerBackend, prevBuiltImage, stageImage *StageImage, _ container_backend.BuildContextArchiver) error

type InstallStage 

type InstallStage struct {
	*UserWithGitPatchStage
}

func GenerateInstallStage 

func GenerateInstallStage(ctx context.Context, imageBaseConfig *config.StapelImageBase, gitPatchStageOptions *NewGitPatchStageOptions, baseStageOptions *BaseStageOptions) *InstallStage

func (*InstallStage) GetDependencies 

func (s *InstallStage) GetDependencies(ctx context.Context, c Conveyor, cb container_backend.ContainerBackend, prevImage, prevBuiltImage *StageImage, buildContextArchive container_backend.BuildContextArchiver) (string, error)

func (*InstallStage) PrepareImage 

func (s *InstallStage) PrepareImage(ctx context.Context, c Conveyor, cb container_backend.ContainerBackend, prevBuiltImage, stageImage *StageImage, buildContextArchive container_backend.BuildContextArchiver) error

type Interface 

type Interface interface {
	Name() StageName
	LogDetailedName() string

	IsEmpty(ctx context.Context, c Conveyor, prevBuiltImage *StageImage) (bool, error)
	IsBuildable() bool
	IsMutable() bool

	ExpandDependencies(ctx context.Context, c Conveyor, baseEnv map[string]string) error
	FetchDependencies(ctx context.Context, c Conveyor, cb container_backend.ContainerBackend, dockerRegistry docker_registry.GenericApiInterface) error
	GetDependencies(ctx context.Context, c Conveyor, cb container_backend.ContainerBackend, prevImage, prevBuiltImage *StageImage, buildContextArchive container_backend.BuildContextArchiver) (string, error)
	GetNextStageDependencies(ctx context.Context, c Conveyor) (string, error)
	GetContentDependencies(ctx context.Context, c Conveyor, buildContextArchive container_backend.BuildContextArchiver) (string, error)

	PrepareImage(ctx context.Context, c Conveyor, cb container_backend.ContainerBackend, prevBuiltImage, stageImage *StageImage, buildContextArchive container_backend.BuildContextArchiver) error

	PreRun(context.Context, Conveyor) error

	SetDigest(digest string)
	GetDigest() string

	SetContentDigest(contentDigest string)
	GetContentDigest() string

	SetStageImage(*StageImage)
	GetStageImage() *StageImage

	SetGitMappings([]*GitMapping)
	GetGitMappings() []*GitMapping

	MutateImage(ctx context.Context, registry ImageMutatorPusher, prevBuiltImage, stageImage *StageImage) error

	SelectSuitableStageDesc(context.Context, Conveyor, image.StageDescSet) (*image.StageDesc, error)

	HasPrevStage() bool
	IsStapelStage() bool
	IsContentAnchor() bool
	SetContentAnchor(bool)

	UsesBuildContext() bool

	SetMeta(meta *StageMeta)
	GetMeta() *StageMeta
}

type LegacyContainerOptionsStub 

type LegacyContainerOptionsStub struct {
	container_backend.LegacyContainerOptions

	Env    map[string]string
	Labels map[string]string
}

func NewLegacyContainerOptionsStub 

func NewLegacyContainerOptionsStub() *LegacyContainerOptionsStub

func (*LegacyContainerOptionsStub) AddEnv 

func (opts *LegacyContainerOptionsStub) AddEnv(envs map[string]string)

func (*LegacyContainerOptionsStub) AddLabel 

func (opts *LegacyContainerOptionsStub) AddLabel(labels map[string]string)

type LegacyContainerStub 

type LegacyContainerStub struct {
	container_backend.LegacyContainer
	// contains filtered or unexported fields
}

func NewLegacyContainerStub 

func NewLegacyContainerStub() *LegacyContainerStub

func (*LegacyContainerStub) ServiceCommitChangeOptions 

func (c *LegacyContainerStub) ServiceCommitChangeOptions() container_backend.LegacyContainerOptions

type LegacyImageStub 

type LegacyImageStub struct {
	container_backend.LegacyImageInterface
	// contains filtered or unexported fields
}

func NewLegacyImageStub 

func NewLegacyImageStub() *LegacyImageStub

func (*LegacyImageStub) Container 

func (img *LegacyImageStub) Container() container_backend.LegacyContainer

func (*LegacyImageStub) GetBuildServiceLabels 

func (img *LegacyImageStub) GetBuildServiceLabels() map[string]string

type LocalGitRepoStub 

type LocalGitRepoStub struct {
	git_repo.GitRepo
	// contains filtered or unexported fields
}

func NewLocalGitRepoStub 

func NewLocalGitRepoStub(headCommitHash string) *LocalGitRepoStub

func (*LocalGitRepoStub) GetOrCreateArchive 

func (repo *LocalGitRepoStub) GetOrCreateArchive(ctx context.Context, opts git_repo.ArchiveOptions) (git_repo.Archive, error)

func (*LocalGitRepoStub) GetOrCreateChecksum 

func (repo *LocalGitRepoStub) GetOrCreateChecksum(ctx context.Context, opts git_repo.ChecksumOptions) (string, error)

func (*LocalGitRepoStub) HeadCommitHash 

func (repo *LocalGitRepoStub) HeadCommitHash(ctx context.Context) (string, error)

type NewGitArchiveStageOptions 

type NewGitArchiveStageOptions struct {
	ArchivesDir          string
	ScriptsDir           string
	ContainerArchivesDir string
	ContainerScriptsDir  string
}

type NewGitPatchStageOptions 

type NewGitPatchStageOptions struct {
	ScriptsDir           string
	ContainerPatchesDir  string
	ContainerArchivesDir string
	ContainerScriptsDir  string
}

type ScratchImageStageStorage 

type ScratchImageStageStorage interface {
	ImageMutatorPusher
	PostManifest(ctx context.Context, ref string, opts container_backend.PostManifestOpts) error
}

ScratchImageStageStorage extends ImageMutatorPusher with PostManifest for creating empty scratch stage images.

type SetupStage 

type SetupStage struct {
	*UserWithGitPatchStage
}

func GenerateSetupStage 

func GenerateSetupStage(ctx context.Context, imageBaseConfig *config.StapelImageBase, gitPatchStageOptions *NewGitPatchStageOptions, baseStageOptions *BaseStageOptions) *SetupStage

func (*SetupStage) GetDependencies 

func (s *SetupStage) GetDependencies(ctx context.Context, c Conveyor, cb container_backend.ContainerBackend, prevImage, prevBuiltImage *StageImage, buildContextArchive container_backend.BuildContextArchiver) (string, error)

func (*SetupStage) PrepareImage 

func (s *SetupStage) PrepareImage(ctx context.Context, c Conveyor, cb container_backend.ContainerBackend, prevBuiltImage, stageImage *StageImage, buildContextArchive container_backend.BuildContextArchiver) error

type StageImage 

type StageImage struct {
	Image   container_backend.LegacyImageInterface
	Builder stage_builder.StageBuilderInterface
}

func NewStageImage 

func NewStageImage(containerBackend container_backend.ContainerBackend, baseImage string, image container_backend.LegacyImageInterface) *StageImage

type StageMeta 

type StageMeta struct {
	Rebuilt             bool
	BaseImagePulled     bool
	BaseImageSourceType string
}

type StageName 

type StageName string
const (
	From                      StageName = "from"
	BeforeInstall             StageName = "beforeInstall"
	DependenciesBeforeInstall StageName = "dependenciesBeforeInstall"
	GitArchive                StageName = "gitArchive"
	Install                   StageName = "install"
	DependenciesAfterInstall  StageName = "dependenciesAfterInstall"
	BeforeSetup               StageName = "beforeSetup"
	DependenciesBeforeSetup   StageName = "dependenciesBeforeSetup"
	Setup                     StageName = "setup"
	DependenciesAfterSetup    StageName = "dependenciesAfterSetup"
	GitCache                  StageName = "gitCache"
	GitLatestPatch            StageName = "gitLatestPatch"

	Dockerfile StageName = "dockerfile"
	ImageSpec  StageName = "imageSpec"
)

type UserStage 

type UserStage struct {
	*BaseStage
	// contains filtered or unexported fields
}

type UserWithGitPatchStage 

type UserWithGitPatchStage struct {
	*UserStage
	GitPatchStage *GitPatchStage
}

func (*UserWithGitPatchStage) GetContentDependencies 

func (s *UserWithGitPatchStage) GetContentDependencies(ctx context.Context, c Conveyor, buildContextArchive container_backend.BuildContextArchiver) (string, error)

GetContentDependencies returns only the builder checksum (shell commands from werf.yaml) without StageDependenciesChecksum. Git file checksums are already fully accounted for by GitArchiveStage.GetContentDependencies, which checksums all files.

func (*UserWithGitPatchStage) GetNextStageDependencies 

func (s *UserWithGitPatchStage) GetNextStageDependencies(ctx context.Context, c Conveyor) (string, error)

func (*UserWithGitPatchStage) PrepareImage 

func (s *UserWithGitPatchStage) PrepareImage(ctx context.Context, c Conveyor, cb container_backend.ContainerBackend, prevBuiltImage, stageImage *StageImage, buildContextArchive container_backend.BuildContextArchiver) error

func (*UserWithGitPatchStage) SelectSuitableStageDesc 

func (s *UserWithGitPatchStage) SelectSuitableStageDesc(ctx context.Context, c Conveyor, stageDescSet image.StageDescSet) (*image.StageDesc, error)

Source Files

View all Source files

Directories

Path Synopsis

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.