Kibotos

能力名

本页按对象列出服务端在 GetServerInfo 中宣告的能力名，以及它们的命名规则。使用某个能力名对应的功能之前，先确认清单里有这个名字，见先查询能力。

命名规则

名字按下面的规则取，以后新增的名字也一样：

  • 资源操作写作 <资源>.<动词>，动词取自方法名：CreateWorkspace 是 workspace.create，ResizeVolume 是 volume.resize。
  • 修改资源的一部分写作 <资源>.<部分>.<动词>：UpdateWorkspaceCpu 是 workspace.cpu.update，ResizeWorkspaceWritableLayer 是 workspace.writable_layer.resize。
  • 已有操作后来增加的选项或字段写作 <操作或资源>.<选项>：workspace.stop.force、volume.storage_pool。
  • node 数据面上的每个服务一个名字，写作 workspace.<服务>。
  • 多个词之间用下划线，与字段名一致。

怎么读下面的表

  • 下面每节对应一种对象。节内按名字排序，所以操作的选项紧跟在操作后面。
  • 起始版本是第一次宣告这个名字的版本。
  • 大多数名字所有部署都会宣告。取决于部署配置的名字，在所在的节里写明条件。

Template

能力名对应起始版本
template.getGetTemplate、GetTemplateRevisionv0.1.0
template.listListTemplatesv0.1.0

Workspace 生命周期

能力名对应起始版本
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.forceStopWorkspace 的 mode 取 STOP_MODE_FORCE，见强制停止v0.1.0
workspace.stop.guest_shutdownguest 关机后 Workspace 进入 STOPPED、last_stop.cause 为 STOP_CAUSE_GUEST_SHUTDOWN，见guest 自己关机v0.3.0

Workspace 配置

能力名对应起始版本
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 的字段与观测

workspace.metrics.get 只在部署为读取接好实例指标存储时宣告，见资源读数。

能力名对应起始版本
workspace.annotationsannotations 与 UpdateWorkspaceAnnotationsv0.1.0
workspace.guest_observationWorkspace 的 guest_observation，见guest 回应情况v0.1.0
workspace.labelslabels 与 UpdateWorkspaceLabelsv0.1.0
workspace.metrics.getWorkspaceMetricsService/GetWorkspaceMetricsv0.3.0
workspace.session.executionCreateDataPlaneSession 的 EXECUTION 有效期，见数据面v0.1.0

网络策略

能力名对应起始版本
workspace.network_policy.destination_rules网络策略的 allow 与 denyv0.2.0
workspace.network_policy.egress.socks5EgressService 与网络策略的 egresses，见调用方自带的出口：Egressv0.3.0
workspace.network_policy.resolverResolverService 与网络策略的 resolvers，见调用方自选的 Resolverv0.3.0
workspace.network_policy.updateUpdateWorkspaceNetworkPolicyv0.1.0
workspace.network_policy.update.expected_revisionUpdateWorkspaceNetworkPolicy 的版本校验v0.2.0

数据面

能力名对应起始版本
workspace.desktopDesktopServicev0.1.0
workspace.filesystemFilesystemService 与 /v1/filesv0.1.0
workspace.filesystem.watch_dirFilesystemService/WatchDirv0.2.0
workspace.processProcessServicev0.1.0
workspace.process.resumeProcessService/Attach 的 resume_from 与 SendInput 的 input_offset，见进程流续传v0.2.0
workspace.service_connectionServiceConnectionService 与 /v1/servicev0.1.0

Volume

能力名对应起始版本
volume.annotationsannotations 与 UpdateVolumeAnnotationsv0.1.0
volume.command.getGetVolumeCommandv0.1.0
volume.createCreateVolumev0.1.0
volume.deleteDeleteVolumev0.1.0
volume.getGetVolumev0.1.0
volume.labelslabels 与 UpdateVolumeLabelsv0.1.0
volume.listListVolumesv0.1.0
volume.lostVolume 状态 LOST 与失败原因 VOLUME_LOST，在 Operator 宣告存储池丢失后出现，见宣告池丢失v0.3.0
volume.resizeResizeVolumev0.1.0
volume.storage_poolCreateVolume 的 storage_poolv0.1.0

Transfer

能力名对应起始版本
transfer.deleteDeleteTransferv0.1.0
transfer.exportExportWorkspacev0.1.0
transfer.getGetTransferv0.1.0
transfer.importImportTransferv0.1.0
transfer.import.storage_poolImportTransfer 的 storage_poolv0.1.0
transfer.restoreRestoreWorkspacev0.1.0

Exposure

这些名字只在部署配置了 Exposure 域名时宣告，见安装 Exposure 网关。

能力名对应起始版本
exposure.createCreateExposurev0.1.0
exposure.getGetExposurev0.1.0
exposure.listListExposuresv0.1.0
exposure.revokeRevokeExposurev0.1.0

没有能力名的接口

GetServerInfo、CreateDataPlaneSession、RevokeWorkspaceDataPlane 与 Operator 接口没有能力名，v0.1.0 起总是可用。

指标

本页列出 Kibotos 各进程在 GET /metrics 上提供的全部指标，由创建它们的源码生成，说明保持英文。哪个进程提供哪些指标、怎样采集，见指标。

本页内容

命名规则怎么读下面的表TemplateWorkspace 生命周期Workspace 配置Workspace 的字段与观测网络策略数据面VolumeTransferExposure没有能力名的接口