earthfile2llb

Documentation

Index

• func Earthfile2LLB(ctx context.Context, target domain.Target, opt ConvertOpt) (mts *states.MultiTarget, err error)
• func GetTargets(filename string) ([]string, error)
• func ParseDebug(filename string) error
• type ConvertOpt
• type Converter
  • func NewConverter(ctx context.Context, target domain.Target, bc *buildcontext.Data, ...) (*Converter, error)
  • func (c *Converter) Arg(ctx context.Context, argKey string, defaultArgValue string)
  • func (c *Converter) Build(ctx context.Context, fullTargetName string, buildArgs []string) (*states.MultiTarget, error)
  • func (c *Converter) Cmd(ctx context.Context, cmdArgs []string, isWithShell bool)
  • func (c *Converter) CopyArtifact(ctx context.Context, artifactName string, dest string, buildArgs []string, ...) error
  • func (c *Converter) CopyClassical(ctx context.Context, srcs []string, dest string, isDir bool, chown string)
  • func (c *Converter) DockerLoadOld(ctx context.Context, targetName string, dockerTag string, buildArgs []string) error
  • func (c *Converter) DockerPullOld(ctx context.Context, dockerTag string) error
  • func (c *Converter) Entrypoint(ctx context.Context, entrypointArgs []string, isWithShell bool)
  • func (c *Converter) Env(ctx context.Context, envKey string, envValue string)
  • func (c *Converter) ExpandArgs(word string) string
  • func (c *Converter) Expose(ctx context.Context, ports []string)
  • func (c *Converter) FinalizeStates(ctx context.Context) (*states.MultiTarget, error)
  • func (c *Converter) From(ctx context.Context, imageName string, buildArgs []string) error
  • func (c *Converter) FromDockerfile(ctx context.Context, contextPath string, dfPath string, dfTarget string, ...) error
  • func (c *Converter) GitClone(ctx context.Context, gitURL string, branch string, dest string) error
  • func (c *Converter) Healthcheck(ctx context.Context, isNone bool, cmdArgs []string, interval time.Duration, ...)
  • func (c *Converter) Label(ctx context.Context, labels map[string]string)
  • func (c *Converter) Run(ctx context.Context, args []string, mounts []string, secretKeyValues []string, ...) error
  • func (c *Converter) SaveArtifact(ctx context.Context, saveFrom string, saveTo string, saveAsLocalTo string) error
  • func (c *Converter) SaveImage(ctx context.Context, imageNames []string, pushImages bool) error
  • func (c *Converter) User(ctx context.Context, user string)
  • func (c *Converter) Volume(ctx context.Context, volumes []string)
  • func (c *Converter) WithDockerRun(ctx context.Context, args []string, opt WithDockerOpt) error
  • func (c *Converter) Workdir(ctx context.Context, workdirPath string)
• type DockerLoadOpt
• type StringSliceFlag
  • func (ssf *StringSliceFlag) Set(arg string) error
  • func (ssf *StringSliceFlag) String() string
• type WithDockerOpt

Functions

func Earthfile2LLB

func Earthfile2LLB(ctx context.Context, target domain.Target, opt ConvertOpt) (mts *states.MultiTarget, err error)

Earthfile2LLB parses a earthfile and executes the statements for a given target.

func GetTargets

func GetTargets(filename string) ([]string, error)

GetTargets returns a list of targets from an Earthfile

func ParseDebug

func ParseDebug(filename string) error

ParseDebug parses a earthfile and prints debug information about it.

Types

type ConvertOpt

type ConvertOpt struct {
	// GwClient is the BuildKit gateway client.
	GwClient gwclient.Client
	// Resolver is the build context resolver.
	Resolver *buildcontext.Resolver
	// The resolve mode for referenced images (force pull or prefer local).
	ImageResolveMode llb.ResolveMode
	// DockerBuilderFun is a fun that can be used to execute an image build. This
	// is used as part of operations like DOCKER LOAD and DOCKER PULL, where
	// a tar image is needed in the middle of a build.
	DockerBuilderFun states.DockerBuilderFun
	// CleanCollection is a collection of cleanup functions.
	CleanCollection *cleanup.Collection
	// Visited is a collection of target states which have been converted to LLB.
	// This is used for deduplication and infinite cycle detection.
	Visited *states.VisitedCollection
	// VarCollection is a collection of build args used for overriding args in the build.
	VarCollection *variables.Collection
	// A cache for image solves. depTargetInputHash -> context containing image.tar.
	SolveCache map[string]llb.State
	// BuildContextProvider is the provider used for local build context files.
	BuildContextProvider *provider.BuildContextProvider
	// MetaResolver is the image meta resolver to use for resolving image metadata.
	MetaResolver llb.ImageMetaResolver
}

ConvertOpt holds conversion parameters needed for conversion.

type Converter

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

Converter turns earth commands to buildkit LLB representation.

func NewConverter

func NewConverter(ctx context.Context, target domain.Target, bc *buildcontext.Data, opt ConvertOpt) (*Converter, error)

NewConverter constructs a new converter for a given earth target.

func (*Converter) Arg

func (c *Converter) Arg(ctx context.Context, argKey string, defaultArgValue string)

