Documentation
¶
Index ¶
- Variables
- type BaseStage
- func (s *BaseStage) AfterImageSyncDockerStateHook(_ Conveyor) error
- func (s *BaseStage) GetDependencies(_ Conveyor, _, _ imagePkg.ImageInterface) (string, error)
- func (s *BaseStage) GetGitMappings() []*GitMapping
- func (s *BaseStage) GetImage() imagePkg.ImageInterface
- func (s *BaseStage) GetNextStageDependencies(_ Conveyor) (string, error)
- func (s *BaseStage) GetSignature() string
- func (s *BaseStage) IsEmpty(_ Conveyor, _ imagePkg.ImageInterface) (bool, error)
- func (s *BaseStage) LogDetailedName() string
- func (s *BaseStage) Name() StageName
- func (s *BaseStage) PreRunHook(_ Conveyor) error
- func (s *BaseStage) PrepareImage(_ Conveyor, prevBuiltImage, image imagePkg.ImageInterface) error
- func (s *BaseStage) SelectCacheImage(images []*storage.ImageInfo) (*storage.ImageInfo, error)
- func (s *BaseStage) SetGitMappings(gitMappings []*GitMapping)
- func (s *BaseStage) SetImage(image imagePkg.ImageInterface)
- func (s *BaseStage) SetSignature(signature string)
- func (s *BaseStage) ShouldBeReset(builtImage imagePkg.ImageInterface) (bool, error)
- type BeforeInstallStage
- type BeforeSetupStage
- type ContainerFileDescriptor
- type ContextChecksum
- type Conveyor
- type DockerInstructionsStage
- type DockerRunArgs
- type DockerStages
- type DockerfileStage
- type FromStage
- type GitArchiveStage
- func (s *GitArchiveStage) GetDependencies(_ Conveyor, _, _ image.ImageInterface) (string, error)
- func (s *GitArchiveStage) GetNextStageDependencies(c Conveyor) (string, error)
- func (s *GitArchiveStage) PrepareImage(c Conveyor, prevBuiltImage, image image.ImageInterface) error
- func (s *GitArchiveStage) SelectCacheImage(images []*storage.ImageInfo) (*storage.ImageInfo, error)
- type GitCacheStage
- func (s *GitCacheStage) GetDependencies(_ Conveyor, _, prevBuiltImage image.ImageInterface) (string, error)
- func (s *GitCacheStage) IsEmpty(c Conveyor, prevBuiltImage image.ImageInterface) (bool, error)
- func (s *GitCacheStage) SelectCacheImage(images []*storage.ImageInfo) (*storage.ImageInfo, error)
- type GitLatestPatchStage
- type GitMapping
- func (gm *GitMapping) AddGitCommitToImageLabels(image image.ImageInterface, commit string)
- func (gm *GitMapping) ApplyArchiveCommand(image image.ImageInterface) error
- func (gm *GitMapping) ApplyPatchCommand(prevBuiltImage, image image.ImageInterface) error
- func (gm *GitMapping) GetCommitsToPatch(prevBuiltImage image.ImageInterface) (string, string, error)
- func (gm *GitMapping) GetFullName() string
- func (gm *GitMapping) GetGitCommitFromImageLabels(labels map[string]string) string
- func (gm *GitMapping) GetParamshash() string
- func (gm *GitMapping) GetPatchContent(prevBuiltImage image.ImageInterface) (string, error)
- func (gm *GitMapping) GitRepo() git_repo.GitRepo
- func (gm *GitMapping) ImageGitCommitLabel() string
- func (gm *GitMapping) IsEmpty() (bool, error)
- func (gm *GitMapping) IsLocal() bool
- func (gm *GitMapping) IsPatchEmpty(prevBuiltImage image.ImageInterface) (bool, error)
- func (gm *GitMapping) LatestCommit() (string, error)
- func (gm *GitMapping) PatchSize(fromCommit string) (int64, error)
- func (gm *GitMapping) StageDependenciesChecksum(stageName StageName) (string, error)
- type GitPatchStage
- type GitRepoCache
- type GitStage
- type ImportsAfterInstallStage
- type ImportsAfterSetupStage
- type ImportsBeforeInstallStage
- type ImportsBeforeSetupStage
- type ImportsStage
- type InstallStage
- type Interface
- type NewBaseStageOptions
- type NewGitArchiveStageOptions
- type NewGitPatchStageOptions
- type SetupStage
- type StageName
- type UserStage
- type UserWithGitPatchStage
- func (s *UserWithGitPatchStage) AfterImageSyncDockerStateHook(c Conveyor) error
- func (s *UserWithGitPatchStage) GetNextStageDependencies(c Conveyor) (string, error)
- func (s *UserWithGitPatchStage) PrepareImage(c Conveyor, prevBuiltImage, image image.ImageInterface) error
- func (s *UserWithGitPatchStage) SelectCacheImage(images []*storage.ImageInfo) (*storage.ImageInfo, error)
Constants ¶
This section is empty.
Variables ¶
View Source
var ( AllStages = []StageName{ From, BeforeInstall, ImportsBeforeInstall, GitArchive, Install, ImportsAfterInstall, BeforeSetup, ImportsBeforeSetup, Setup, ImportsAfterSetup, GitCache, GitLatestPatch, DockerInstructions, Dockerfile, } )
Functions ¶
This section is empty.
Types ¶
type BaseStage ¶
type BaseStage struct {
// contains filtered or unexported fields
}
func (*BaseStage) AfterImageSyncDockerStateHook ¶
func (*BaseStage) GetDependencies ¶
func (*BaseStage) GetGitMappings ¶
func (s *BaseStage) GetGitMappings() []*GitMapping
func (*BaseStage) GetImage ¶
func (s *BaseStage) GetImage() imagePkg.ImageInterface
func (*BaseStage) GetNextStageDependencies ¶ added in v1.1.0
func (*BaseStage) GetSignature ¶
func (*BaseStage) LogDetailedName ¶
func (*BaseStage) PreRunHook ¶
func (*BaseStage) PrepareImage ¶
func (s *BaseStage) PrepareImage(_ Conveyor, prevBuiltImage, image imagePkg.ImageInterface) error
func (*BaseStage) SelectCacheImage ¶ added in v1.1.0
func (*BaseStage) SetGitMappings ¶
func (s *BaseStage) SetGitMappings(gitMappings []*GitMapping)
func (*BaseStage) SetImage ¶
func (s *BaseStage) SetImage(image imagePkg.ImageInterface)
func (*BaseStage) SetSignature ¶
func (*BaseStage) ShouldBeReset ¶
func (s *BaseStage) ShouldBeReset(builtImage imagePkg.ImageInterface) (bool, error)
type BeforeInstallStage ¶
type BeforeInstallStage struct {
*UserStage
}
func GenerateBeforeInstallStage ¶
func GenerateBeforeInstallStage(imageBaseConfig *config.StapelImageBase, baseStageOptions *NewBaseStageOptions) *BeforeInstallStage
func (*BeforeInstallStage) GetDependencies ¶
func (s *BeforeInstallStage) GetDependencies(_ Conveyor, _, _ image.ImageInterface) (string, error)
func (*BeforeInstallStage) PrepareImage ¶
func (s *BeforeInstallStage) PrepareImage(c Conveyor, prevBuiltImage, image image.ImageInterface) error
type BeforeSetupStage ¶
type BeforeSetupStage struct {
*UserWithGitPatchStage
}
func GenerateBeforeSetupStage ¶
func GenerateBeforeSetupStage(imageBaseConfig *config.StapelImageBase, gitPatchStageOptions *NewGitPatchStageOptions, baseStageOptions *NewBaseStageOptions) *BeforeSetupStage
func (*BeforeSetupStage) GetDependencies ¶
func (s *BeforeSetupStage) GetDependencies(_ Conveyor, _, _ image.ImageInterface) (string, error)
func (*BeforeSetupStage) PrepareImage ¶
func (s *BeforeSetupStage) PrepareImage(c Conveyor, prevBuiltImage, image image.ImageInterface) error
type ContainerFileDescriptor ¶
type ContextChecksum ¶ added in v1.1.0
type ContextChecksum struct {
// contains filtered or unexported fields
}
func NewContextChecksum ¶ added in v1.1.0
func NewContextChecksum(projectPath string, dockerignorePathMatcher *path_matcher.DockerfileIgnorePathMatcher, localGitRepo *git_repo.Local) *ContextChecksum
type Conveyor ¶
type Conveyor interface {
GetImageStagesSignature(imageName string) string
GetImageLastStageImageName(imageName string) string
GetImageLastStageImageID(imageName string) string
SetBuildingGitStage(imageName string, stageName StageName)
GetBuildingGitStage(imageName string) StageName
GetImportServer(imageName string) (import_server.ImportServer, error)
}
type DockerInstructionsStage ¶
type DockerInstructionsStage struct {
*BaseStage
// contains filtered or unexported fields
}
func GenerateDockerInstructionsStage ¶
func GenerateDockerInstructionsStage(imageConfig *config.StapelImage, baseStageOptions *NewBaseStageOptions) *DockerInstructionsStage
func (*DockerInstructionsStage) GetDependencies ¶
func (s *DockerInstructionsStage) GetDependencies(_ Conveyor, _, _ image.ImageInterface) (string, error)
func (*DockerInstructionsStage) PrepareImage ¶
func (s *DockerInstructionsStage) PrepareImage(c Conveyor, prevBuiltImage, image image.ImageInterface) error
type DockerRunArgs ¶ added in v1.1.0
type DockerRunArgs struct {
// contains filtered or unexported fields
}
func NewDockerRunArgs ¶ added in v1.1.0
func NewDockerRunArgs(dockerfilePath, target, context string, buildArgs map[string]interface{}, addHost []string) *DockerRunArgs
type DockerStages ¶ added in v1.1.0
type DockerStages struct {
// contains filtered or unexported fields
}
func NewDockerStages ¶ added in v1.1.0
func NewDockerStages(dockerStages []instructions.Stage, dockerArgsHash map[string]string, dockerTargetStageIndex int) *DockerStages
type DockerfileStage ¶
type DockerfileStage struct {
*DockerRunArgs
*DockerStages
*ContextChecksum
*BaseStage
}
func GenerateDockerfileStage ¶
func GenerateDockerfileStage(dockerRunArgs *DockerRunArgs, dockerStages *DockerStages, contextChecksum *ContextChecksum, baseStageOptions *NewBaseStageOptions) *DockerfileStage
func (*DockerfileStage) DockerBuildArgs ¶
func (s *DockerfileStage) DockerBuildArgs() []string
func (*DockerfileStage) GetDependencies ¶
func (s *DockerfileStage) GetDependencies(_ Conveyor, _, _ image.ImageInterface) (string, error)
func (*DockerfileStage) PrepareImage ¶
func (s *DockerfileStage) PrepareImage(c Conveyor, prevBuiltImage, img image.ImageInterface) error
type FromStage ¶
type FromStage struct {
*BaseStage
// contains filtered or unexported fields
}
func GenerateFromStage ¶
func GenerateFromStage(imageBaseConfig *config.StapelImageBase, baseImageRepoId string, baseStageOptions *NewBaseStageOptions) *FromStage
func (*FromStage) GetDependencies ¶
func (*FromStage) PrepareImage ¶
func (s *FromStage) PrepareImage(_ Conveyor, prevBuiltImage, image image.ImageInterface) error
type GitArchiveStage ¶
type GitArchiveStage struct {
*GitStage
ArchivesDir string
ScriptsDir string
ContainerArchivesDir string
ContainerScriptsDir string
}
func NewGitArchiveStage ¶
func NewGitArchiveStage(gitArchiveStageOptions *NewGitArchiveStageOptions, baseStageOptions *NewBaseStageOptions) *GitArchiveStage
func (*GitArchiveStage) GetDependencies ¶
func (s *GitArchiveStage) GetDependencies(_ Conveyor, _, _ image.ImageInterface) (string, error)
func (*GitArchiveStage) GetNextStageDependencies ¶ added in v1.1.0
func (s *GitArchiveStage) GetNextStageDependencies(c Conveyor) (string, error)
func (*GitArchiveStage) PrepareImage ¶
func (s *GitArchiveStage) PrepareImage(c Conveyor, prevBuiltImage, image image.ImageInterface) error
func (*GitArchiveStage) SelectCacheImage ¶ added in v1.1.0
type GitCacheStage ¶
type GitCacheStage struct {
*GitPatchStage
}
func NewGitCacheStage ¶
func NewGitCacheStage(gitPatchStageOptions *NewGitPatchStageOptions, baseStageOptions *NewBaseStageOptions) *GitCacheStage
func (*GitCacheStage) GetDependencies ¶
func (s *GitCacheStage) GetDependencies(_ Conveyor, _, prevBuiltImage image.ImageInterface) (string, error)
func (*GitCacheStage) IsEmpty ¶
func (s *GitCacheStage) IsEmpty(c Conveyor, prevBuiltImage image.ImageInterface) (bool, error)
func (*GitCacheStage) SelectCacheImage ¶ added in v1.1.0
type GitLatestPatchStage ¶
type GitLatestPatchStage struct {
*GitPatchStage
}
func NewGitLatestPatchStage ¶
func NewGitLatestPatchStage(gitPatchStageOptions *NewGitPatchStageOptions, baseStageOptions *NewBaseStageOptions) *GitLatestPatchStage
func (*GitLatestPatchStage) GetDependencies ¶
func (s *GitLatestPatchStage) GetDependencies(_ Conveyor, _, prevBuiltImage image.ImageInterface) (string, error)
func (*GitLatestPatchStage) IsEmpty ¶
func (s *GitLatestPatchStage) IsEmpty(c Conveyor, prevBuiltImage image.ImageInterface) (bool, error)
type GitMapping ¶
type GitMapping struct {
GitRepoInterface git_repo.GitRepo
LocalGitRepo *git_repo.Local
RemoteGitRepo *git_repo.Remote
GitRepoCache *GitRepoCache
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
PatchesDir string
ContainerPatchesDir string
ArchivesDir string
ContainerArchivesDir string
ScriptsDir string
ContainerScriptsDir string
}
func (*GitMapping) AddGitCommitToImageLabels ¶
func (gm *GitMapping) AddGitCommitToImageLabels(image image.ImageInterface, commit string)
func (*GitMapping) ApplyArchiveCommand ¶
func (gm *GitMapping) ApplyArchiveCommand(image image.ImageInterface) error
func (*GitMapping) ApplyPatchCommand ¶
func (gm *GitMapping) ApplyPatchCommand(prevBuiltImage, image image.ImageInterface) error
func (*GitMapping) GetCommitsToPatch ¶
func (gm *GitMapping) GetCommitsToPatch(prevBuiltImage image.ImageInterface) (string, string, error)
func (*GitMapping) GetFullName ¶
func (gm *GitMapping) GetFullName() string
func (*GitMapping) GetGitCommitFromImageLabels ¶
func (gm *GitMapping) GetGitCommitFromImageLabels(labels map[string]string) string
func (*GitMapping) GetParamshash ¶
func (gm *GitMapping) GetParamshash() string
func (*GitMapping) GetPatchContent ¶ added in v1.1.0
func (gm *GitMapping) GetPatchContent(prevBuiltImage image.ImageInterface) (string, error)
func (*GitMapping) GitRepo ¶
func (gm *GitMapping) GitRepo() git_repo.GitRepo
func (*GitMapping) ImageGitCommitLabel ¶
func (gm *GitMapping) ImageGitCommitLabel() string
func (*GitMapping) IsEmpty ¶
func (gm *GitMapping) IsEmpty() (bool, error)
func (*GitMapping) IsLocal ¶
func (gm *GitMapping) IsLocal() bool
func (*GitMapping) IsPatchEmpty ¶
func (gm *GitMapping) IsPatchEmpty(prevBuiltImage image.ImageInterface) (bool, error)
func (*GitMapping) LatestCommit ¶
func (gm *GitMapping) LatestCommit() (string, error)
func (*GitMapping) StageDependenciesChecksum ¶
func (gm *GitMapping) StageDependenciesChecksum(stageName StageName) (string, error)
type GitPatchStage ¶
type GitPatchStage struct {
*GitStage
PatchesDir string
ArchivesDir string
ScriptsDir string
ContainerPatchesDir string
ContainerArchivesDir string
ContainerScriptsDir string
}
func (*GitPatchStage) IsEmpty ¶
func (s *GitPatchStage) IsEmpty(c Conveyor, prevBuiltImage image.ImageInterface) (bool, error)
func (*GitPatchStage) PrepareImage ¶
func (s *GitPatchStage) PrepareImage(c Conveyor, prevBuiltImage, image image.ImageInterface) error
type GitRepoCache ¶
type GitRepoCache struct {
Patches map[string]git_repo.Patch
Checksums map[string]git_repo.Checksum
Archives map[string]git_repo.Archive
}
func (*GitRepoCache) Terminate ¶
func (cache *GitRepoCache) Terminate() error
type GitStage ¶
type GitStage struct {
*BaseStage
}
func (*GitStage) AfterImageSyncDockerStateHook ¶
func (*GitStage) PrepareImage ¶
func (s *GitStage) PrepareImage(c Conveyor, prevBuiltImage, image image.ImageInterface) error
type ImportsAfterInstallStage ¶
type ImportsAfterInstallStage struct {
*ImportsStage
}
func GenerateImportsAfterInstallStage ¶
func GenerateImportsAfterInstallStage(imageBaseConfig *config.StapelImageBase, baseStageOptions *NewBaseStageOptions) *ImportsAfterInstallStage
type ImportsAfterSetupStage ¶
type ImportsAfterSetupStage struct {
*ImportsStage
}
func GenerateImportsAfterSetupStage ¶
func GenerateImportsAfterSetupStage(imageBaseConfig *config.StapelImageBase, baseStageOptions *NewBaseStageOptions) *ImportsAfterSetupStage
type ImportsBeforeInstallStage ¶
type ImportsBeforeInstallStage struct {
*ImportsStage
}
func GenerateImportsBeforeInstallStage ¶
func GenerateImportsBeforeInstallStage(imageBaseConfig *config.StapelImageBase, baseStageOptions *NewBaseStageOptions) *ImportsBeforeInstallStage
type ImportsBeforeSetupStage ¶
type ImportsBeforeSetupStage struct {
*ImportsStage
}
func GenerateImportsBeforeSetupStage ¶
func GenerateImportsBeforeSetupStage(imageBaseConfig *config.StapelImageBase, baseStageOptions *NewBaseStageOptions) *ImportsBeforeSetupStage
type ImportsStage ¶
type ImportsStage struct {
*BaseStage
// contains filtered or unexported fields
}
func (*ImportsStage) GetDependencies ¶
func (s *ImportsStage) GetDependencies(c Conveyor, _, _ imagePkg.ImageInterface) (string, error)
func (*ImportsStage) PrepareImage ¶
func (s *ImportsStage) PrepareImage(c Conveyor, _, image imagePkg.ImageInterface) error
type InstallStage ¶
type InstallStage struct {
*UserWithGitPatchStage
}
func GenerateInstallStage ¶
func GenerateInstallStage(imageBaseConfig *config.StapelImageBase, gitPatchStageOptions *NewGitPatchStageOptions, baseStageOptions *NewBaseStageOptions) *InstallStage
func (*InstallStage) GetDependencies ¶
func (s *InstallStage) GetDependencies(_ Conveyor, _, _ image.ImageInterface) (string, error)
func (*InstallStage) PrepareImage ¶
func (s *InstallStage) PrepareImage(c Conveyor, prevBuiltImage, image image.ImageInterface) error
type Interface ¶
type Interface interface {
Name() StageName
LogDetailedName() string
IsEmpty(c Conveyor, prevBuiltImage image.ImageInterface) (bool, error)
ShouldBeReset(builtImage image.ImageInterface) (bool, error)
GetDependencies(c Conveyor, prevImage image.ImageInterface, prevBuiltImage image.ImageInterface) (string, error)
GetNextStageDependencies(c Conveyor) (string, error)
PrepareImage(c Conveyor, prevBuiltImage, image image.ImageInterface) error
AfterImageSyncDockerStateHook(Conveyor) error
PreRunHook(Conveyor) error
SetSignature(signature string)
GetSignature() string
SetImage(image.ImageInterface)
GetImage() image.ImageInterface
SetGitMappings([]*GitMapping)
GetGitMappings() []*GitMapping
SelectCacheImage(images []*storage.ImageInfo) (*storage.ImageInfo, error)
}
type NewBaseStageOptions ¶
type NewGitPatchStageOptions ¶
type SetupStage ¶
type SetupStage struct {
*UserWithGitPatchStage
}
func GenerateSetupStage ¶
func GenerateSetupStage(imageBaseConfig *config.StapelImageBase, gitPatchStageOptions *NewGitPatchStageOptions, baseStageOptions *NewBaseStageOptions) *SetupStage
func (*SetupStage) GetDependencies ¶
func (s *SetupStage) GetDependencies(_ Conveyor, _, _ image.ImageInterface) (string, error)
func (*SetupStage) PrepareImage ¶
func (s *SetupStage) PrepareImage(c Conveyor, prevBuiltImage, image image.ImageInterface) error
type StageName ¶
type StageName string
const ( From StageName = "from" BeforeInstall StageName = "beforeInstall" ImportsBeforeInstall StageName = "importsBeforeInstall" GitArchive StageName = "gitArchive" Install StageName = "install" ImportsAfterInstall StageName = "importsAfterInstall" BeforeSetup StageName = "beforeSetup" ImportsBeforeSetup StageName = "importsBeforeSetup" Setup StageName = "setup" ImportsAfterSetup StageName = "importsAfterSetup" GitCache StageName = "gitCache" GitLatestPatch StageName = "gitLatestPatch" DockerInstructions StageName = "dockerInstructions" Dockerfile StageName = "dockerfile" )
type UserWithGitPatchStage ¶
type UserWithGitPatchStage struct {
*UserStage
GitPatchStage *GitPatchStage
}
func (*UserWithGitPatchStage) AfterImageSyncDockerStateHook ¶
func (s *UserWithGitPatchStage) AfterImageSyncDockerStateHook(c Conveyor) error
func (*UserWithGitPatchStage) GetNextStageDependencies ¶ added in v1.1.0
func (s *UserWithGitPatchStage) GetNextStageDependencies(c Conveyor) (string, error)
func (*UserWithGitPatchStage) PrepareImage ¶
func (s *UserWithGitPatchStage) PrepareImage(c Conveyor, prevBuiltImage, image image.ImageInterface) error
func (*UserWithGitPatchStage) SelectCacheImage ¶ added in v1.1.0
Source Files
¶
- base.go
- before_install.go
- before_setup.go
- conveyor.go
- docker_instructions.go
- dockerfile.go
- from.go
- git.go
- git_archive.go
- git_cache.go
- git_latest_patch.go
- git_mapping.go
- git_patch.go
- imports.go
- imports_after_install.go
- imports_after_setup.go
- imports_before_install.go
- imports_before_setup.go
- install.go
- interface.go
- setup.go
- user.go
- user_with_git_patch.go
Click to show internal directories.
Click to hide internal directories.