containerd.services.namespaces.v1

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

Dependencies

  • gogoproto/gogo.proto
  • google/protobuf/empty.proto
  • google/protobuf/field_mask.proto

Services

Namespaces

Description:

Namespaces provides the ability to manipulate containerd namespaces.

All objects in the system are required to be a member of a namespace. If a namespace is deleted, all objects, including containers, images and snapshots, will be deleted, as well.

Unless otherwise noted, operations in containerd apply only to the namespace supplied per request.

I hope this goes without saying, but namespaces are themselves NOT namespaced.

MethodInput TypeOutput TypeDescription
Get GetNamespaceRequest GetNamespaceResponse
List ListNamespacesRequest ListNamespacesResponse
Create CreateNamespaceRequest CreateNamespaceResponse
Update UpdateNamespaceRequest UpdateNamespaceResponse
Delete DeleteNamespaceRequest Empty

Messages

Message: Namespace

#FieldLabelTypeDescription
1 name optional string
2 labels repeated LabelsEntry

Labels provides an area to include arbitrary data on namespaces.

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.

Message: Namespace.LabelsEntry

#FieldLabelTypeDescription
1 key optional string
2 value optional string

Message: GetNamespaceRequest

#FieldLabelTypeDescription
1 name optional string

Message: GetNamespaceResponse

#FieldLabelTypeDescription
1 namespace optional Namespace

Message: ListNamespacesRequest

#FieldLabelTypeDescription
1 filter optional string

Message: ListNamespacesResponse

#FieldLabelTypeDescription
1 namespaces repeated Namespace

Message: CreateNamespaceRequest

#FieldLabelTypeDescription
1 namespace optional Namespace

Message: CreateNamespaceResponse

#FieldLabelTypeDescription
1 namespace optional Namespace

Message: UpdateNamespaceRequest

Description:

UpdateNamespaceRequest updates the metadata for a namespace.

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.

#FieldLabelTypeDescription
1 namespace optional Namespace

Namespace provides the target value, as declared by the mask, for the update.

The namespace field must be set.
2 update_mask optional FieldMask

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

For the most part, this applies only to selectively updating labels on the namespace. While field masks are typically limited to ascii alphas and digits, we just take everything after the “labels.” as the map key.

Message: UpdateNamespaceResponse

#FieldLabelTypeDescription
1 namespace optional Namespace

Message: DeleteNamespaceRequest

#FieldLabelTypeDescription
1 name optional string