lifecycle

package module
v0.16.4 Latest Latest
Warning

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

 Go to latest Published: Jun 7, 2023 License: Apache-2.0 Imports: 34 Imported by: 0

README

Lifecycle

Build Status GoDoc codecov CII Best Practices Gitpod ready-to-code

A reference implementation of the Cloud Native Buildpacks specification.

Supported APIs

Lifecycle Version Platform APIs Buildpack APIs
0.15.x* 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9, 0.10 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9
0.14.x 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8
0.13.x 0.3, 0.4, 0.5, 0.6, 0.7, 0.8 0.2, 0.3, 0.4, 0.5, 0.6, 0.7
0.12.x 0.3, 0.4, 0.5, 0.6, 0.7 0.2, 0.3, 0.4, 0.5, 0.6
0.11.x 0.3, 0.4, 0.5, 0.6 0.2, 0.3, 0.4, 0.5, 0.6
0.10.x 0.3, 0.4, 0.5 0.2, 0.3, 0.4, 0.5
0.9.x 0.3, 0.4 0.2, 0.3, 0.4
0.8.x 0.3 0.2
0.7.x 0.2 0.2
0.6.x 0.2 0.2

* denotes unreleased version

Usage

Build

Either:

  • analyzer - Reads metadata from the previous image and ensures registry access.
  • detector - Chooses buildpacks (via /bin/detect) and produces a build plan.
  • restorer - Restores layer metadata from the previous image and from the cache, and restores cached layers.
  • builder - Executes buildpacks (via /bin/build).
  • exporter - Creates an image and caches layers.

Or:

  • creator - Runs the five phases listed above in order.
Run
  • launcher - Invokes a chosen process.
Rebase
  • rebaser - Creates an image from a previous image with updated base layers.

Contributing

  • CONTRIBUTING - Information on how to contribute and grow your understanding of the lifecycle.
  • DEVELOPMENT - Further detail to help you during the development process.
  • RELEASE - Further details about our release process.

Documentation

Index

Constants

View Source 
const (
	CodeDetectPass = 0
	CodeDetectFail = 100
)

Variables

View Source 
var (
	ErrFailedDetection = errors.New("no buildpacks participating")
	ErrBuildpack       = errors.New("buildpack(s) failed with err")
)
View Source 
var Config = &DefaultConfigHandler{}

Functions

func PrependExtensions added in v0.15.0 

func PrependExtensions(orderBp buildpack.Order, orderExt buildpack.Order) buildpack.Order

func ReadGroup 

func ReadGroup(path string) (buildpack.Group, error)

func ReadOrder 

func ReadOrder(path string) (buildpack.Order, buildpack.Order, error)

func SBOMExtensions added in v0.16.0 

func SBOMExtensions() []string

func TruncateSha 

func TruncateSha(sha string) string

Types

type Analyzer 

type Analyzer struct {
	PreviousImage imgutil.Image
	RunImage      imgutil.Image
	Logger        log.Logger
	SBOMRestorer  layer.SBOMRestorer

	// Platform API < 0.7
	Buildpacks            []buildpack.GroupElement
	Cache                 Cache
	LayerMetadataRestorer layer.MetadataRestorer
	RestoresLayerMetadata bool
}

func (*Analyzer) Analyze 

func (a *Analyzer) Analyze() (platform.AnalyzedMetadata, error)

Analyze fetches the layers metadata from the previous image and writes analyzed.toml.

type AnalyzerFactory added in v0.14.1 

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

func NewAnalyzerFactory added in v0.14.1 

func NewAnalyzerFactory(
	platformAPI *api.Version,
	apiVerifier BuildpackAPIVerifier,
	cacheHandler CacheHandler,
	configHandler ConfigHandler,
	imageHandler ImageHandler,
	registryHandler RegistryHandler,
) *AnalyzerFactory

func (*AnalyzerFactory) NewAnalyzer added in v0.14.1 

