client

Documentation

Index

• Constants
• Variables
• type CacheOptionsEntry
• type Client
  • func New(ctx context.Context, address string, opts ...ClientOpt) (*Client, error)
  • func (c *Client) Build(ctx context.Context, opt SolveOpt, product string, buildFunc gateway.BuildFunc, ...) (*SolveResponse, error)
  • func (c *Client) Close() error
  • func (c *Client) Dialer() session.Dialer
  • func (c *Client) DiskUsage(ctx context.Context, opts ...DiskUsageOption) ([]*UsageInfo, error)
  • func (c *Client) ListWorkers(ctx context.Context, opts ...ListWorkersOption) ([]*WorkerInfo, error)
  • func (c *Client) Prune(ctx context.Context, ch chan UsageInfo, opts ...PruneOption) error
  • func (c *Client) Solve(ctx context.Context, def *llb.Definition, opt SolveOpt, ...) (*SolveResponse, error)
• type ClientOpt
  • func WithContextDialer(df func(context.Context, string) (net.Conn, error)) ClientOpt
  • func WithCredentials(serverName, ca, cert, key string) ClientOpt
  • func WithFailFast() ClientOpt
  • func WithSessionDialer(dialer func(context.Context, string, map[string][]string) (net.Conn, error)) ClientOpt
  • func WithTracerDelegate(td TracerDelegate) ClientOpt
  • func WithTracerProvider(t trace.TracerProvider) ClientOpt
• type DiskUsageInfo
• type DiskUsageOption
• type ExportEntry
• type Filter
  • func WithFilter(f []string) Filter
  • func (f Filter) SetDiskUsageOption(di *DiskUsageInfo)
  • func (f Filter) SetListWorkersOption(lwi *ListWorkersInfo)
  • func (f Filter) SetPruneOption(pi *PruneInfo)
• type ListWorkersInfo
• type ListWorkersOption
• type PruneInfo
• type PruneOption
  • func WithKeepOpt(duration time.Duration, bytes int64) PruneOption
• type SolveOpt
• type SolveResponse
• type SolveStatus
• type TracerDelegate
• type UsageInfo
• type UsageRecordType
• type Vertex
• type VertexLog
• type VertexStatus
• type VertexWarning
• type WorkerInfo

Constants

const (
	ExporterImage  = "image"
	ExporterLocal  = "local"
	ExporterTar    = "tar"
	ExporterOCI    = "oci"
	ExporterDocker = "docker"
)

Variables

var PruneAll = pruneOptionFunc(func(pi *PruneInfo) {
	pi.All = true
})

Types

type CacheOptionsEntry

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

type Client

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

func New

func New(ctx context.Context, address string, opts ...ClientOpt) (*Client, error)

New returns a new buildkit client. Address can be empty for the system-default address.

func (*Client) Build

func (c *Client) Build(ctx context.Context, opt SolveOpt, product string, buildFunc gateway.BuildFunc, statusChan chan *SolveStatus) (*SolveResponse, error)

func (*Client) Close

func (c *Client) Close() error

func (*Client) Dialer

func (c *Client) Dialer() session.Dialer

func (*Client) DiskUsage

func (c *Client) DiskUsage(ctx context.Context, opts ...DiskUsageOption) ([]*UsageInfo, error)

func (*Client) ListWorkers

func (c *Client) ListWorkers(ctx context.Context, opts ...ListWorkersOption) ([]*WorkerInfo, error)

ListWorkers lists all active workers

func (*Client) Prune

func (c *Client) Prune(ctx context.Context, ch chan UsageInfo, opts ...PruneOption) error

func (*Client) Solve

func (c *Client) Solve(ctx context.Context, def *llb.Definition, opt SolveOpt, statusChan chan *SolveStatus) (*SolveResponse, error)

Solve calls Solve on the controller. def must be nil if (and only if) opt.Frontend is set.

type ClientOpt

type ClientOpt interface{}

func WithContextDialer

func WithContextDialer(df func(context.Context, string) (net.Conn, error)) ClientOpt

func WithCredentials

func WithCredentials(serverName, ca, cert, key string) ClientOpt

WithCredentials configures the TLS parameters of the client. Arguments: * serverName: specifies the name of the target server * ca: specifies the filepath of the CA certificate to use for verification * cert: specifies the filepath of the client certificate * key: specifies the filepath of the client key

func WithFailFast

func WithFailFast() ClientOpt

func WithSessionDialer

func WithSessionDialer(dialer func(context.Context, string, map[string][]string) (net.Conn, error)) ClientOpt

func WithTracerDelegate

func WithTracerDelegate(td TracerDelegate) ClientOpt

func WithTracerProvider

func WithTracerProvider(t trace.TracerProvider) ClientOpt

