NodeRegistrationService
This page lists the methods of NodeRegistrationService in kibotos.operator.v1 with the messages and enums each one uses, generated from operator.proto and its comments. Those that several services use are on kibotos.operator.v1 types.
NodeRegistrationService is the Operator-only view and desired-state surface for nodes admitted to this control plane. It is never mounted on the Native Workspace endpoint and does not expose transport or provider locators.
ListNodeRegistrations
/kibotos.operator.v1.NodeRegistrationService/ListNodeRegistrationsUnaryListNodeRegistrationsRequestListNodeRegistrationsResponseGetNodeRegistration
/kibotos.operator.v1.NodeRegistrationService/GetNodeRegistrationUnaryGetNodeRegistrationRequestGetNodeRegistrationResponseDrainNode
/kibotos.operator.v1.NodeRegistrationService/DrainNodeUnaryDrainNodeRequestDrainNodeResponseCancelNodeDrain
/kibotos.operator.v1.NodeRegistrationService/CancelNodeDrainUnaryCancelNodeDrainRequestCancelNodeDrainResponseIsolateNode
IsolateNode records that the operator has made this node unable to write to any of its storage pools: its host is powered off, or it is cut off from its pools. ctrl cannot verify the claim, so this is an assertion by the operator and the operator carries its consequence: a node that is in fact still writing corrupts the block files it has open. It is refused while the node still has a live control session.
In one transaction ctrl then releases every use right the node held, in every pool, shared or not, and every Allocation charged to it; every Workspace whose execution was on the node fails as unavailable and retryable, and commands still addressed to the node fail. A Workspace whose objects are in a pool another node reaches can then start on that node. Its data is crash-consistent: writes still in the old host's page cache may be lost. A Workspace whose objects are in a pool only this node reaches can start again once this node, or another host reaching that pool, is back.
/kibotos.operator.v1.NodeRegistrationService/IsolateNodeUnaryIsolateNodeRequestIsolateNodeResponsereleased_volumes and released_retained_layers count the Volumes and retained layers whose use right this declaration cleared: every one the node held, whether its pool is shared with other nodes or reached only by this node.
failed_workspaces counts the Workspaces this declaration moved to a failed state because their execution was on the isolated node, whichever pools their objects are in. Each fails as unavailable and retryable.
RetireNode
RetireNode ends a node for good: a host that is gone or will not serve again. It takes a node that is DRAINED or whose current incarnation is isolated, and refuses any other as failed_precondition. A replay of the same command answers the same result.
In one transaction the node stops being a member of every pool and its pending enrollment grants are revoked. Its registration stays as a tombstone reading RETIRED; it can never register again, and enrolling, draining or isolating the same node_id is refused. A new host takes a new node_id. A pool the node alone reached is left with no member until another host declares it, and its objects wait for that host.
/kibotos.operator.v1.NodeRegistrationService/RetireNodeUnaryRetireNodeRequestRetireNodeResponseListStoragePools
/kibotos.operator.v1.NodeRegistrationService/ListStoragePoolsUnaryListStoragePoolsRequestListStoragePoolsResponseGetStoragePool
GetStoragePool reads one storage pool, with the same content ListStoragePools gives for it. A pool no node has ever declared is not_found.
/kibotos.operator.v1.NodeRegistrationService/GetStoragePoolUnaryGetStoragePoolRequestGetStoragePoolResponseSetStoragePoolCapacity
SetStoragePoolCapacity replaces the capacity placement admits new Volumes and retained layers against in one pool. It takes effect for the next placement on every node that reaches the pool, without a node restart; lowering it below what is already reserved stops new objects there and evicts nothing. It requires the pool version the caller read, and a replay of the same command returns the current pool without writing again. A pool no node has ever declared is not_found.
/kibotos.operator.v1.NodeRegistrationService/SetStoragePoolCapacityUnarySetStoragePoolCapacityRequestcapacity_bytes must be greater than zero.
SetStoragePoolCapacityResponseDeclareStoragePoolLost
DeclareStoragePoolLost records that a pool's storage is gone and will not come back. ctrl cannot verify the claim, so the operator carries its consequence. It takes a pool every member of which has its current incarnation isolated, or that has no member, and refuses any other as failed_precondition naming the members still in the way. A replay of the same command answers the same result.
In one transaction the pool's Volumes become VOLUME_STATE_LOST, its reservation is released and the removals waiting on it are dropped. A Workspace bound to a lost Volume fails to start until it is bound to another. A Workspace whose writable layer was in the pool starts with a new layer and reports RESET with RETENTION_RESET_REASON_LAYER_UNAVAILABLE. The pool id never comes back into use: a node still declaring it reports it unavailable, even with the original disk.
/kibotos.operator.v1.NodeRegistrationService/DeclareStoragePoolLostUnaryDeclareStoragePoolLostRequestDeclareStoragePoolLostResponselost_volumes counts the Volumes the declaration made VOLUME_STATE_LOST.
lost_retained_layers counts the writable layers of Workspaces not deleted that were in the pool.
discarded_cleanups counts the removals that were waiting on the pool.
ListWorkspacePlacements
ListWorkspacePlacements pages the Workspaces whose current Instance holds an unreleased Allocation, narrowed to one node, one Workspace or one Instance: where each executes now, and with which Instance. A Workspace that is stopped, deleted or not placed yet has no row. A node or Workspace that does not exist is not_found; an Instance that is not current anywhere yields an empty page, because it cannot be told apart from one that never existed. It reads ctrl's records and never calls a node.
/kibotos.operator.v1.NodeRegistrationService/ListWorkspacePlacementsUnaryListWorkspacePlacementsRequestListWorkspacePlacementsRequest names exactly one filter. The page token is bound to it, so a token is refused with any other filter.
- One of
filter
ListWorkspacePlacementsResponseworkspace_placements are ordered by workspace_id.
WorkspacePlacement
WorkspacePlacement is where one Workspace executes now.
workspace_state is the state the Workspace API reports for it.
instance_id is the Workspace's current Instance, the identity the node names that execution by.
node_id is the node holding the current Instance's Allocation.
GetOvercommitDefaults
GetOvercommitDefaults returns the cluster-wide overcommit ratios. A node's schedulable CPU and memory are the host resources it reports times the ratio in effect for it: its own override, or else this default.
/kibotos.operator.v1.NodeRegistrationService/GetOvercommitDefaultsUnaryGetOvercommitDefaultsRequestNo fields.
GetOvercommitDefaultsResponseSetOvercommitDefaults
SetOvercommitDefaults replaces both cluster-wide ratios. Nodes take the new schedulable resources without a restart; lowering them below what is already reserved stops new placement there and evicts nothing.
/kibotos.operator.v1.NodeRegistrationService/SetOvercommitDefaultsUnarySetOvercommitDefaultsRequestSetOvercommitDefaultsResponseSetNodeOvercommit
SetNodeOvercommit replaces one node's overrides. A ratio left out clears that override, so the node follows the cluster-wide default again.
/kibotos.operator.v1.NodeRegistrationService/SetNodeOvercommitUnarySetNodeOvercommitRequestA ratio left out clears this node's override for that resource.
SetNodeOvercommitResponseMoveVolume
MoveVolume moves a Volume to another storage pool. Its ID, content, capacity and binding stay the same. A node that reaches both pools copies the blocks the Volume's filesystem uses, and ctrl then records the Volume in the target pool; the copy left in the source pool is removed after.
The move is refused, and the Volume stays where it is, unless the Volume is AVAILABLE, the Workspace it is bound to, if any, has no execution (STOPPED, or FAILED with its execution released, as a start finds it), some node reaches both pools, and after the move some node still reaches the Workspace's Volume and writable layer together: failed_precondition. A target pool without room for the Volume's capacity is resource_exhausted; the Volume reserves its capacity in both pools until the move settles. A Volume or Workspace with a command in progress, and a target pool still keeping an earlier copy of the Volume for removal, answer unavailable until that is over. A Volume already in the target pool is answered at once.
The call waits for the move to settle, at most one minute and never past the request deadline. A move still copying then answers unavailable with the StoragePoolObject as it stands in the error details; the same command_id waits again, and once the move settled answers its outcome. A move that fails leaves the Volume in its pool, with the failure in the error. While the Volume moves, the Workspace it is bound to does not start, and the Volume is not resized, bound, released, deleted or exported: each answers unavailable until the move settles.
/kibotos.operator.v1.NodeRegistrationService/MoveVolumeUnaryMoveVolumeRequeststorage_pool is the pool the Volume moves to.
MoveVolumeResponseobject is the Volume once the move settled, in the target pool.
MoveWritableLayer
MoveWritableLayer moves a Workspace's writable layer to another storage pool, under the same rules as MoveVolume: the layer must have been placed by an earlier start, the Workspace must have no execution, and its layer and Volume must still share a node after the move. The layer's content moves unchanged, so the Workspace continues from it on its next start as it would have in the source pool.
/kibotos.operator.v1.NodeRegistrationService/MoveWritableLayerUnaryMoveWritableLayerRequeststorage_pool is the pool the writable layer moves to.
MoveWritableLayerResponseobject is the writable layer once the move settled, in the target pool.
ListStoragePoolObjects
ListStoragePoolObjects pages the Volumes and writable layers that live in one pool and are not deleted, those StoragePool counts in volume_count and retained_layer_count. An object moving out is listed with the pool it moves to; an object moving in is listed in its source pool until the move settles. A pool no node has ever declared is not_found.
/kibotos.operator.v1.NodeRegistrationService/ListStoragePoolObjectsUnaryListStoragePoolObjectsRequestListStoragePoolObjectsResponseGetStoragePoolObject
GetStoragePoolObject reads one Volume, or one Workspace's writable layer, where it lives, as ListStoragePoolObjects lists it. A Volume that does not exist, is deleted or has not been placed yet, and a Workspace that does not exist, is deleted or whose writable layer was never placed, are not_found.
/kibotos.operator.v1.NodeRegistrationService/GetStoragePoolObjectUnaryGetStoragePoolObjectRequestGetStoragePoolObjectRequest names exactly one object.
- One of
objectworkspace_id names the writable layer of this Workspace.
GetStoragePoolObjectResponseCreateWorkspaceOnNode
CreateWorkspaceOnNode is CreateWorkspace with its placement fixed to one node. The node is the only candidate: it must meet every constraint an ordinary placement checks, drain included, and when it does not the creation fails as an ordinary placement that found no node fails. No other node is chosen instead. Only this placement is fixed: the Workspace keeps no record of the node, and its later starts are placed as usual.
The command is the Workspace command the embedded request names: its command_id, replay, GetWorkspaceCommand and errors follow the Workspace API, and a retry or a restarted ctrl still places it on this node only. The node is part of the command's input, so the same command_id with another node, or sent to CreateWorkspace, is already_exists. A node that was never registered is not_found, and no command is admitted.
/kibotos.operator.v1.NodeRegistrationService/CreateWorkspaceOnNodeUnaryCreateWorkspaceOnNodeRequestCreateWorkspaceOnNodeResponseStartWorkspaceOnNode
StartWorkspaceOnNode is StartWorkspace with its placement fixed to one node, under the rules of CreateWorkspaceOnNode. A Workspace whose Volume or writable layer lives in a pool the node does not reach fails to start as unavailable.
/kibotos.operator.v1.NodeRegistrationService/StartWorkspaceOnNodeUnaryStartWorkspaceOnNodeRequestStartWorkspaceOnNodeResponseMessages and enums
Several methods of NodeRegistrationService use these messages and enums.
NodeResources
NodeSessionSummary
clock is ctrl's latest measurement of this node's clock, taken on the live control session. It is absent while the session is not live.
NodeClockObservation
NodeClockObservation is how far the node's wall clock is from ctrl's, as ctrl measured it around one call on the control session.
offset is the node clock minus the ctrl clock; positive means the node runs ahead.
uncertainty bounds the error of offset: half the round trip of the measuring call.
measured_at is when ctrl received the reading, on ctrl's clock.
exceeds_tolerance is true when the offset, less its uncertainty, is beyond the allowed clock skew. Such a node receives no new placement until a later measurement is back within it.
NodeObservationSummary
observation_version is the version of this observation snapshot. It is not the registration record version; NodeRegistration carries that separately under its own name so the two cannot be confused at a call site.
NodeRegistration
registration_version is this record's optimistic concurrency version. The nested observation carries its own version under a different name.
isolated is true once an operator declared this node isolated. It stays true until the node registers again with a new incarnation.
storage_pools are the pools this node declares, as of its latest observation.
schedulable is the CPU and memory placement admits against on this node.
host_usage is the node's latest usage sample. It is present only while the control session is live, and nothing places or admits by it.
memory_tight is present while the control session is live and the node judges its host's available memory too low for new Workspaces. The node refuses them and placement skips it; what already runs is not affected.
NodeMemoryTight
since is when the node began to judge its host's memory tight, on the node's clock.
OvercommitDefaults
Overcommit ratios are in thousandths: 1000 is 1x and 4500 is 4.5x. CPU and memory ratios both lie in [1, 16000].
version is the defaults' own optimistic concurrency version.
NodeOvercommit
NodeOvercommit is the ratio in effect for each resource on one node and where it comes from.
OvercommitRatio
NodeHostUsage
NodeHostUsage is the node's latest usage sample as ctrl received it. Each measurement is absent when the node could not read it. Ratios are in basis points: 10000 is 100 percent.
observed_at is when ctrl received the sample, on ctrl's clock.
vm_cpu_millis is the CPU every VM together used over the node's last sampling interval, in thousandths of one vCPU.
vm_memory_bytes is the guest memory every VM together has touched.
memory_available_bytes is the memory the host can still hand out, counting reclaimable cache.
The pressure fields are 60-second averages of the share of time tasks were stalled waiting for CPU or memory.
StoragePool
StoragePool is one storage location declared by the nodes that reach it. Volumes and retained layers live in a pool, and a Workspace runs only on a node that reaches every pool its objects live in.
attachments are the pool's members: the admitted nodes that declare it, whether or not each currently reports it available. A revoked or retired node is not one.
default_pool is true when at least one node that reaches this pool names it as its default.
capacity_bytes is the capacity placement admits new Volumes and retained layers against in this pool, as SetStoragePoolCapacity last set it. It is absent until the operator sets one, and then the pool takes no new objects.
reserved_bytes is the declared capacity of every Volume and retained layer in the pool that is not deleted, together with every one moving into the pool, the same sum placement compares with capacity_bytes. It can exceed capacity_bytes when the capacity was lowered below what is already reserved.
version is the pool's own optimistic concurrency version. It advances only when the capacity changes; what nodes report about the pool does not move it.
cleanup_count counts the copies the pool still keeps of objects that no longer live there: the source a move left, the target of a move that failed, or an object deleted while the pool had no node to remove it. A node that reaches the pool removes each; until then it takes space in the pool but reserves nothing, and the object cannot move back into the pool.
lost_at is when DeclareStoragePoolLost declared the pool lost, absent while it was not. A lost pool reserves nothing and takes no new objects.
StoragePoolAttachment
StoragePoolAttachment is one (node, pool) pair. It is read from both ends: a pool lists the nodes that reach it, and a node lists the pools it declares, so both identities are present.
default_pool is this node's own default: an object whose request names no pool is created in it.
held_object_count counts the Volumes and retained layers in this pool, not deleted, whose use right this node holds. Isolating the node releases them, and the count drops to zero.
StoragePoolObject
StoragePoolObject is a Volume or a Workspace's writable layer, and the pool it lives in.
volume_id names the Volume; it is empty for a writable layer.
workspace_id is the Workspace the writable layer belongs to, or the one the Volume is bound to; it is empty for a Volume bound to none.
capacity_bytes is the object's declared capacity, what it reserves in its pool.
moving_to is the pool a move is copying the object to, where it reserves its capacity too until the move settles. It is empty while no move is in progress.
move_command_id is the command_id of that move.
NodeAdmission
NODE_ADMISSION_UNSPECIFIED= 0NODE_ADMISSION_ADMITTED= 1NODE_ADMISSION_REVOKED= 3NODE_ADMISSION_RETIRED= 4NODE_ADMISSION_RETIRED is final: RetireNode ended the node for good.
NodeRegistrationStatus
NODE_REGISTRATION_STATUS_UNSPECIFIED= 0NODE_REGISTRATION_STATUS_SYNCING= 1NODE_REGISTRATION_STATUS_READY= 2NODE_REGISTRATION_STATUS_DRAINING= 3NODE_REGISTRATION_STATUS_DRAINED= 4NODE_REGISTRATION_STATUS_UNAVAILABLE= 5NODE_REGISTRATION_STATUS_REVOKED= 7NODE_REGISTRATION_STATUS_RETIRED= 8NODE_REGISTRATION_STATUS_RETIRED wins over REVOKED: the registration is a tombstone of a node RetireNode ended.
NodeClockSynchronization
NodeClockSynchronization is what the node host's kernel reports about its clock. UNSPECIFIED means the node could not read it.
NODE_CLOCK_SYNCHRONIZATION_UNSPECIFIED= 0NODE_CLOCK_SYNCHRONIZATION_SYNCHRONIZED= 1NODE_CLOCK_SYNCHRONIZATION_UNSYNCHRONIZED= 2
OvercommitSource
OVERCOMMIT_SOURCE_UNSPECIFIED= 0OVERCOMMIT_SOURCE_DEFAULT= 1DEFAULT is the cluster-wide default.
OVERCOMMIT_SOURCE_NODE= 2NODE is this node's own override.
StoragePoolObjectKind
STORAGE_POOL_OBJECT_KIND_UNSPECIFIED= 0STORAGE_POOL_OBJECT_KIND_VOLUME= 1STORAGE_POOL_OBJECT_KIND_WRITABLE_LAYER= 2
TemplateCatalogService
This page lists the methods of TemplateCatalogService in kibotos.operator.v1 with the messages and enums each one uses, generated from operator.proto and its comments. Those that several services use are on kibotos.operator.v1 types.
PlatformCatalogService
This page lists the methods of PlatformCatalogService in kibotos.operator.v1 with the messages and enums each one uses, generated from operator.proto and its comments. Those that several services use are on kibotos.operator.v1 types.