package containerd.services.containers.v1

Get desktop application:
View/edit binary Protocol Buffers messages

Containers provides metadata storage for containers used in the execution service. The objects here provide an state-independent view of containers for use in management and resource pinning. From that perspective, containers do not have a "state" but rather this is the set of resources that will be considered in use by the container. From the perspective of the execution service, these objects represent the base parameters for creating a container process. In general, when looking to add fields for this type, first ask yourself whether or not the function of the field has to do with runtime execution or is invariant of the runtime state of the container. If it has to do with runtime, or changes as the "container" is started and stops, it probably doesn't belong on this object.

• rpc Create (CreateContainerRequest, CreateContainerResponse)

  containers.proto:49

  message CreateContainerRequest

  containers.proto:145

  • optional Container container = 1

  message CreateContainerResponse

  containers.proto:149

  • optional Container container = 1

• rpc Delete (DeleteContainerRequest, google.protobuf.Empty)

  containers.proto:51

  message DeleteContainerRequest

  containers.proto:173

  • string id = 1

• rpc Get (GetContainerRequest, GetContainerResponse)

  containers.proto:46

  message GetContainerRequest

  containers.proto:119

  • string id = 1

  message GetContainerResponse

  containers.proto:123

  • optional Container container = 1

• rpc List (ListContainersRequest, ListContainersResponse)

  containers.proto:47

  message ListContainersResponse

  containers.proto:141

  • repeated Container containers = 1

• rpc ListStream (ListContainersRequest, stream ListContainerMessage)

  containers.proto:48

  message ListContainerMessage

  containers.proto:177

  • optional Container container = 1

• rpc Update (UpdateContainerRequest, UpdateContainerResponse)

  containers.proto:50

  message UpdateContainerRequest

  containers.proto:158

  UpdateContainerRequest updates the metadata on one or more container. The operation should follow semantics described in https://developers.google.com/protocol-buffers/docs/reference/csharp/class/google/protobuf/well-known-types/field-mask, unless otherwise qualified.

  • optional Container container = 1

    Container provides the target values, as declared by the mask, for the update. The ID field must be set.

  • optional google.protobuf.FieldMask update_mask = 2

    UpdateMask specifies which fields to perform the update on. If empty, the operation applies to all fields.

  message UpdateContainerResponse

  containers.proto:169

  • optional Container container = 1

Used in: CreateContainerRequest, CreateContainerResponse, GetContainerResponse, ListContainerMessage, ListContainersResponse, UpdateContainerRequest, UpdateContainerResponse

• string id = 1

  ID is the user-specified identifier. This field may not be updated.

• map<string, string> labels = 2

  Labels provides an area to include arbitrary data on containers. The combined size of a key/value pair cannot exceed 4096 bytes. Note that to add a new value to this field, read the existing set and include the entire result in the update call.

• string image = 3

  Image contains the reference of the image used to build the specification and snapshots for running this container. If this field is updated, the spec and rootfs needed to updated, as well.

• optional Container.Runtime runtime = 4

  Runtime specifies which runtime to use for executing this container.

• optional google.protobuf.Any spec = 5

  Spec to be used when creating the container. This is runtime specific.

• string snapshotter = 6

  Snapshotter specifies the snapshotter name used for rootfs

• string snapshot_key = 7

  SnapshotKey specifies the snapshot key to use for the container's root filesystem. When starting a task from this container, a caller should look up the mounts from the snapshot service and include those on the task create request. Snapshots referenced in this field will not be garbage collected. This field is set to empty when the rootfs is not a snapshot. This field may be updated.

• optional google.protobuf.Timestamp created_at = 8

  CreatedAt is the time the container was first created.

• optional google.protobuf.Timestamp updated_at = 9

  UpdatedAt is the last time the container was mutated.

• map<string, google.protobuf.Any> extensions = 10

  Extensions allow clients to provide zero or more blobs that are directly associated with the container. One may provide protobuf, json, or other encoding formats. The primary use of this is to further decorate the container object with fields that may be specific to a client integration. The key portion of this map should identify a "name" for the extension that should be unique against other extensions. When updating extension data, one should only update the specified extension using field paths to select a specific map key.

Used in: Container

• string name = 1

  Name is the name of the runtime.

• optional google.protobuf.Any options = 2

  Options specify additional runtime initialization options.

Used as request type in: Containers.List, Containers.ListStream

• repeated string filters = 1

  Filters contains one or more filters using the syntax defined in the containerd filter package. The returned result will be those that match any of the provided filters. Expanded, containers that match the following will be returned: filters[0] or filters[1] or ... or filters[n-1] or filters[n] If filters is zero-length or nil, all items will be returned.