build

Documentation

Index

• Variables
• type Builder
• type Cache
• type DefaultPhaseFactory
  • func NewDefaultPhaseFactory(lifecycle *Lifecycle) *DefaultPhaseFactory
  • func (m *DefaultPhaseFactory) New(provider *PhaseConfigProvider) RunnerCleaner
• type Lifecycle
  • func NewLifecycle(docker client.CommonAPIClient, logger logging.Logger) *Lifecycle
  • func (l *Lifecycle) Analyze(ctx context.Context, repoName, cacheName string, publish, clearCache bool, ...) error
  • func (l *Lifecycle) Build(ctx context.Context, networkMode string, volumes []string, ...) error
  • func (l *Lifecycle) Cleanup() error
  • func (l *Lifecycle) Detect(ctx context.Context, networkMode string, volumes []string, ...) error
  • func (l *Lifecycle) Execute(ctx context.Context, opts LifecycleOptions) error
  • func (l *Lifecycle) Export(ctx context.Context, repoName string, runImage string, publish bool, ...) error
  • func (l *Lifecycle) Restore(ctx context.Context, cacheName string, phaseFactory PhaseFactory) error
  • func (l *Lifecycle) Setup(opts LifecycleOptions)
• type LifecycleOptions
• type Phase
  • func (p *Phase) Cleanup() error
  • func (p *Phase) Run(ctx context.Context) error
• type PhaseConfigProvider
  • func NewPhaseConfigProvider(name string, lifecycle *Lifecycle, ops ...PhaseConfigProviderOperation) *PhaseConfigProvider
  • func (p *PhaseConfigProvider) ContainerConfig() *container.Config
  • func (p *PhaseConfigProvider) HostConfig() *container.HostConfig
  • func (p *PhaseConfigProvider) Name() string
• type PhaseConfigProviderOperation
  • func WithArgs(args ...string) PhaseConfigProviderOperation
  • func WithBinds(binds ...string) PhaseConfigProviderOperation
  • func WithDaemonAccess() PhaseConfigProviderOperation
  • func WithLifecycleProxy(lifecycle *Lifecycle) PhaseConfigProviderOperation
  • func WithNetwork(networkMode string) PhaseConfigProviderOperation
  • func WithRegistryAccess(authConfig string) PhaseConfigProviderOperation
  • func WithRoot() PhaseConfigProviderOperation
• type PhaseFactory
• type RunnerCleaner

Variables

var (
	// SupportedPlatformAPIVersions lists the Platform API versions pack supports.
	SupportedPlatformAPIVersions = []string{"0.2", "0.3"}
)

Types

type Builder

type Builder interface {
	Name() string
	UID() int
	GID() int
	LifecycleDescriptor() builder.LifecycleDescriptor
}

type Cache

type Cache interface {
	Name() string
	Clear(context.Context) error
}

type DefaultPhaseFactory

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

func NewDefaultPhaseFactory

func NewDefaultPhaseFactory(lifecycle *Lifecycle) *DefaultPhaseFactory

func (*DefaultPhaseFactory) New

func (m *DefaultPhaseFactory) New(provider *PhaseConfigProvider) RunnerCleaner

type Lifecycle

type Lifecycle struct {
	LayersVolume       string
	AppVolume          string
	Volumes            []string
	DefaultProcessType string
	// contains filtered or unexported fields
}

func NewLifecycle

func NewLifecycle(docker client.CommonAPIClient, logger logging.Logger) *Lifecycle

func (*Lifecycle) Analyze

func (l *Lifecycle) Analyze(ctx context.Context, repoName, cacheName string, publish, clearCache bool, phaseFactory PhaseFactory) error

func (*Lifecycle) Build

func (l *Lifecycle) Build(ctx context.Context, networkMode string, volumes []string, phaseFactory PhaseFactory) error

func (*Lifecycle) Cleanup

func (l *Lifecycle) Cleanup() error

func (*Lifecycle) Detect

func (l *Lifecycle) Detect(ctx context.Context, networkMode string, volumes []string, phaseFactory PhaseFactory) error

func (*Lifecycle) Execute

func (l *Lifecycle) Execute(ctx context.Context, opts LifecycleOptions) error

func (*Lifecycle) Export

func (l *Lifecycle) Export(ctx context.Context, repoName string, runImage string, publish bool, launchCacheName, cacheName string, phaseFactory PhaseFactory) error

func (*Lifecycle) Restore

func (l *Lifecycle) Restore(ctx context.Context, cacheName string, phaseFactory PhaseFactory) error

func (*Lifecycle) Setup

func (l *Lifecycle) Setup(opts LifecycleOptions)

type LifecycleOptions

type LifecycleOptions struct {
	AppPath            string
	Image              name.Reference
	Builder            Builder
	RunImage           string
	ClearCache         bool
	Publish            bool
	HTTPProxy          string
	HTTPSProxy         string
	NoProxy            string
	Network            string
	Volumes            []string
	DefaultProcessType string
	FileFilter         func(string) bool
}

type Phase

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

func (*Phase) Cleanup

func (p *Phase) Cleanup() error

func (*Phase) Run

func (p *Phase) Run(ctx context.Context) error

type PhaseConfigProvider

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

func NewPhaseConfigProvider

func NewPhaseConfigProvider(name string, lifecycle *Lifecycle, ops ...PhaseConfigProviderOperation) *PhaseConfigProvider

func (*PhaseConfigProvider) ContainerConfig

func (p *PhaseConfigProvider) ContainerConfig() *container.Config

func (*PhaseConfigProvider) HostConfig

func (p *PhaseConfigProvider) HostConfig() *container.HostConfig

func (*PhaseConfigProvider) Name

func (p *PhaseConfigProvider) Name() string

type PhaseConfigProviderOperation

type PhaseConfigProviderOperation func(*PhaseConfigProvider)

func WithArgs

func WithArgs(args ...string) PhaseConfigProviderOperation

func WithBinds

func WithBinds(binds ...string) PhaseConfigProviderOperation

func WithDaemonAccess

func WithDaemonAccess() PhaseConfigProviderOperation

func WithLifecycleProxy

func WithLifecycleProxy(lifecycle *Lifecycle) PhaseConfigProviderOperation

func WithNetwork

func WithNetwork(networkMode string) PhaseConfigProviderOperation

func WithRegistryAccess

func WithRegistryAccess(authConfig string) PhaseConfigProviderOperation

func WithRoot

func WithRoot() PhaseConfigProviderOperation

type PhaseFactory

type PhaseFactory interface {
	New(provider *PhaseConfigProvider) RunnerCleaner
}

type RunnerCleaner

type RunnerCleaner interface {
	Run(ctx context.Context) error
	Cleanup() error
}