frontend

Documentation

Index

• Constants
• func BuildWithPlatform(ctx context.Context, client gwclient.Client, f PlatformBuildFunc) (*gwclient.Result, error)
• func ForwarderFromClient(ctx context.Context, client gwclient.Client) dalec.ForwarderFunc
• func GetBuildArg(client gwclient.Client, k string) (string, bool)
• func GetTargetKey(client BuildOpstGetter) string
• func LoadSpec(ctx context.Context, client *dockerui.Client, platform *ocispecs.Platform) (*dalec.Spec, error)
• func MaybeSign(ctx context.Context, client gwclient.Client, st llb.State, spec *dalec.Spec, ...) (llb.State, error)
• func RunTests(ctx context.Context, client gwclient.Client, spec *dalec.Spec, ...) error
• func SourceOptFromClient(ctx context.Context, c gwclient.Client) (dalec.SourceOpts, error)
• func SupportsDiffMerge(client gwclient.Client) bool
• func Warn(ctx context.Context, client gwclient.Client, st llb.State, msg string)
• func Warnf(ctx context.Context, client gwclient.Client, st llb.State, format string, ...)
• func WithBuiltinHandler(key string, bf gwclient.BuildFunc) func(context.Context, gwclient.Client, *BuildMux) error
• func WithTargetForwardingHandler(ctx context.Context, client gwclient.Client, m *BuildMux) error
• type BuildMux
  • func (m *BuildMux) Add(targetPath string, bf gwclient.BuildFunc, info *bktargets.Target)
  • func (m *BuildMux) Handle(ctx context.Context, client gwclient.Client) (_ *gwclient.Result, retErr error)
  • func (m *BuildMux) Handler(opts ...func(context.Context, gwclient.Client, *BuildMux) error) gwclient.BuildFunc
• type BuildOpstGetter
• type CurrentFrontend
• type PlatformBuildFunc

Constants

const (

	// KeyDefaultPlatform is the subreuqest id for returning the default platform
	// for the builder.
	KeyDefaultPlatform = "frontend.dalec.defaultPlatform"
)

Functions

func BuildWithPlatform

func BuildWithPlatform(ctx context.Context, client gwclient.Client, f PlatformBuildFunc) (*gwclient.Result, error)

BuildWithPlatform is a helper function to build a spec with a given platform It takes care of looping through each tarrget platform and executing the build with the platform args substituted in the spec. This also deals with the docker-style multi-platform output.

func ForwarderFromClient

func ForwarderFromClient(ctx context.Context, client gwclient.Client) dalec.ForwarderFunc

ForwarderFromClient creates a dalec.ForwarderFunc from a gateway client. This is used for forwarding builds to other frontends in dalec.Source2LLBGetter

func GetBuildArg

func GetBuildArg(client gwclient.Client, k string) (string, bool)

func GetTargetKey

func GetTargetKey(client BuildOpstGetter) string

GetTargetKey returns the key that should be used to select the dalec.Target from the dalec.Spec

func LoadSpec

func LoadSpec(ctx context.Context, client *dockerui.Client, platform *ocispecs.Platform) (*dalec.Spec, error)

func MaybeSign

func MaybeSign(ctx context.Context, client gwclient.Client, st llb.State, spec *dalec.Spec, targetKey string, sOpt dalec.SourceOpts) (llb.State, error)

func RunTests

func RunTests(ctx context.Context, client gwclient.Client, spec *dalec.Spec, ref gwclient.Reference, withTestDeps llb.StateOption, target string) error

Run tests runs the tests defined in the spec against the given target container.

func SourceOptFromClient

func SourceOptFromClient(ctx context.Context, c gwclient.Client) (dalec.SourceOpts, error)

func SupportsDiffMerge

func SupportsDiffMerge(client gwclient.Client) bool

SupportsDiffMerge checks if the given client supports the diff and merge operations.

func Warn

func Warn(ctx context.Context, client gwclient.Client, st llb.State, msg string)

Warn sends a warning to the client for the provided state.

func Warnf

func Warnf(ctx context.Context, client gwclient.Client, st llb.State, format string, args ...any)

func WithBuiltinHandler

func WithBuiltinHandler(key string, bf gwclient.BuildFunc) func(context.Context, gwclient.Client, *BuildMux) error

WithBuiltinHandler registers a late-binding handler for the given target key. These are only added if the target is in the spec OR the spec has no explicit targets.

func WithTargetForwardingHandler

func WithTargetForwardingHandler(ctx context.Context, client gwclient.Client, m *BuildMux) error

WithTargetForwardingHandler registers a handler for each spec target that has a custom frontend

Types

type BuildMux

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

BuildMux route handlers also must be buildkit BuildFuncs. As such a handler can itself also be a distinc BuildMux with its own set of routes. This allows handlers to also do their own routing. All logic for what to route is handled outside of the BuildMux.

BuildMux and buildkit BuildFunc have a similar relationship as http.ServeMux and http.Handler (where http.ServeMux is an http.Handler). In the same way BuildMux is a BuildFunc (or rather BuildMux.Handle is). So BuildMux can be nested.

When BuildMux calls a handler, it modifies the client to chomp off the matched route prefix. So a BuildMux with receiving a build target of mariner2/container will match on the registered handler for mariner2 then call the handler with the build target changed to just container.

Finally, BuildMux sets an extra build option on the client dalec.target=<matched prefix>. This is only done if the dalec.target option is not already set, so dalec.target is only modified once and then used in handlers to determine which target in spec.Targets applies to them.

func (*BuildMux) Add

func (m *BuildMux) Add(targetPath string, bf gwclient.BuildFunc, info *bktargets.Target)

Add adds a handler for the given target [targetKey] is the resource path to be handled

func (*BuildMux) Handle

func (m *BuildMux) Handle(ctx context.Context, client gwclient.Client) (_ *gwclient.Result, retErr error)

Handle is a gwclient.BuildFunc that routes requests to registered handlers

func (*BuildMux) Handler

func (m *BuildMux) Handler(opts ...func(context.Context, gwclient.Client, *BuildMux) error) gwclient.BuildFunc

Handler returns a gwclient.BuildFunc that uses the mux to route requests to appropriate handlers

type BuildOpstGetter

type BuildOpstGetter interface {
	BuildOpts() gwclient.BuildOpts
}

type CurrentFrontend

type CurrentFrontend interface {
	CurrentFrontend() (*llb.State, error)
}

CurrentFrontend is an interface typically implemented by a gwclient.Client This is used to get the rootfs of the current frontend.

type PlatformBuildFunc

type PlatformBuildFunc func(ctx context.Context, client gwclient.Client, platform *ocispecs.Platform, spec *dalec.Spec, targetKey string) (gwclient.Reference, *dalec.DockerImageSpec, error)