package pb

Get desktop application:
View/edit binary Protocol Buffers messages

BuildInput is used for BuildOp.

Used in: BuildOp

• int64 input = 1

BuildOp is used for nested build invocation. BuildOp is experimental and can break without backwards compatibility

Used in: Op

• int64 builder = 1

• map<string, BuildInput> inputs = 2

• optional Definition def = 3

• map<string, string> attrs = 4

  outputs

CacheOpt defines options specific to cache mounts

Used in: Mount

• string ID = 1

  ID is an optional namespace for the mount

• CacheSharingOpt sharing = 2

  Sharing is the sharing mode for the mount

CacheSharingOpt defines different sharing modes for cache mount

Used in: CacheOpt

• SHARED = 0

  SHARED cache mount can be used concurrently by multiple writers

• PRIVATE = 1

  PRIVATE creates a new mount if there are multiple writers

• LOCKED = 2

  LOCKED pauses second writer until first one releases the mount

Used in: FileActionCopy, FileActionMkDir, FileActionMkFile

• optional UserOpt user = 1

• optional UserOpt group = 2

Definition is the LLB definition structure with per-vertex metadata entries

Used in: moby.buildkit.v1.frontend.InputsResponse, moby.buildkit.v1.frontend.Ref, moby.buildkit.v1.frontend.SolveRequest, BuildOp

• repeated bytes def = 1

  def is a list of marshaled Op messages

• map<string, OpMetadata> metadata = 2

  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.

ExecOp executes a command in a container.

Used in: Op

• optional Meta meta = 1

• repeated Mount mounts = 2

• NetMode network = 3

• SecurityMode security = 4

Used in: OpMetadata

• bool Value = 1

Used in: FileOp

• int64 input = 1

  could be real input or target (target index + max input index)

• int64 secondaryInput = 2

  --//--

• int64 output = 3

• oneof action

  • FileActionCopy copy = 4

    FileActionCopy copies files from secondaryInput on top of input

  • FileActionMkFile mkfile = 5

    FileActionMkFile creates a new file

  • FileActionMkDir mkdir = 6

    FileActionMkDir creates a new directory

  • FileActionRm rm = 7

    FileActionRm removes a file

Used in: FileAction

• string src = 1

  src is the source path

• string dest = 2

  dest path

• optional ChownOpt owner = 3

  optional owner override

• int32 mode = 4

  optional permission bits override

• bool followSymlink = 5

  followSymlink resolves symlinks in src

• bool dirCopyContents = 6

  dirCopyContents only copies contents if src is a directory

• bool attemptUnpackDockerCompatibility = 7

  attemptUnpackDockerCompatibility detects if src is an archive to unpack it instead

• bool createDestPath = 8

  createDestPath creates dest path directories if needed

• bool allowWildcard = 9

  allowWildcard allows filepath.Match wildcards in src path

• bool allowEmptyWildcard = 10

  allowEmptyWildcard doesn't fail the whole copy if wildcard doesn't resolve to files

• int64 timestamp = 11

  optional created time override

Used in: FileAction

• string path = 1

  path for the new directory

• int32 mode = 2

  permission bits

• bool makeParents = 3

  makeParents creates parent directories as well if needed

• optional ChownOpt owner = 4

  optional owner for the new directory

• int64 timestamp = 5

  optional created time override

Used in: FileAction

• string path = 1

  path for the new file

• int32 mode = 2

  permission bits

• bytes data = 3

  data is the new file contents

• optional ChownOpt owner = 4

  optional owner for the new file

• int64 timestamp = 5

  optional created time override

Used in: FileAction

• string path = 1

  path to remove

• bool allowNotFound = 2

  allowNotFound doesn't fail the rm if file is not found

• bool allowWildcard = 3

  allowWildcard allows filepath.Match wildcards in path

Used in: Op

• repeated FileAction actions = 2

Used in: Meta

• string Host = 1

• string IP = 2