func (f *AnalyzerFactory) NewAnalyzer(
	additionalTags []string,
	cacheImageRef string,
	launchCacheDir string,
	layersDir string,
	legacyCacheDir string,
	legacyGroup buildpack.Group,
	legacyGroupPath string,
	outputImageRef string,
	previousImageRef string,
	runImageRef string,
	skipLayers bool,
	logger log.Logger,
) (*Analyzer, error)

type BuildEnv 

type BuildEnv interface {
	AddRootDir(baseDir string) error
	AddEnvDir(envDir string, defaultAction env.ActionType) error
	WithOverrides(platformDir string, baseConfigDir string) ([]string, error)
	List() []string
}

type Builder 

type Builder struct {
	AppDir         string
	BuildConfigDir string
	LayersDir      string
	PlatformDir    string
	BuildExecutor  buildpack.BuildExecutor
	DirStore       DirStore
	Group          buildpack.Group
	Logger         log.Logger
	Out, Err       io.Writer
	Plan           platform.BuildPlan
	PlatformAPI    *api.Version
}

func (*Builder) Build 

func (b *Builder) Build() (*platform.BuildMetadata, error)

type BuildpackAPIVerifier added in v0.15.0 

type BuildpackAPIVerifier interface {
	VerifyBuildpackAPI(kind, name, requested string, logger log.Logger) error
}

type Cache 

type Cache interface {
	Exists() bool
	Name() string
	SetMetadata(metadata platform.CacheMetadata) error
	RetrieveMetadata() (platform.CacheMetadata, error)
	AddLayerFile(tarPath string, sha string) error
	ReuseLayer(sha string) error
	RetrieveLayer(sha string) (io.ReadCloser, error)
	Commit() error
}

type CacheHandler added in v0.14.1 

type CacheHandler interface {
	InitCache(imageRef, dir string) (Cache, error)
}

type ConfigHandler added in v0.14.1 

type ConfigHandler interface {
	ReadAnalyzed(path string) (platform.AnalyzedMetadata, error)
	ReadGroup(path string) (buildpackGroup []buildpack.GroupElement, extensionsGroup []buildpack.GroupElement, err error)
	ReadOrder(path string) (buildpack.Order, buildpack.Order, error)
}

type DefaultConfigHandler added in v0.15.0 

type DefaultConfigHandler struct{}

func NewConfigHandler added in v0.15.0 

func NewConfigHandler() *DefaultConfigHandler

func (*DefaultConfigHandler) ReadAnalyzed added in v0.15.0 

func (h *DefaultConfigHandler) ReadAnalyzed(path string) (platform.AnalyzedMetadata, error)

func (*DefaultConfigHandler) ReadGroup added in v0.15.0 

func (h *DefaultConfigHandler) ReadGroup(path string) (buildpackGroup []buildpack.GroupElement, extensionsGroup []buildpack.GroupElement, err error)

func (*DefaultConfigHandler) ReadOrder added in v0.15.0 

func (h *DefaultConfigHandler) ReadOrder(path string) (buildpack.Order, buildpack.Order, error)

type DefaultDetectResolver added in v0.16.0 

type DefaultDetectResolver struct {
	Logger log.Logger
}

func NewDefaultDetectResolver added in v0.16.0 

func NewDefaultDetectResolver(logger log.Logger) *DefaultDetectResolver

func (*DefaultDetectResolver) Resolve added in v0.16.0 

func (r *DefaultDetectResolver) Resolve(done []buildpack.GroupElement, detectRuns *sync.Map) ([]buildpack.GroupElement, []platform.BuildPlanEntry, error)

Resolve aggregates the detect output for a group of buildpacks and tries to resolve a build plan for the group. If any required buildpack in the group failed detection or a build plan cannot be resolved, it returns an error.

type DetectResolver added in v0.15.0 

type DetectResolver interface {
	Resolve(done []buildpack.GroupElement, detectRuns *sync.Map) ([]buildpack.GroupElement, []platform.BuildPlanEntry, error)
}