type DiskUsageInfo

type DiskUsageInfo struct {
	Filter []string
}

type DiskUsageOption

type DiskUsageOption interface {
	SetDiskUsageOption(*DiskUsageInfo)
}

type ExportEntry

type ExportEntry struct {
	Type      string
	Attrs     map[string]string
	Output    func(map[string]string) (io.WriteCloser, error) // for ExporterOCI and ExporterDocker
	OutputDir string                                          // for ExporterLocal
}

type Filter

type Filter []string

func WithFilter

func WithFilter(f []string) Filter

func (Filter) SetDiskUsageOption

func (f Filter) SetDiskUsageOption(di *DiskUsageInfo)

func (Filter) SetListWorkersOption

func (f Filter) SetListWorkersOption(lwi *ListWorkersInfo)

func (Filter) SetPruneOption

func (f Filter) SetPruneOption(pi *PruneInfo)

type ListWorkersInfo

type ListWorkersInfo struct {
	Filter []string
}

ListWorkersInfo is a payload for worker list query

type ListWorkersOption

type ListWorkersOption interface {
	SetListWorkersOption(*ListWorkersInfo)
}

ListWorkersOption is an option for a worker list query

type PruneInfo

type PruneInfo struct {
	Filter       []string      `json:"filter"`
	All          bool          `json:"all"`
	KeepDuration time.Duration `json:"keepDuration"`
	KeepBytes    int64         `json:"keepBytes"`
}

type PruneOption

type PruneOption interface {
	SetPruneOption(*PruneInfo)
}

func WithKeepOpt

func WithKeepOpt(duration time.Duration, bytes int64) PruneOption

type SolveOpt

type SolveOpt struct {
	Exports               []ExportEntry
	LocalDirs             map[string]string
	SharedKey             string
	Frontend              string
	FrontendAttrs         map[string]string
	FrontendInputs        map[string]llb.State
	CacheExports          []CacheOptionsEntry
	CacheImports          []CacheOptionsEntry
	Session               []session.Attachable
	AllowedEntitlements   []entitlements.Entitlement
	SharedSession         *session.Session // TODO: refactor to better session syncing
	SessionPreInitialized bool             // TODO: refactor to better session syncing
}

type SolveResponse

type SolveResponse struct {
	// ExporterResponse is also used for CacheExporter
	ExporterResponse map[string]string
}

type SolveStatus

type SolveStatus struct {
	Vertexes []*Vertex
	Statuses []*VertexStatus
	Logs     []*VertexLog
	Warnings []*VertexWarning
}

type TracerDelegate

type TracerDelegate interface {
	SetSpanExporter(context.Context, sdktrace.SpanExporter) error
}

type UsageInfo

type UsageInfo struct {
	ID      string
	Mutable bool
	InUse   bool
	Size    int64

	CreatedAt   time.Time
	LastUsedAt  *time.Time
	UsageCount  int
	Parents     []string
	Description string
	RecordType  UsageRecordType
	Shared      bool
}

type UsageRecordType

type UsageRecordType string

const (
	UsageRecordTypeInternal    UsageRecordType = "internal"
	UsageRecordTypeFrontend    UsageRecordType = "frontend"
	UsageRecordTypeLocalSource UsageRecordType = "source.local"
	UsageRecordTypeGitCheckout UsageRecordType = "source.git.checkout"
	UsageRecordTypeCacheMount  UsageRecordType = "exec.cachemount"
	UsageRecordTypeRegular     UsageRecordType = "regular"
)

type Vertex

type Vertex struct {
	Digest        digest.Digest
	Inputs        []digest.Digest
	Name          string
	Started       *time.Time
	Completed     *time.Time
	Cached        bool
	Error         string
	ProgressGroup *pb.ProgressGroup
}

type VertexLog

type VertexLog struct {
	Vertex    digest.Digest
	Stream    int
	Data      []byte
	Timestamp time.Time
}

type VertexStatus

type VertexStatus struct {
	ID        string
	Vertex    digest.Digest
	Name      string
	Total     int64
	Current   int64
	Timestamp time.Time
	Started   *time.Time
	Completed *time.Time
}

type VertexWarning

type VertexWarning struct {
	Vertex     digest.Digest
	Level      int
	Short      []byte
	Detail     [][]byte
	URL        string
	SourceInfo *pb.SourceInfo
	Range      []*pb.Range
}

type WorkerInfo

type WorkerInfo struct {
	ID        string              `json:"id"`
	Labels    map[string]string   `json:"labels"`
	Platforms []ocispecs.Platform `json:"platforms"`
	GCPolicy  []PruneInfo         `json:"gcPolicy"`
}

WorkerInfo contains information about a worker