containerd.services.images.v1

github.com/containerd/containerd/api/services/images/v1/images.proto (syntax: proto3)

Dependencies

  • gogoproto/gogo.proto
  • google/protobuf/empty.proto
  • google/protobuf/field_mask.proto
  • google/protobuf/timestamp.proto
  • github.com/containerd/containerd/api/types/descriptor.proto

Services

Images

Description:

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”.

MethodInput TypeOutput TypeDescription
Get GetImageRequest GetImageResponse

Get returns an image by name.
List ListImagesRequest ListImagesResponse

List returns a list of all images known to containerd.
Create CreateImageRequest CreateImageResponse

Create an image record in the metadata store.

The name of the image must be unique.
Update UpdateImageRequest UpdateImageResponse

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

Delete deletes the image by name.

Messages

Message: Image

#FieldLabelTypeDescription
1 name optional string

Name provides a unique name for the image.

Containerd treats this as the primary identifier.
2 labels repeated LabelsEntry

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.
3 target optional Descriptor

Target describes the content entry point of the image.
7 created_at optional Timestamp

CreatedAt is the time the image was first created.
8 updated_at optional Timestamp

UpdatedAt is the last time the image was mutated.

Message: Image.LabelsEntry

#FieldLabelTypeDescription
1 key optional string
2 value optional string

Message: GetImageRequest

#FieldLabelTypeDescription
1 name optional string

Message: GetImageResponse

#FieldLabelTypeDescription
1 image optional Image

Message: CreateImageRequest

#FieldLabelTypeDescription
1 image optional Image

Message: CreateImageResponse

#FieldLabelTypeDescription
1 image optional Image

Message: UpdateImageRequest

#FieldLabelTypeDescription
1 image optional Image

Image provides a full or partial image for update.

The name field must be set or an error will be returned.
2 update_mask optional FieldMask

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

Message: UpdateImageResponse

#FieldLabelTypeDescription
1 image optional Image

Message: ListImagesRequest

#FieldLabelTypeDescription
1 filters repeated string

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

#FieldLabelTypeDescription
1 images repeated Image

Message: DeleteImageRequest

#FieldLabelTypeDescription
1 name optional string