buildkit

type BuildSpec struct {
	// Graph is the devcontainer LLB graph description. Its Platform
	// field is overridden per target platform when SolveOptions
	// requests more than one.
	Graph GraphInputs
	// Upstream, when non-nil, is built via the dockerfile.v0 frontend
	// and used as the base for Graph (Graph.BaseImage / BaseState are
	// ignored in that case).
	Upstream *DockerfileBuild
	// Labels are set on the image config, over any the base image
	// carries.
	Labels map[string]string
}

type CacheRef struct {
	Type  string
	Attrs map[string]string
}

type Connection struct {
	// BuildKit is the BuildKit control client.
	BuildKit *client.Client
	// Docker is the Engine API client. It is always set: it carries the
	// dial for the daemon's BuildKit, and image loads for a separate one.
	Docker *dockerclient.Client
	// Address is the BuildKit address dialed, or empty for the daemon's
	// built-in BuildKit.
	Address string
	// Daemon reports whether BuildKit is the Docker daemon's own.
	Daemon bool
	// contains filtered or unexported fields
}

type DockerfileBuild struct {
	// OmitSyntaxDirective removes syntax directives from the frontend input.
	OmitSyntaxDirective bool
	// ContextDir is the host directory exposed to the dockerfile
	// frontend as its build context.
	ContextDir string
	// DockerfileDir is the host directory containing the Dockerfile.
	// Empty means use ContextDir.
	DockerfileDir string
	// Filename is the Dockerfile name (default "Dockerfile").
	Filename string
	// Target selects a specific build stage.
	Target string
	// BuildArgs become "build-arg:KEY=VAL" frontend opts.
	BuildArgs map[string]string
	// Labels become "label:KEY=VAL" frontend opts.
	Labels map[string]string
}

type GraphInputs struct {
	Spec     *spec.DevContainer
	Metadata metadata.CollectOptions
	// BaseImage names the FROM image. Ignored when BaseState is set.
	BaseImage string
	// BaseState, when non-nil, is used as the starting llb.State instead
	// of llb.Image(BaseImage). This is how we chain on top of a Dockerfile
	// frontend solve in the gateway path: the upstream solve produces a
	// Reference whose ToState() becomes the base for our overlays.
	BaseState    *llb.State
	Features     []features.Resolved
	VSCodeServer *vscode.Result
	// LocalContextName names the llb.Local mount that the resolved
	// feature directories will be exposed under (each feature lives at
	// _features/<SafeID>/ within that local context).
	LocalContextName string
	// FeaturesContextSubdir is the path within the local context where
	// the staged feature directories live.
	FeaturesContextSubdir string
	// RemoteUser overrides the spec's remoteUser (empty falls back to
	// the spec, then root).
	RemoteUser string
	// ImageUser is the user configured in the base image. Features see
	// it as the container user when the spec sets no containerUser.
	// Empty means root.
	ImageUser string
	// ResolveImageConfig, when true, performs a registry roundtrip at
	// LLB marshal time to inherit ENV/USER/WORKDIR from the base image.
	// Recommended; can be disabled for offline builds. Ignored when
	// BaseState is set (the upstream solve already resolved it).
	ResolveImageConfig bool
	// Platform constrains the LLB graph to the given target platform. A
	// zero-value Platform falls back to the daemon default. Authoring the
	// graph with an explicit Platform is required for cross-arch and
	// multi-platform builds — every llb.Image / llb.Run / llb.HTTP vertex
	// inherits the constraint.
	Platform dcplatform.Platform
}

type OutputSpec struct {
	Type        string
	Attrs       map[string]string
	Destination string
}

type RegistryAuth interface {
	// Credentials returns the credentials for a registry host.
	Credentials(host string) (registryauth.Credentials, error)
	// EngineAuth returns the Engine API X-Registry-Auth value for an
	// image reference, or "" for an anonymous request.
	EngineAuth(ref string) (string, error)
}

type Result struct {
	// SolveResponse is the raw BuildKit solve response.
	SolveResponse *client.SolveResponse
}

type SolveOptions struct {
	// Address is the BuildKit endpoint. When empty, BUILDKIT_HOST is
	// consulted; when that is empty too, the Docker daemon's built-in
	// BuildKit is used through the Engine API.
	Address string
	// Docker is the Engine API client. When nil, one is created from the
	// standard DOCKER_* environment.
	Docker *dockerclient.Client
	// LocalContextName must match the name used in the LLB graph.
	LocalContextName string
	// LocalContextDir is the host directory exposed to the build under
	// LocalContextName.
	LocalContextDir string
	// Tags name the exported image.
	Tags []string
	// Push pushes the image to the registry named by Tags. With the
	// daemon's BuildKit the image is also kept in the daemon's image
	// store, from which the Engine API pushes it.
	Push bool
	// Load puts the image into the Docker daemon's image store. With the
	// daemon's BuildKit the image is exported there directly; with a
	// separate BuildKit it is streamed to the Engine API image-load
	// endpoint.
	Load bool
	// LoadWriter, when set with Load, receives a docker-format image
	// tarball. With a separate BuildKit the image is not loaded into the
	// daemon; with the daemon's BuildKit it is also kept in the daemon's
	// image store, from which the Engine API saves it.
	LoadWriter io.Writer
	// Output is a buildx exporter specification or a local destination path.
	Output string
	// OutputWriter receives archive output when dest is "-" or omitted.
	OutputWriter io.Writer
	// OutputDir, when non-empty, requests a "local" exporter writing
	// the image filesystem to this directory.
	OutputDir string
	// CacheImports / CacheExports map directly to BuildKit's options.
	CacheImports []CacheRef
	CacheExports []CacheRef
	// Platforms is the list of target platforms. SolveDevcontainer and
	// SolveDockerfile honor all entries (producing a manifest-list image
	// for >1); the bare Solve uses none.
	Platforms []string
	// NoCache disables the build cache for every step.
	NoCache bool
	// Pull always fetches referenced images from their registry. When
	// false, the daemon's BuildKit prefers images already in the local
	// image store.
	Pull bool
	// FrontendAttrs are passed through verbatim. Useful for advanced
	// callers; normally empty.
	FrontendAttrs map[string]string
	// RegistryAuth supplies registry credentials. BuildKit asks for them
	// through the client session to pull and push, and a push from the
	// daemon's image store sends them to the Engine API. When nil, the
	// docker CLI's configuration is read (registryauth.FromEnvironment).
	RegistryAuth RegistryAuth
	// Progress controls the display: "auto", "tty", "plain".
	Progress string
	// Stdout / Stderr default to os.Stdout / os.Stderr.
	Stdout io.Writer
	Stderr io.Writer
}