type Detector added in v0.11.0 

type Detector struct {
	AppDir         string
	BuildConfigDir string
	DirStore       DirStore
	Executor       buildpack.DetectExecutor
	HasExtensions  bool
	Logger         log.LoggerHandlerWithLevel
	Order          buildpack.Order
	PlatformDir    string
	Resolver       DetectResolver
	Runs           *sync.Map
	// contains filtered or unexported fields
}

func (*Detector) Detect added in v0.11.0 

func (d *Detector) Detect() (buildpack.Group, platform.BuildPlan, error)

func (*Detector) DetectOrder added in v0.11.0 

func (d *Detector) DetectOrder(order buildpack.Order) (buildpack.Group, platform.BuildPlan, error)

type DetectorFactory added in v0.15.0 

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

func NewDetectorFactory added in v0.15.0 

func NewDetectorFactory(
	platformAPI *api.Version,
	apiVerifier BuildpackAPIVerifier,
	configHandler ConfigHandler,
	dirStore DirStore,
) *DetectorFactory

func (*DetectorFactory) NewDetector added in v0.15.0 

func (f *DetectorFactory) NewDetector(appDir, buildConfigDir, orderPath, platformDir string, logger log.LoggerHandlerWithLevel) (*Detector, error)

type DirStore added in v0.15.0 

type DirStore interface {
	Lookup(kind, id, version string) (buildpack.Descriptor, error)
	LookupBp(id, version string) (*buildpack.BpDescriptor, error)
	LookupExt(id, version string) (*buildpack.ExtDescriptor, error)
}

type DockerfileApplier added in v0.15.0 

type DockerfileApplier interface {
	Apply(workspace string, digest string, dockerfiles []extend.Dockerfile, options extend.Options) error
}

type ExportOptions added in v0.7.0 

type ExportOptions struct {
	LayersDir          string
	AppDir             string
	WorkingImage       imgutil.Image
	RunImageRef        string
	OrigMetadata       platform.LayersMetadata
	AdditionalNames    []string
	LauncherConfig     LauncherConfig
	Stack              platform.StackMetadata
	Project            platform.ProjectMetadata
	DefaultProcessType string
}

type Exporter 

type Exporter struct {
	Buildpacks   []buildpack.GroupElement
	LayerFactory LayerFactory
	Logger       log.Logger
	PlatformAPI  *api.Version
}

func (*Exporter) Cache 

func (e *Exporter) Cache(layersDir string, cacheStore Cache) error

func (*Exporter) Export 

func (e *Exporter) Export(opts ExportOptions) (platform.ExportReport, error)

type Extender added in v0.15.0 

type Extender struct {
	AppDir            string
	GeneratedDir      string
	GroupPath         string
	ImageRef          string
	LayersDir         string
	PlatformDir       string
	CacheTTL          time.Duration
	DockerfileApplier DockerfileApplier
	Extensions        []buildpack.GroupElement
	Logger            log.Logger
}

func (*Extender) ExtendBuild added in v0.15.0 

func (e *Extender) ExtendBuild() error

type ExtenderFactory added in v0.15.0 

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

func NewExtenderFactory added in v0.15.0 

func NewExtenderFactory(apiVerifier BuildpackAPIVerifier, configHandler ConfigHandler) *ExtenderFactory

func (*ExtenderFactory) NewExtender added in v0.15.0 

func (f *ExtenderFactory) NewExtender(
	analyzedPath string,
	appDir string,
	generatedDir string,
	groupPath string,
	layersDir string,
	platformDir string,
	cacheTTL time.Duration,
	dockerfileApplier DockerfileApplier,
	logger log.Logger,
) (*Extender, error)

type GenerateResult added in v0.15.0 

type GenerateResult struct {
	RunImage string
	Plan     platform.BuildPlan
	UsePlan  bool
}

type Generator added in v0.15.0 

