Kibotos
API 参考kibotos.operator.v1

TemplateCatalogService

本页列出 kibotos.operator.v1 中 TemplateCatalogService 的方法及每个方法用到的消息与枚举,由 operator.proto 及其注释生成,注释保持英文。多个服务共用的消息与枚举见 kibotos.operator.v1 类型。

ctrl API使用 Operator 证书调用。调用方式

TemplateCatalogService is the Operator-only Template catalog admission surface: it answers which revisions a Template may be created from and which one it defaults to, and it carries the three named catalog changes. Template admission never names a Platform revision and never moves a PlatformKey default; the two catalogs are the two halves of one admission model and each half writes only its own objects. It is never mounted on the Native Workspace endpoint, and it never calls a node.

ListTemplateRevisionAdmissions

POST/kibotos.operator.v1.TemplateCatalogService/ListTemplateRevisionAdmissions一元调用
请求ListTemplateRevisionAdmissionsRequest

ListTemplateRevisionAdmissionsRequest pages one Template's revisions in bytewise revision order. template_id is required: the admission surface answers about one Template at a time.

响应ListTemplateRevisionAdmissionsResponse

GetTemplateDefault

POST/kibotos.operator.v1.TemplateCatalogService/GetTemplateDefault一元调用
请求GetTemplateDefaultRequest
响应GetTemplateDefaultResponse

SetTemplateRevisionSelection

POST/kibotos.operator.v1.TemplateCatalogService/SetTemplateRevisionSelection一元调用
请求SetTemplateRevisionSelectionRequest

selectable true must come without a reason and clears any recorded one; selectable false requires one of the two recorded reasons.

响应SetTemplateRevisionSelectionResponse

SetTemplateDefault

POST/kibotos.operator.v1.TemplateCatalogService/SetTemplateDefault一元调用
请求SetTemplateDefaultRequest

expected_revision is the compare-and-swap token. Pass expect_no_default instead to state that this Template has no default yet; passing neither or both is rejected, because a caller who believes it is swapping must not submit an unconditional write.

响应SetTemplateDefaultResponse

WithdrawTemplateRevision

POST/kibotos.operator.v1.TemplateCatalogService/WithdrawTemplateRevision一元调用
请求WithdrawTemplateRevisionRequest

reason is required and must already be normalized; a withdrawal without a recorded reason leaves nobody able to say why the Template revision went away.

响应WithdrawTemplateRevisionResponse

消息与枚举

TemplateCatalogService 的多个方法用到以下消息与枚举。

TemplateRevisionAdmission

TemplateRevisionAdmission is one registered Template revision and the two admission facts an Operator can change about it. It carries no Platform revision: which Platform a Workspace launches on is resolved by ctrl, not selected here.

TemplateDefault

TemplateDefault is the revision new Workspaces use when none is given. revision is empty when this Template has no default yet.

TemplateSelectionState

TemplateSelectionState is derived from the stored revision, not a persisted state machine: a withdrawn revision is never selectable again.

  • TEMPLATE_SELECTION_STATE_UNSPECIFIED= 0
  • TEMPLATE_SELECTION_STATE_SELECTABLE= 1
  • TEMPLATE_SELECTION_STATE_NOT_SELECTABLE= 2

本页内容