buildkit

Documentation

Overview

Package buildkit implements a compiler for turning Blubber configuration into a valid llb.State graph.

Index

• func Build(ctx context.Context, c client.Client) (*client.Result, error)
• func Compile(cfg *config.Config, variant string) (*bytes.Buffer, error)
• func CompileToLLB(ctx context.Context, ebo *ExtraBuildOptions, cfg *config.Config, ...) (*llb.State, *d2llb.Image, error)
• type ExtraBuildOptions
  • func ParseExtraOptions(ops map[string]string) (*ExtraBuildOptions, error)
  • func (ebo *ExtraBuildOptions) EntrypointArgs() []string
  • func (ebo *ExtraBuildOptions) RunEntrypoint() bool
  • func (ebo *ExtraBuildOptions) RunVariantEnvironment() map[string]string

Functions

func Build

func Build(ctx context.Context, c client.Client) (*client.Result, error)

Build handles BuildKit client requests for the Blubber gateway.

When performing a multi-platform build, the final exported manifest will be an OCI image index (aka "fat" manifest) and multiple sub manifests will be created for each platform that contain the actual image layers.

See https://github.com/opencontainers/image-spec/blob/main/image-index.md

For a single platform build, the export will be a normal single manifest with image layers.

See https://github.com/opencontainers/image-spec/blob/main/manifest.md

func Compile

func Compile(cfg *config.Config, variant string) (*bytes.Buffer, error)

Compile takes a parsed config.Config and a configured variant name and returns an llb.State graph as JSON.

func CompileToLLB

func CompileToLLB(
	ctx context.Context,
	ebo *ExtraBuildOptions,
	cfg *config.Config,
	variant string,
	convertOpts d2llb.ConvertOpt,
) (*llb.State, *d2llb.Image, error)

CompileToLLB takes a parsed config.Config and a configured variant name and returns an llb.State graph.

Types

type ExtraBuildOptions

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

ExtraBuildOptions stores options to configure the build process. These are not BuildKit options, but additional configuration implemented by this Blubber BuildKit frontend

func ParseExtraOptions

func ParseExtraOptions(ops map[string]string) (*ExtraBuildOptions, error)

ParseExtraOptions parses and returns a newly created ExtraBuildOption

func (*ExtraBuildOptions) EntrypointArgs

func (ebo *ExtraBuildOptions) EntrypointArgs() []string

EntrypointArgs returns ebo.entrypointArgs

func (*ExtraBuildOptions) RunEntrypoint

func (ebo *ExtraBuildOptions) RunEntrypoint() bool

RunEntrypoint returns ebo.runEntrypoint

func (*ExtraBuildOptions) RunVariantEnvironment

func (ebo *ExtraBuildOptions) RunVariantEnvironment() map[string]string

RunVariantEnvironment returns ebo.runVariantEnvironment