buildkit

Documentation

Index

• type Builder
  • func New(ctx context.Context, opt Opt) (*Builder, error)
  • func (b *Builder) Build(ctx context.Context, opt backend.BuildConfig) (*builder.Result, error)
  • func (b *Builder) Cancel(ctx context.Context, id string) error
  • func (b *Builder) Close() error
  • func (b *Builder) DiskUsage(ctx context.Context) ([]*types.BuildCache, error)
  • func (b *Builder) Prune(ctx context.Context, opts types.BuildCachePruneOptions) (int64, []string, error)
  • func (b *Builder) RegisterGRPC(s *grpc.Server)
• type Opt

Types

type Builder

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

Builder can build using BuildKit backend

func New

func New(ctx context.Context, opt Opt) (*Builder, error)

New creates a new builder

func (*Builder) Build

func (b *Builder) Build(ctx context.Context, opt backend.BuildConfig) (*builder.Result, error)

Build executes a build request

func (*Builder) Cancel

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

Cancel cancels a build using ID

func (*Builder) Close

func (b *Builder) Close() error

func (*Builder) DiskUsage

func (b *Builder) DiskUsage(ctx context.Context) ([]*types.BuildCache, error)

DiskUsage returns a report about space used by build cache

func (*Builder) Prune

func (b *Builder) Prune(ctx context.Context, opts types.BuildCachePruneOptions) (int64, []string, error)

Prune clears all reclaimable build cache.

FIXME(thaJeztah): wire up new options https://github.com/moby/moby/issues/48639

func (*Builder) RegisterGRPC

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

RegisterGRPC registers controller to the grpc server.

type Opt

type Opt struct {
	SessionManager      *session.Manager
	Root                string
	EngineID            string
	Dist                images.DistributionServices
	ImageTagger         mobyexporter.ImageTagger
	NetworkController   *libnetwork.Controller
	DefaultCgroupParent string
	RegistryHosts       docker.RegistryHosts
	BuilderConfig       config.BuilderConfig
	Rootless            bool
	IdentityMapping     idtools.IdentityMapping
	DNSConfig           config.DNSConfig
	ApparmorProfile     string
	UseSnapshotter      bool
	Snapshotter         string
	ContainerdAddress   string
	ContainerdNamespace string
	Callbacks           exporter.BuildkitCallbacks
}

Opt is option struct required for creating the builder