VolumeService

This page lists the methods of VolumeService in kibotos.ctrl.v1 with the messages and enums each one uses, generated from ctrl.proto and its comments. Those that several services use are on kibotos.ctrl.v1 types.

ctrl APICalled with an Operator certificate.How to call it

VolumeService owns the Native logical Volume lifecycle. Storage profile and host implementation details remain private to the runtime.

CreateVolume

POST/kibotos.ctrl.v1.VolumeService/CreateVolumeUnary

RequestCreateVolumeRequest

metadata CommandMetadata= 1
spec VolumeSpec= 2
annotationsmap<string, string>= 3
Persisted in the same transaction as the create command, with the rules and limits of Workspace.labels and Workspace.annotations. Both are included in idempotency.
labelsmap<string, string>= 4

ResponseCreateVolumeResponse

volume Volume= 1

GetVolume

POST/kibotos.ctrl.v1.VolumeService/GetVolumeUnary

RequestGetVolumeRequest

volume_idstring= 1

ResponseGetVolumeResponse

volume Volume= 1

ListVolumes

POST/kibotos.ctrl.v1.VolumeService/ListVolumesUnary

RequestListVolumesRequest

page_sizeuint32= 1
Zero selects the server default. Values above the server maximum are rejected rather than silently changed.
page_tokenstring= 2
Opaque cursor returned by the preceding page.
include_deletedbool= 3
By default, Volumes whose deletion has completed are omitted.
label_selectormap<string, string>= 4
When non-empty, return only Volumes that carry every entry as a label with exactly that value. Keys and values must satisfy the label rules. A page token is only valid with the selector it was issued for.

ResponseListVolumesResponse

volumesrepeatedVolume= 1
next_page_tokenstring= 2
completeness Completeness= 3

ResizeVolume

ResizeVolume enlarges a Volume that is not mounted anywhere. The Volume keeps its ID, binding, mount path, and data; only its capacity moves, and only upward. A target equal to the current capacity is idempotent, a smaller one is invalid_argument, and a Volume that is still attached, or bound to a Workspace that holds an execution, is failed_precondition.

POST/kibotos.ctrl.v1.VolumeService/ResizeVolumeUnary

RequestResizeVolumeRequest

metadata CommandMetadata= 1
volume_idstring= 2
capacity_bytesuint64= 3
The capacity the Volume must have when this call succeeds. It is an absolute target, not a delta, and it must be at least the capacity the Volume already has. It is required: a resize never resolves its own target from the storage profile.

ResponseResizeVolumeResponse

volume Volume= 1

DeleteVolume

POST/kibotos.ctrl.v1.VolumeService/DeleteVolumeUnary

RequestDeleteVolumeRequest

metadata CommandMetadata= 1
volume_idstring= 2

ResponseDeleteVolumeResponse

volume Volume= 1

GetVolumeCommand

GetVolumeCommand returns the durable record of one Volume command: whether it is still processing and, once completed, its historical result. It is the query entry for a mutation whose response was lost.

POST/kibotos.ctrl.v1.VolumeService/GetVolumeCommandUnary

RequestGetVolumeCommandRequest

volume_idstring= 1
command_idstring= 2

ResponseGetVolumeCommandResponse

command VolumeCommand= 1

VolumeCommand

command_idstring= 1
volume_idstring= 2
methodstring= 3
status VolumeCommandStatus= 4
error_codeint32= 5
Canonical Connect code. A zero code on a processing command is not a completed success.
error ErrorDetail= 6
created_atgoogle.protobuf.Timestamp= 7
updated_atgoogle.protobuf.Timestamp= 8
One of result
- create CreateVolumeResponse= 9
- delete DeleteVolumeResponse= 10
- resize ResizeVolumeResponse= 11
- labels UpdateVolumeLabelsResponse= 12
- annotations UpdateVolumeAnnotationsResponse= 13

VolumeCommandStatus

VOLUME_COMMAND_STATUS_UNSPECIFIED= 0
VOLUME_COMMAND_STATUS_PROCESSING= 1
VOLUME_COMMAND_STATUS_COMPLETED= 2

UpdateVolumeLabels

UpdateVolumeLabels and UpdateVolumeAnnotations follow the rules of their Workspace counterparts.

POST/kibotos.ctrl.v1.VolumeService/UpdateVolumeLabelsUnary

RequestUpdateVolumeLabelsRequest

metadata CommandMetadata= 1
volume_idstring= 2
expected_revisionuint64= 3
The labels_revision the caller observed. Retries preserve this value.
labelsmap<string, string>= 4
The complete replacement; empty clears every label.

ResponseUpdateVolumeLabelsResponse

volume Volume= 1

UpdateVolumeAnnotations

POST/kibotos.ctrl.v1.VolumeService/UpdateVolumeAnnotationsUnary

RequestUpdateVolumeAnnotationsRequest

metadata CommandMetadata= 1
volume_idstring= 2
expected_revisionuint64= 3
The annotations_revision the caller observed. Retries preserve this value.
annotationsmap<string, string>= 4
The complete replacement; empty clears every annotation.

ResponseUpdateVolumeAnnotationsResponse

volume Volume= 1

CreateVolumeCopy Anchor Link

GetVolumeCopy Anchor Link

ListVolumesCopy Anchor Link

ResizeVolumeCopy Anchor Link

DeleteVolumeCopy Anchor Link

GetVolumeCommandCopy Anchor Link

VolumeCommandCopy Anchor Link

VolumeCommandStatusCopy Anchor Link

UpdateVolumeLabelsCopy Anchor Link

UpdateVolumeAnnotationsCopy Anchor Link

On this page