Documentation ¶
Overview ¶
Package pb is a generated protocol buffer package.
Package pb provides the protobuf definition of LLB: low-level builder instruction. LLB is DAG-structured; Op represents a vertex, and Definition represents a graph.
It is generated from these files:
ops.proto
It has these top-level messages:
Op Input ExecOp Meta Mount CopyOp CopySource SourceOp BuildOp BuildInput OpMetadata WorkerConstraint Definition
Index ¶
- Constants
- Variables
- type BuildInput
- func (*BuildInput) Descriptor() ([]byte, []int)
- func (m *BuildInput) Marshal() (dAtA []byte, err error)
- func (m *BuildInput) MarshalTo(dAtA []byte) (int, error)
- func (*BuildInput) ProtoMessage()
- func (m *BuildInput) Reset()
- func (m *BuildInput) Size() (n int)
- func (m *BuildInput) String() string
- func (m *BuildInput) Unmarshal(dAtA []byte) error
- type BuildOp
- func (*BuildOp) Descriptor() ([]byte, []int)
- func (m *BuildOp) GetAttrs() map[string]string
- func (m *BuildOp) GetDef() *Definition
- func (m *BuildOp) GetInputs() map[string]*BuildInput
- func (m *BuildOp) Marshal() (dAtA []byte, err error)
- func (m *BuildOp) MarshalTo(dAtA []byte) (int, error)
- func (*BuildOp) ProtoMessage()
- func (m *BuildOp) Reset()
- func (m *BuildOp) Size() (n int)
- func (m *BuildOp) String() string
- func (m *BuildOp) Unmarshal(dAtA []byte) error
- type CopyOp
- func (*CopyOp) Descriptor() ([]byte, []int)
- func (m *CopyOp) GetDest() string
- func (m *CopyOp) GetSrc() []*CopySource
- func (m *CopyOp) Marshal() (dAtA []byte, err error)
- func (m *CopyOp) MarshalTo(dAtA []byte) (int, error)
- func (*CopyOp) ProtoMessage()
- func (m *CopyOp) Reset()
- func (m *CopyOp) Size() (n int)
- func (m *CopyOp) String() string
- func (m *CopyOp) Unmarshal(dAtA []byte) error
- type CopySource
- func (*CopySource) Descriptor() ([]byte, []int)
- func (m *CopySource) GetSelector() string
- func (m *CopySource) Marshal() (dAtA []byte, err error)
- func (m *CopySource) MarshalTo(dAtA []byte) (int, error)
- func (*CopySource) ProtoMessage()
- func (m *CopySource) Reset()
- func (m *CopySource) Size() (n int)
- func (m *CopySource) String() string
- func (m *CopySource) Unmarshal(dAtA []byte) error
- type Definition
- func (*Definition) Descriptor() ([]byte, []int)
- func (m *Definition) GetDef() [][]byte
- func (m *Definition) GetMetadata() map[github_com_opencontainers_go_digest.Digest]OpMetadata
- func (m *Definition) Marshal() (dAtA []byte, err error)
- func (m *Definition) MarshalTo(dAtA []byte) (int, error)
- func (*Definition) ProtoMessage()
- func (m *Definition) Reset()
- func (m *Definition) Size() (n int)
- func (m *Definition) String() string
- func (m *Definition) Unmarshal(dAtA []byte) error
- type ExecOp
- func (*ExecOp) Descriptor() ([]byte, []int)
- func (m *ExecOp) GetMeta() *Meta
- func (m *ExecOp) GetMounts() []*Mount
- func (m *ExecOp) Marshal() (dAtA []byte, err error)
- func (m *ExecOp) MarshalTo(dAtA []byte) (int, error)
- func (*ExecOp) ProtoMessage()
- func (m *ExecOp) Reset()
- func (m *ExecOp) Size() (n int)
- func (m *ExecOp) String() string
- func (m *ExecOp) Unmarshal(dAtA []byte) error
- type Input
- func (*Input) Descriptor() ([]byte, []int)
- func (m *Input) Marshal() (dAtA []byte, err error)
- func (m *Input) MarshalTo(dAtA []byte) (int, error)
- func (*Input) ProtoMessage()
- func (m *Input) Reset()
- func (m *Input) Size() (n int)
- func (m *Input) String() string
- func (m *Input) Unmarshal(dAtA []byte) error
- type InputIndex
- type Meta
- func (*Meta) Descriptor() ([]byte, []int)
- func (m *Meta) GetArgs() []string
- func (m *Meta) GetCwd() string
- func (m *Meta) GetEnv() []string
- func (m *Meta) GetUser() string
- func (m *Meta) Marshal() (dAtA []byte, err error)
- func (m *Meta) MarshalTo(dAtA []byte) (int, error)
- func (*Meta) ProtoMessage()
- func (m *Meta) Reset()
- func (m *Meta) Size() (n int)
- func (m *Meta) String() string
- func (m *Meta) Unmarshal(dAtA []byte) error
- type Mount
- func (*Mount) Descriptor() ([]byte, []int)
- func (m *Mount) GetDest() string
- func (m *Mount) GetReadonly() bool
- func (m *Mount) GetSelector() string
- func (m *Mount) Marshal() (dAtA []byte, err error)
- func (m *Mount) MarshalTo(dAtA []byte) (int, error)
- func (*Mount) ProtoMessage()
- func (m *Mount) Reset()
- func (m *Mount) Size() (n int)
- func (m *Mount) String() string
- func (m *Mount) Unmarshal(dAtA []byte) error
- type Op
- func (*Op) Descriptor() ([]byte, []int)
- func (m *Op) GetBuild() *BuildOp
- func (m *Op) GetCopy() *CopyOp
- func (m *Op) GetExec() *ExecOp
- func (m *Op) GetInputs() []*Input
- func (m *Op) GetOp() isOp_Op
- func (m *Op) GetSource() *SourceOp
- func (m *Op) Marshal() (dAtA []byte, err error)
- func (m *Op) MarshalTo(dAtA []byte) (int, error)
- func (*Op) ProtoMessage()
- func (m *Op) Reset()
- func (m *Op) Size() (n int)
- func (m *Op) String() string
- func (m *Op) Unmarshal(dAtA []byte) error
- func (*Op) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, ...)
- type OpMetadata
- func (*OpMetadata) Descriptor() ([]byte, []int)
- func (m *OpMetadata) GetDescription() map[string]string
- func (m *OpMetadata) GetIgnoreCache() bool
- func (m *OpMetadata) GetWorkerConstraint() *WorkerConstraint
- func (m *OpMetadata) Marshal() (dAtA []byte, err error)
- func (m *OpMetadata) MarshalTo(dAtA []byte) (int, error)
- func (*OpMetadata) ProtoMessage()
- func (m *OpMetadata) Reset()
- func (m *OpMetadata) Size() (n int)
- func (m *OpMetadata) String() string
- func (m *OpMetadata) Unmarshal(dAtA []byte) error
- type Op_Build
- type Op_Copy
- type Op_Exec
- type Op_Source
- type OutputIndex
- type SourceOp
- func (*SourceOp) Descriptor() ([]byte, []int)
- func (m *SourceOp) GetAttrs() map[string]string
- func (m *SourceOp) GetIdentifier() string
- func (m *SourceOp) Marshal() (dAtA []byte, err error)
- func (m *SourceOp) MarshalTo(dAtA []byte) (int, error)
- func (*SourceOp) ProtoMessage()
- func (m *SourceOp) Reset()
- func (m *SourceOp) Size() (n int)
- func (m *SourceOp) String() string
- func (m *SourceOp) Unmarshal(dAtA []byte) error
- type WorkerConstraint
- func (*WorkerConstraint) Descriptor() ([]byte, []int)
- func (m *WorkerConstraint) GetFilter() []string
- func (m *WorkerConstraint) Marshal() (dAtA []byte, err error)
- func (m *WorkerConstraint) MarshalTo(dAtA []byte) (int, error)
- func (*WorkerConstraint) ProtoMessage()
- func (m *WorkerConstraint) Reset()
- func (m *WorkerConstraint) Size() (n int)
- func (m *WorkerConstraint) String() string
- func (m *WorkerConstraint) Unmarshal(dAtA []byte) error
Constants ¶
const AttrExcludePatterns = "local.excludepatterns"
const AttrHTTPChecksum = "http.checksum"
const AttrHTTPFilename = "http.filename"
const AttrHTTPGID = "http.gid"
const AttrHTTPPerm = "http.perm"
const AttrHTTPUID = "http.uid"
const AttrIncludePatterns = "local.includepattern"
const AttrKeepGitDir = "git.keepgitdir"
const AttrLLBDefinitionFilename = "llbbuild.filename"
const AttrLocalSessionID = "local.session"
const LLBDefaultDefinitionFile = LLBDefinitionInput
const LLBDefinitionInput = "buildkit.llb.definition"
const RootMount = "/"
Variables ¶
var ( ErrInvalidLengthOps = fmt.Errorf("proto: negative length found during unmarshaling") ErrIntOverflowOps = fmt.Errorf("proto: integer overflow") )
Functions ¶
This section is empty.
Types ¶
type BuildInput ¶
type BuildInput struct {
Input InputIndex `protobuf:"varint,1,opt,name=input,proto3,customtype=InputIndex" json:"input"`
}
BuildInput is used for BuildOp.
func (*BuildInput) Descriptor ¶
func (*BuildInput) Descriptor() ([]byte, []int)
func (*BuildInput) Marshal ¶
func (m *BuildInput) Marshal() (dAtA []byte, err error)
func (*BuildInput) ProtoMessage ¶
func (*BuildInput) ProtoMessage()
func (*BuildInput) Reset ¶
func (m *BuildInput) Reset()
func (*BuildInput) Size ¶
func (m *BuildInput) Size() (n int)
func (*BuildInput) String ¶
func (m *BuildInput) String() string
func (*BuildInput) Unmarshal ¶
func (m *BuildInput) Unmarshal(dAtA []byte) error
type BuildOp ¶
type BuildOp struct { Builder InputIndex `protobuf:"varint,1,opt,name=builder,proto3,customtype=InputIndex" json:"builder"` Inputs map[string]*BuildInput `` /* 139-byte string literal not displayed */ Def *Definition `protobuf:"bytes,3,opt,name=def" json:"def,omitempty"` Attrs map[string]string `` /* 144-byte string literal not displayed */ }
BuildOp is used for nested build invocation.
func (*BuildOp) Descriptor ¶
func (*BuildOp) GetDef ¶
func (m *BuildOp) GetDef() *Definition
func (*BuildOp) GetInputs ¶
func (m *BuildOp) GetInputs() map[string]*BuildInput
func (*BuildOp) ProtoMessage ¶
func (*BuildOp) ProtoMessage()
type CopyOp ¶
type CopyOp struct { Src []*CopySource `protobuf:"bytes,1,rep,name=src" json:"src,omitempty"` Dest string `protobuf:"bytes,2,opt,name=dest,proto3" json:"dest,omitempty"` }
CopyOp copies files across Ops.
func (*CopyOp) Descriptor ¶
func (*CopyOp) GetSrc ¶
func (m *CopyOp) GetSrc() []*CopySource
func (*CopyOp) ProtoMessage ¶
func (*CopyOp) ProtoMessage()
type CopySource ¶
type CopySource struct { Input InputIndex `protobuf:"varint,1,opt,name=input,proto3,customtype=InputIndex" json:"input"` Selector string `protobuf:"bytes,2,opt,name=selector,proto3" json:"selector,omitempty"` }
CopySource specifies a source for CopyOp.
func (*CopySource) Descriptor ¶
func (*CopySource) Descriptor() ([]byte, []int)
func (*CopySource) GetSelector ¶
func (m *CopySource) GetSelector() string
func (*CopySource) Marshal ¶
func (m *CopySource) Marshal() (dAtA []byte, err error)
func (*CopySource) ProtoMessage ¶
func (*CopySource) ProtoMessage()
func (*CopySource) Reset ¶
func (m *CopySource) Reset()
func (*CopySource) Size ¶
func (m *CopySource) Size() (n int)
func (*CopySource) String ¶
func (m *CopySource) String() string
func (*CopySource) Unmarshal ¶
func (m *CopySource) Unmarshal(dAtA []byte) error
type Definition ¶
type Definition struct { // def is a list of marshaled Op messages Def [][]byte `protobuf:"bytes,1,rep,name=def" json:"def,omitempty"` // metadata contains metadata for the each of the Op messages. // A key must be an LLB op digest string. Currently, empty string is not expected as a key, but it may change in the future. Metadata map[github_com_opencontainers_go_digest.Digest]OpMetadata `` /* 184-byte string literal not displayed */ }
Definition is the LLB definition structure with per-vertex metadata entries
func (*Definition) Descriptor ¶
func (*Definition) Descriptor() ([]byte, []int)
func (*Definition) GetDef ¶
func (m *Definition) GetDef() [][]byte
func (*Definition) GetMetadata ¶
func (m *Definition) GetMetadata() map[github_com_opencontainers_go_digest.Digest]OpMetadata
func (*Definition) Marshal ¶
func (m *Definition) Marshal() (dAtA []byte, err error)
func (*Definition) ProtoMessage ¶
func (*Definition) ProtoMessage()
func (*Definition) Reset ¶
func (m *Definition) Reset()
func (*Definition) Size ¶
func (m *Definition) Size() (n int)
func (*Definition) String ¶
func (m *Definition) String() string
func (*Definition) Unmarshal ¶
func (m *Definition) Unmarshal(dAtA []byte) error
type ExecOp ¶
type ExecOp struct { Meta *Meta `protobuf:"bytes,1,opt,name=meta" json:"meta,omitempty"` Mounts []*Mount `protobuf:"bytes,2,rep,name=mounts" json:"mounts,omitempty"` }
ExecOp executes a command in a container.
func (*ExecOp) Descriptor ¶
func (*ExecOp) ProtoMessage ¶
func (*ExecOp) ProtoMessage()
type Input ¶
type Input struct { // digest of the marshaled input Op Digest github_com_opencontainers_go_digest.Digest `protobuf:"bytes,1,opt,name=digest,proto3,customtype=github.com/opencontainers/go-digest.Digest" json:"digest"` // output index of the input Op Index OutputIndex `protobuf:"varint,2,opt,name=index,proto3,customtype=OutputIndex" json:"index"` }
Input represents an input edge for an Op.
func (*Input) Descriptor ¶
func (*Input) ProtoMessage ¶
func (*Input) ProtoMessage()
type InputIndex ¶
type InputIndex int64
const Empty InputIndex = -1
const LLBBuilder InputIndex = -1
type Meta ¶
type Meta struct { Args []string `protobuf:"bytes,1,rep,name=args" json:"args,omitempty"` Env []string `protobuf:"bytes,2,rep,name=env" json:"env,omitempty"` Cwd string `protobuf:"bytes,3,opt,name=cwd,proto3" json:"cwd,omitempty"` User string `protobuf:"bytes,4,opt,name=user,proto3" json:"user,omitempty"` }
Meta is a set of arguments for ExecOp. Meta is unrelated to LLB metadata. FIXME: rename (ExecContext? ExecArgs?)
func (*Meta) Descriptor ¶
func (*Meta) ProtoMessage ¶
func (*Meta) ProtoMessage()
type Mount ¶
type Mount struct { Input InputIndex `protobuf:"varint,1,opt,name=input,proto3,customtype=InputIndex" json:"input"` Selector string `protobuf:"bytes,2,opt,name=selector,proto3" json:"selector,omitempty"` Dest string `protobuf:"bytes,3,opt,name=dest,proto3" json:"dest,omitempty"` Output OutputIndex `protobuf:"varint,4,opt,name=output,proto3,customtype=OutputIndex" json:"output"` Readonly bool `protobuf:"varint,5,opt,name=readonly,proto3" json:"readonly,omitempty"` }
Mount specifies how to mount an input Op as a filesystem.
func (*Mount) Descriptor ¶
func (*Mount) GetReadonly ¶
func (*Mount) GetSelector ¶
func (*Mount) ProtoMessage ¶
func (*Mount) ProtoMessage()
type Op ¶
type Op struct { // inputs is a set of input edges. Inputs []*Input `protobuf:"bytes,1,rep,name=inputs" json:"inputs,omitempty"` // Types that are valid to be assigned to Op: // *Op_Exec // *Op_Source // *Op_Copy // *Op_Build Op isOp_Op `protobuf_oneof:"op"` }
Op represents a vertex of the LLB DAG.
func (*Op) Descriptor ¶
func (*Op) ProtoMessage ¶
func (*Op) ProtoMessage()
type OpMetadata ¶
type OpMetadata struct { // ignore_cache specifies to ignore the cache for this Op. IgnoreCache bool `protobuf:"varint,1,opt,name=ignore_cache,json=ignoreCache,proto3" json:"ignore_cache,omitempty"` // Description can be used for keeping any text fields that builder doesn't parse Description map[string]string `` /* 156-byte string literal not displayed */ WorkerConstraint *WorkerConstraint `protobuf:"bytes,3,opt,name=worker_constraint,json=workerConstraint" json:"worker_constraint,omitempty"` }
OpMetadata is a per-vertex metadata entry, which can be defined for arbitrary Op vertex and overridable on the run time.
func (*OpMetadata) Descriptor ¶
func (*OpMetadata) Descriptor() ([]byte, []int)
func (*OpMetadata) GetDescription ¶
func (m *OpMetadata) GetDescription() map[string]string
func (*OpMetadata) GetIgnoreCache ¶
func (m *OpMetadata) GetIgnoreCache() bool
func (*OpMetadata) GetWorkerConstraint ¶
func (m *OpMetadata) GetWorkerConstraint() *WorkerConstraint
func (*OpMetadata) Marshal ¶
func (m *OpMetadata) Marshal() (dAtA []byte, err error)
func (*OpMetadata) ProtoMessage ¶
func (*OpMetadata) ProtoMessage()
func (*OpMetadata) Reset ¶
func (m *OpMetadata) Reset()
func (*OpMetadata) Size ¶
func (m *OpMetadata) Size() (n int)
func (*OpMetadata) String ¶
func (m *OpMetadata) String() string
func (*OpMetadata) Unmarshal ¶
func (m *OpMetadata) Unmarshal(dAtA []byte) error
type Op_Source ¶
type Op_Source struct {
Source *SourceOp `protobuf:"bytes,3,opt,name=source,oneof"`
}
type SourceOp ¶
type SourceOp struct { // TODO: use source type or any type instead of URL protocol. // identifier e.g. local://, docker-image://, git://, https://... Identifier string `protobuf:"bytes,1,opt,name=identifier,proto3" json:"identifier,omitempty"` // attrs are defined in attr.go Attrs map[string]string `` /* 144-byte string literal not displayed */ }
SourceOp specifies a source such as build contexts and images.
func (*SourceOp) Descriptor ¶
func (*SourceOp) GetIdentifier ¶
func (*SourceOp) ProtoMessage ¶
func (*SourceOp) ProtoMessage()
type WorkerConstraint ¶
type WorkerConstraint struct {
Filter []string `protobuf:"bytes,1,rep,name=filter" json:"filter,omitempty"`
}
WorkerConstraint is experimental and likely to be changed.
func (*WorkerConstraint) Descriptor ¶
func (*WorkerConstraint) Descriptor() ([]byte, []int)
func (*WorkerConstraint) GetFilter ¶
func (m *WorkerConstraint) GetFilter() []string
func (*WorkerConstraint) Marshal ¶
func (m *WorkerConstraint) Marshal() (dAtA []byte, err error)
func (*WorkerConstraint) ProtoMessage ¶
func (*WorkerConstraint) ProtoMessage()
func (*WorkerConstraint) Reset ¶
func (m *WorkerConstraint) Reset()
func (*WorkerConstraint) Size ¶
func (m *WorkerConstraint) Size() (n int)
func (*WorkerConstraint) String ¶
func (m *WorkerConstraint) String() string
func (*WorkerConstraint) Unmarshal ¶
func (m *WorkerConstraint) Unmarshal(dAtA []byte) error