builder

Documentation

Index

• func Leave(ctx context.Context, txn *store.Txn, dockerCli command.Cli, opts LeaveOpts) error
• type Builder
  • func Create(ctx context.Context, txn *store.Txn, dockerCli command.Cli, opts CreateOpts) (*Builder, error)
  • func GetBuilders(dockerCli command.Cli, txn *store.Txn) ([]*Builder, error)
  • func New(dockerCli command.Cli, opts ...Option) (_ *Builder, err error)
  • func (b *Builder) Boot(ctx context.Context) (bool, error)
  • func (b *Builder) ContextName() string
  • func (b *Builder) Err() error
  • func (b *Builder) Factory(ctx context.Context, dialMeta map[string][]string) (_ driver.Factory, err error)
  • func (b *Builder) ImageOpt() (imagetools.Opt, error)
  • func (b *Builder) Inactive() bool
  • func (b *Builder) LoadNodes(ctx context.Context, opts ...LoadNodesOption) (_ []Node, err error)
  • func (b *Builder) MarshalJSON() ([]byte, error)
  • func (b *Builder) Nodes() []Node
  • func (b *Builder) Validate() error
• type CreateOpts
• type LeaveOpts
• type LoadNodesOption
  • func WithClientOpt(clientOpt ...client.ClientOpt) LoadNodesOption
  • func WithData() LoadNodesOption
  • func WithDialMeta(dialMeta map[string][]string) LoadNodesOption
• type Node
  • func (n *Node) MarshalJSON() ([]byte, error)
• type Option
  • func WithContextPathHash(contextPathHash string) Option
  • func WithName(name string) Option
  • func WithSkippedValidation() Option
  • func WithStore(txn *store.Txn) Option

Functions

func Leave

func Leave(ctx context.Context, txn *store.Txn, dockerCli command.Cli, opts LeaveOpts) error

Types

type Builder

type Builder struct {
	*store.NodeGroup
	// contains filtered or unexported fields
}

Builder represents an active builder object

func Create

func Create(ctx context.Context, txn *store.Txn, dockerCli command.Cli, opts CreateOpts) (*Builder, error)

func GetBuilders

func GetBuilders(dockerCli command.Cli, txn *store.Txn) ([]*Builder, error)

GetBuilders returns all builders

func New

func New(dockerCli command.Cli, opts ...Option) (_ *Builder, err error)

New initializes a new builder client

func (*Builder) Boot

func (b *Builder) Boot(ctx context.Context) (bool, error)

Boot bootstrap a builder

func (*Builder) ContextName

func (b *Builder) ContextName() string

ContextName returns builder context name if available.

func (*Builder) Err

func (b *Builder) Err() error

Err returns error if any.

func (*Builder) Factory

func (b *Builder) Factory(ctx context.Context, dialMeta map[string][]string) (_ driver.Factory, err error)

Factory returns the driver factory.

func (*Builder) ImageOpt

func (b *Builder) ImageOpt() (imagetools.Opt, error)

ImageOpt returns registry auth configuration

func (*Builder) Inactive

func (b *Builder) Inactive() bool

Inactive checks if all nodes are inactive for this builder.

func (*Builder) LoadNodes

func (b *Builder) LoadNodes(ctx context.Context, opts ...LoadNodesOption) (_ []Node, err error)

LoadNodes loads and returns nodes for this builder. TODO: this should be a method on a Node object and lazy load data for each driver.

func (*Builder) MarshalJSON

func (b *Builder) MarshalJSON() ([]byte, error)

func (*Builder) Nodes

func (b *Builder) Nodes() []Node

Nodes returns nodes for this builder.

func (*Builder) Validate

func (b *Builder) Validate() error

Validate validates builder context

type CreateOpts

type CreateOpts struct {
	Name                string
	Driver              string
	NodeName            string
	Platforms           []string
	BuildkitdFlags      string
	BuildkitdConfigFile string
	DriverOpts          []string
	Use                 bool
	Endpoint            string
	Append              bool
}

type LeaveOpts

type LeaveOpts struct {
	Name     string
	NodeName string
}

type LoadNodesOption

type LoadNodesOption func(*loadNodesOptions)

func WithClientOpt

func WithClientOpt(clientOpt ...client.ClientOpt) LoadNodesOption

func WithData

func WithData() LoadNodesOption

func WithDialMeta

func WithDialMeta(dialMeta map[string][]string) LoadNodesOption

type Node

type Node struct {
	store.Node
	Builder     string
	Driver      *driver.DriverHandle
	DriverInfo  *driver.Info
	ImageOpt    imagetools.Opt
	ProxyConfig map[string]string
	Version     string
	Err         error

	// worker settings
	IDs       []string
	Platforms []ocispecs.Platform
	GCPolicy  []client.PruneInfo
	Labels    map[string]string
}

func (*Node) MarshalJSON

func (n *Node) MarshalJSON() ([]byte, error)

type Option

type Option func(b *Builder)

Option provides a variadic option for configuring the builder.

func WithContextPathHash

func WithContextPathHash(contextPathHash string) Option

WithContextPathHash is used for determining pods in k8s driver instance.

func WithName

func WithName(name string) Option

WithName sets builder name.

func WithSkippedValidation

func WithSkippedValidation() Option

WithSkippedValidation skips builder context validation.

func WithStore

func WithStore(txn *store.Txn) Option

WithStore sets a store instance used at init.