Kibotos

Capability names

This page lists the capability names the server advertises in GetServerInfo, grouped by object, and the rules they follow. Before using what a name covers, check that the name is in the list. See Querying capabilities first.

Naming rules

Names follow these rules, and names added later follow them too:

  • A resource operation is written <resource>.<verb>, with the verb taken from the method name: CreateWorkspace is workspace.create, and ResizeVolume is volume.resize.
  • Changing one part of a resource is written <resource>.<part>.<verb>: UpdateWorkspaceCpu is workspace.cpu.update, and ResizeWorkspaceWritableLayer is workspace.writable_layer.resize.
  • An option or field added later to an existing operation is written <operation or resource>.<option>: workspace.stop.force, volume.storage_pool.
  • Each service on the node data plane has one name, written workspace.<service>.
  • Multiple words are joined with underscores, matching field names.

Reading the tables

  • Each section below covers one object. Names within a section are sorted, so an operation is followed by its options.
  • Since is the first version that advertises the name.
  • Most names are advertised by every deployment. A name that depends on deployment configuration says so in its section.

Template

NameCoversSince
template.getGetTemplate, GetTemplateRevisionv0.1.0
template.listListTemplatesv0.1.0

Workspace lifecycle

NameCoversSince
workspace.command.getGetWorkspaceCommandv0.1.0
workspace.createCreateWorkspacev0.1.0
workspace.deleteDeleteWorkspacev0.1.0
workspace.getGetWorkspace, GetWorkspaceCleanupv0.1.0
workspace.listListWorkspacesv0.1.0
workspace.startStartWorkspacev0.1.0
workspace.stopStopWorkspacev0.1.0
workspace.stop.forcemode set to STOP_MODE_FORCE in StopWorkspace. See Force stopv0.1.0
workspace.stop.guest_shutdownAfter the guest shuts down, the Workspace enters STOPPED with last_stop.cause set to STOP_CAUSE_GUEST_SHUTDOWN. See Shutdown from inside the guestv0.3.0

Workspace configuration

NameCoversSince
workspace.cpu.updateUpdateWorkspaceCpuv0.1.0
workspace.expiration.updateUpdateWorkspaceExpirationv0.1.0
workspace.memory.updateUpdateWorkspaceMemoryv0.1.0
workspace.volume_binding.updateUpdateWorkspaceVolumeBindingv0.1.0
workspace.writable_layer.resizeResizeWorkspaceWritableLayerv0.1.0

Workspace fields and observation

workspace.metrics.get is advertised only when the deployment has connected an instance metrics store for reads. See Resource metrics.

NameCoversSince
workspace.annotationsannotations and UpdateWorkspaceAnnotationsv0.1.0
workspace.guest_observationguest_observation on the Workspace. See Responsiveness of the guestv0.1.0
workspace.labelslabels and UpdateWorkspaceLabelsv0.1.0
workspace.metrics.getWorkspaceMetricsService/GetWorkspaceMetricsv0.3.0
workspace.session.executionEXECUTION lifetime in CreateDataPlaneSession. See Data planev0.1.0

Network policy

NameCoversSince
workspace.network_policy.destination_rulesallow and deny in the network policyv0.2.0
workspace.network_policy.egress.socks5EgressService and egresses in the network policy. See Egressv0.3.0
workspace.network_policy.resolverResolverService and resolvers in the network policy. See Resolverv0.3.0
workspace.network_policy.updateUpdateWorkspaceNetworkPolicyv0.1.0
workspace.network_policy.update.expected_revisionThe expected revision of UpdateWorkspaceNetworkPolicyv0.2.0

Data plane

NameCoversSince
workspace.desktopDesktopServicev0.1.0
workspace.filesystemFilesystemService and /v1/filesv0.1.0
workspace.filesystem.watch_dirFilesystemService/WatchDirv0.2.0
workspace.processProcessServicev0.1.0
workspace.process.resumeresume_from in ProcessService/Attach and input_offset in SendInput. See Resuming process streamsv0.2.0
workspace.service_connectionServiceConnectionService and /v1/servicev0.1.0

Volume

NameCoversSince
volume.annotationsannotations and UpdateVolumeAnnotationsv0.1.0
volume.command.getGetVolumeCommandv0.1.0
volume.createCreateVolumev0.1.0
volume.deleteDeleteVolumev0.1.0
volume.getGetVolumev0.1.0
volume.labelslabels and UpdateVolumeLabelsv0.1.0
volume.listListVolumesv0.1.0
volume.lostVolume state LOST and failure reason VOLUME_LOST, which appear after an Operator declares a storage pool lost. See Declaring a pool lostv0.3.0
volume.resizeResizeVolumev0.1.0
volume.storage_poolstorage_pool in CreateVolumev0.1.0

Transfer

NameCoversSince
transfer.deleteDeleteTransferv0.1.0
transfer.exportExportWorkspacev0.1.0
transfer.getGetTransferv0.1.0
transfer.importImportTransferv0.1.0
transfer.import.storage_poolstorage_pool in ImportTransferv0.1.0
transfer.restoreRestoreWorkspacev0.1.0

Exposure

These names are advertised only when the deployment has configured an Exposure domain. See Install the Exposure gateway.

NameCoversSince
exposure.createCreateExposurev0.1.0
exposure.getGetExposurev0.1.0
exposure.listListExposuresv0.1.0
exposure.revokeRevokeExposurev0.1.0

Interfaces without a name

GetServerInfo, CreateDataPlaneSession, RevokeWorkspaceDataPlane, and the Operator interfaces have no capability names. They are always available from v0.1.0 on.

Metrics

This page lists every metric the Kibotos processes serve at GET /metrics, generated from the source code that creates them. For which process serves which metrics and how to collect them, see Metrics.

On this page

Naming rulesReading the tablesTemplateWorkspace lifecycleWorkspace configurationWorkspace fields and observationNetwork policyData planeVolumeTransferExposureInterfaces without a name