build

Documentation

Index

• type Backend
  • func NewBackend(components ImageComponent, builder Builder, fsCache *fscache.FSCache, ...) (*Backend, error)
  • func (b *Backend) Build(ctx context.Context, config backend.BuildConfig) (string, error)
  • func (b *Backend) Cancel(ctx context.Context, id string) error
  • func (b *Backend) PruneCache(ctx context.Context, opts types.BuildCachePruneOptions) (*types.BuildCachePruneReport, error)
  • func (b *Backend) RegisterGRPC(s *grpc.Server)
• type Builder
• type ImageComponent
• type Tagger
  • func NewTagger(backend ImageComponent, stdout io.Writer, names []string) (*Tagger, error)
  • func (bt *Tagger) TagImages(imageID image.ID) error

Types

type Backend

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

Backend provides build functionality to the API router

func NewBackend

func NewBackend(components ImageComponent, builder Builder, fsCache *fscache.FSCache, buildkit *buildkit.Builder) (*Backend, error)

NewBackend creates a new build backend from components

func (*Backend) Build

func (b *Backend) Build(ctx context.Context, config backend.BuildConfig) (string, error)

Build builds an image from a Source

func (*Backend) Cancel

func (b *Backend) Cancel(ctx context.Context, id string) error

Cancel cancels the build by ID

func (*Backend) PruneCache

func (b *Backend) PruneCache(ctx context.Context, opts types.BuildCachePruneOptions) (*types.BuildCachePruneReport, error)

PruneCache removes all cached build sources

func (*Backend) RegisterGRPC

func (b *Backend) RegisterGRPC(s *grpc.Server)

RegisterGRPC registers buildkit controller to the grpc server.

type Builder

type Builder interface {
	Build(context.Context, backend.BuildConfig) (*builder.Result, error)
}

Builder defines interface for running a build

type ImageComponent

type ImageComponent interface {
	SquashImage(from string, to string) (string, error)
	TagImageWithReference(image.ID, reference.Named) error
}

ImageComponent provides an interface for working with images

type Tagger

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

Tagger is responsible for tagging an image created by a builder

func NewTagger

func NewTagger(backend ImageComponent, stdout io.Writer, names []string) (*Tagger, error)

NewTagger returns a new Tagger for tagging the images of a build. If any of the names are invalid tags an error is returned.

func (*Tagger) TagImages

func (bt *Tagger) TagImages(imageID image.ID) error

TagImages creates image tags for the imageID