Input represents an input edge for an Op.

Used in: Op

• string digest = 1

  digest of the marshaled input Op

• int64 index = 2

  output index of the input Op

Meta is a set of arguments for ExecOp. Meta is unrelated to LLB metadata. FIXME: rename (ExecContext? ExecArgs?)

Used in: ExecOp

• repeated string args = 1

• repeated string env = 2

• string cwd = 3

• string user = 4

• optional ProxyEnv proxy_env = 5

• repeated HostIP extraHosts = 6

Mount specifies how to mount an input Op as a filesystem.

Used in: ExecOp

• int64 input = 1

• string selector = 2

• string dest = 3

• int64 output = 4

• bool readonly = 5

• MountType mountType = 6

• optional CacheOpt cacheOpt = 20

• optional SecretOpt secretOpt = 21

• optional SSHOpt SSHOpt = 22

MountType defines a type of a mount from a supported set

Used in: Mount

• BIND = 0

• SECRET = 1

• SSH = 2

• CACHE = 3

• TMPFS = 4

Used in: UserOpt

• string name = 1

• int64 input = 2

Used in: ExecOp

• UNSET = 0

  sandbox

• HOST = 1

• NONE = 2

Op represents a vertex of the LLB DAG.

• repeated Input inputs = 1

  inputs is a set of input edges.

• oneof op

  • ExecOp exec = 2

  • SourceOp source = 3

  • FileOp file = 4

  • BuildOp build = 5

• optional Platform platform = 10

• optional WorkerConstraints constraints = 11

OpMetadata is a per-vertex metadata entry, which can be defined for arbitrary Op vertex and overridable on the run time.

Used in: Definition

• bool ignore_cache = 1

  ignore_cache specifies to ignore the cache for this Op.

• map<string, string> description = 2

  Description can be used for keeping any text fields that builder doesn't parse

• optional ExportCache export_cache = 4

  index 3 reserved for WorkerConstraint in previous versions WorkerConstraint worker_constraint = 3;

• map<string, bool> caps = 5

Platform is github.com/opencontainers/image-spec/specs-go/v1.Platform

Used in: moby.buildkit.v1.frontend.ResolveImageConfigRequest, moby.buildkit.v1.types.WorkerRecord, Op

• string Architecture = 1

• string OS = 2

• string Variant = 3

• string OSVersion = 4

  unused

• repeated string OSFeatures = 5

  unused

Used in: Meta

• string http_proxy = 1

• string https_proxy = 2

• string ftp_proxy = 3

• string no_proxy = 4

SSHOpt defines options describing secret mounts

Used in: Mount

• string ID = 1

  ID of exposed ssh rule. Used for quering the value.

• uint32 uid = 2

  UID of agent socket

• uint32 gid = 3

  GID of agent socket

• uint32 mode = 4

  Mode is the filesystem mode of agent socket

• bool optional = 5

  Optional defines if ssh socket is required. Error is produced if client does not expose ssh.

SecretOpt defines options describing secret mounts

Used in: Mount

• string ID = 1

  ID of secret. Used for quering the value.

• uint32 uid = 2

  UID of secret file

• uint32 gid = 3

  GID of secret file

• uint32 mode = 4

  Mode is the filesystem mode of secret file

• bool optional = 5

  Optional defines if secret value is required. Error is produced if value is not found and optional is false.

Used in: ExecOp

• SANDBOX = 0

• INSECURE = 1

  privileged mode

SourceOp specifies a source such as build contexts and images.

Used in: Op

• string identifier = 1

  TODO: use source type or any type instead of URL protocol. identifier e.g. local://, docker-image://, git://, https://...

• map<string, string> attrs = 2

  attrs are defined in attr.go

Used in: ChownOpt

• oneof user

  • NamedUserOpt byName = 1

  • uint32 byID = 2

WorkerConstraints defines conditions for the worker

Used in: Op

• repeated string filter = 1

  containerd-style filter