type Generator struct {
	AppDir         string
	BuildConfigDir string
	GeneratedDir   string // e.g., <layers>/generated
	PlatformDir    string
	DirStore       DirStore
	Executor       buildpack.GenerateExecutor
	Extensions     []buildpack.GroupElement
	Logger         log.Logger
	Out, Err       io.Writer
	Plan           platform.BuildPlan
}

func (*Generator) Generate added in v0.15.0 

func (g *Generator) Generate() (GenerateResult, error)

type GeneratorFactory added in v0.15.0 

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

func NewGeneratorFactory added in v0.15.0 

func NewGeneratorFactory(
	apiVerifier BuildpackAPIVerifier,
	dirStore DirStore,
) *GeneratorFactory

func (*GeneratorFactory) NewGenerator added in v0.15.0 

func (f *GeneratorFactory) NewGenerator(
	appDir string,
	buildConfigDir string,
	extensions []buildpack.GroupElement,
	generatedDir string,
	plan platform.BuildPlan,
	platformDir string,
	stdout, stderr io.Writer,
	logger log.Logger,
) (*Generator, error)

type ImageHandler added in v0.14.1 

type ImageHandler interface {
	InitImage(imageRef string) (imgutil.Image, error)
	Docker() bool
}

type LauncherConfig 

type LauncherConfig struct {
	Path     string
	SBOMDir  string
	Metadata platform.LauncherMetadata
}

type LayerDir added in v0.13.1 

type LayerDir interface {
	Identifier() string
	Path() string
}

type LayerFactory added in v0.8.1 

type LayerFactory interface {
	DirLayer(id string, dir string) (layers.Layer, error)
	LauncherLayer(path string) (layers.Layer, error)
	ProcessTypesLayer(metadata launch.Metadata) (layers.Layer, error)
	SliceLayers(dir string, slices []layers.Slice) ([]layers.Layer, error)
}

type MultiError 

type MultiError struct {
	Errors []error
}

func (*MultiError) Error 

func (me *MultiError) Error() string

type Platform added in v0.12.0 

type Platform interface {
	API() *api.Version
}

type RebaseReport added in v0.9.0 

type RebaseReport struct {
	Image platform.ImageReport `toml:"image"`
}

type Rebaser 

type Rebaser struct {
	Logger      log.Logger
	PlatformAPI *api.Version
}

func (*Rebaser) Rebase 

func (r *Rebaser) Rebase(workingImage imgutil.Image, newBaseImage imgutil.Image, outputImageRef string, additionalNames []string) (RebaseReport, error)

type RegistryHandler added in v0.14.1 

type RegistryHandler interface {
	EnsureReadAccess(imageRefs ...string) error
	EnsureWriteAccess(imageRefs ...string) error
}

type Restorer 

type Restorer struct {
	LayersDir string
	Logger    log.Logger

	Buildpacks            []buildpack.GroupElement
	LayerMetadataRestorer layer.MetadataRestorer  // Platform API >= 0.7
	LayersMetadata        platform.LayersMetadata // Platform API >= 0.7
	PlatformAPI           *api.Version
	SBOMRestorer          layer.SBOMRestorer
}

func (*Restorer) Restore 

func (r *Restorer) Restore(cache Cache) error

Restore restores metadata for launch and cache layers into the layers directory and attempts to restore layer data for cache=true layers, removing the layer when unsuccessful. If a usable cache is not provided, Restore will not restore any cache=true layer metadata.

Source Files

View all Source files

Directories

Path Synopsis
testmock
Package testmock is a generated GoMock package.
 Package testmock is a generated GoMock package.
cmd
launcher command
launcher/cli
lifecycle command
lifecycle/cli
internal
encoding
extend
extend/kaniko
fsutil
layer
path
selective
str
testhelpers
testmock
Package testmock is a generated GoMock package.
 Package testmock is a generated GoMock package.
launch
Package testmock is a generated GoMock package.
 Package testmock is a generated GoMock package.
tools
image command
lister command
packager command
version command

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.