Arg applies the ARG command.

func (*Converter) Build

func (c *Converter) Build(ctx context.Context, fullTargetName string, buildArgs []string) (*states.MultiTarget, error)

Build applies the earth BUILD command.

func (*Converter) Cmd

func (c *Converter) Cmd(ctx context.Context, cmdArgs []string, isWithShell bool)

Cmd applies the CMD command.

func (*Converter) CopyArtifact

func (c *Converter) CopyArtifact(ctx context.Context, artifactName string, dest string, buildArgs []string, isDir bool, chown string) error

CopyArtifact applies the earth COPY artifact command.

func (*Converter) CopyClassical

func (c *Converter) CopyClassical(ctx context.Context, srcs []string, dest string, isDir bool, chown string)

CopyClassical applies the earth COPY command, with classical args.

func (*Converter) DockerLoadOld

func (c *Converter) DockerLoadOld(ctx context.Context, targetName string, dockerTag string, buildArgs []string) error

DockerLoadOld applies the DOCKER LOAD command (outside of WITH DOCKER).

func (*Converter) DockerPullOld

func (c *Converter) DockerPullOld(ctx context.Context, dockerTag string) error

DockerPullOld applies the DOCKER PULL command (outside of WITH DOCKER).

func (*Converter) Entrypoint

func (c *Converter) Entrypoint(ctx context.Context, entrypointArgs []string, isWithShell bool)

Entrypoint applies the ENTRYPOINT command.

func (*Converter) Env

func (c *Converter) Env(ctx context.Context, envKey string, envValue string)

Env applies the ENV command.

func (*Converter) ExpandArgs

func (c *Converter) ExpandArgs(word string) string

ExpandArgs expands args in the provided word.

func (*Converter) Expose

func (c *Converter) Expose(ctx context.Context, ports []string)

Expose applies the EXPOSE command.

func (*Converter) FinalizeStates

func (c *Converter) FinalizeStates(ctx context.Context) (*states.MultiTarget, error)

FinalizeStates returns the LLB states.

func (*Converter) From

func (c *Converter) From(ctx context.Context, imageName string, buildArgs []string) error

From applies the earth FROM command.

func (*Converter) FromDockerfile

func (c *Converter) FromDockerfile(ctx context.Context, contextPath string, dfPath string, dfTarget string, buildArgs []string) error

FromDockerfile applies the earth FROM DOCKERFILE command.

func (*Converter) GitClone

func (c *Converter) GitClone(ctx context.Context, gitURL string, branch string, dest string) error

GitClone applies the GIT CLONE command.

func (*Converter) Healthcheck

func (c *Converter) Healthcheck(ctx context.Context, isNone bool, cmdArgs []string, interval time.Duration, timeout time.Duration, startPeriod time.Duration, retries int)

Healthcheck applies the HEALTHCHECK command.

func (*Converter) Label

func (c *Converter) Label(ctx context.Context, labels map[string]string)

Label applies the LABEL command.

func (*Converter) Run

func (c *Converter) Run(ctx context.Context, args []string, mounts []string, secretKeyValues []string, privileged bool, withEntrypoint bool, withDocker bool, isWithShell bool, pushFlag bool, withSSH bool) error

Run applies the earth RUN command.

func (*Converter) SaveArtifact

func (c *Converter) SaveArtifact(ctx context.Context, saveFrom string, saveTo string, saveAsLocalTo string) error

SaveArtifact applies the earth SAVE ARTIFACT command.

func (*Converter) SaveImage

func (c *Converter) SaveImage(ctx context.Context, imageNames []string, pushImages bool) error

SaveImage applies the earth SAVE IMAGE command.

func (*Converter) User

func (c *Converter) User(ctx context.Context, user string)

User applies the USER command.

func (*Converter) Volume

func (c *Converter) Volume(ctx context.Context, volumes []string)

Volume applies the VOLUME command.

func (*Converter) WithDockerRun

func (c *Converter) WithDockerRun(ctx context.Context, args []string, opt WithDockerOpt) error

WithDockerRun applies an entire WITH DOCKER ... RUN ... END clause.

func (*Converter) Workdir

func (c *Converter) Workdir(ctx context.Context, workdirPath string)

Workdir applies the WORKDIR command.

type DockerLoadOpt

type DockerLoadOpt struct {
	Target    string
	ImageName string
	BuildArgs []string
}

DockerLoadOpt holds parameters for WITH DOCKER --load parameter.

type StringSliceFlag

type StringSliceFlag struct {
	Args []string
}

StringSliceFlag is a flag backed by a string slice.

func (*StringSliceFlag) Set

func (ssf *StringSliceFlag) Set(arg string) error

Set adds a flag value to the string slice.

func (*StringSliceFlag) String

func (ssf *StringSliceFlag) String() string

String returns a string representation of the flag.

type WithDockerOpt

type WithDockerOpt struct {
	Mounts          []string
	Secrets         []string
	WithShell       bool
	WithEntrypoint  bool
	Pulls           []string
	Loads           []DockerLoadOpt
	ComposeFiles    []string
	ComposeServices []string
}

WithDockerOpt holds parameters for WITH DOCKER run.