package containerd.services.images.v1

Get desktop application:
View/edit binary Protocol Buffers messages

Images is a service that allows one to register images with containerd. In containerd, an image is merely the mapping of a name to a content root, described by a descriptor. The behavior and state of image is purely dictated by the type of the descriptor. From the perspective of this service, these references are mostly shallow, in that the existence of the required content won't be validated until required by consuming services. As such, this can really be considered a "metadata service".

• rpc Create (CreateImageRequest, CreateImageResponse)

  images.proto:50

  Create an image record in the metadata store. The name of the image must be unique.

  message CreateImageRequest

  images.proto:91

  • optional Image image = 1

  message CreateImageResponse

  images.proto:95

  • optional Image image = 1

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

  images.proto:57

  Delete deletes the image by name.

  message DeleteImageRequest

  images.proto:132

  • string name = 1

  • bool sync = 2

    Sync indicates that the delete and cleanup should be done synchronously before returning to the caller Default is false

• rpc Get (GetImageRequest, GetImageResponse)

  images.proto:42

  Get returns an image by name.

  message GetImageRequest

  images.proto:83

  • string name = 1

  message GetImageResponse

  images.proto:87

  • optional Image image = 1

• rpc List (ListImagesRequest, ListImagesResponse)

  images.proto:45

  List returns a list of all images known to containerd.

  message ListImagesRequest

  images.proto:114

  • 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, images 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.

  message ListImagesResponse

  images.proto:128

  • repeated Image images = 1

• rpc Update (UpdateImageRequest, UpdateImageResponse)

  images.proto:54

  Update assigns the name to a given target image based on the provided image.

  message UpdateImageRequest

  images.proto:99

  • optional Image image = 1

    Image provides a full or partial image for update. The name field must be set or an error will be returned.

  • 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 UpdateImageResponse

  images.proto:110

  • optional Image image = 1

Used in: CreateImageRequest, CreateImageResponse, GetImageResponse, ListImagesResponse, UpdateImageRequest, UpdateImageResponse

• string name = 1

  Name provides a unique name for the image. Containerd treats this as the primary identifier.

• map<string, string> labels = 2

  Labels provides free form labels for the image. These are runtime only and do not get inherited into the package image in any way. Labels may be updated using the field mask. The combined size of a key/value pair cannot exceed 4096 bytes.

• optional types.Descriptor target = 3

  Target describes the content entry point of the image.

• optional google.protobuf.Timestamp created_at = 7

  CreatedAt is the time the image was first created.

• optional google.protobuf.Timestamp updated_at = 8

  UpdatedAt is the last time the image was mutated.