Kibotos
API 参考kibotos.operator.v1

PlatformCatalogService

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

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

PlatformCatalogService is the Operator-only Platform catalog surface: it answers what has been registered, which revision each PlatformKey currently defaults to, and it carries the three named catalog changes. It is never mounted on the Native Workspace endpoint, and it never calls a node.

ListPlatformRevisions

POST/kibotos.operator.v1.PlatformCatalogService/ListPlatformRevisions一元调用
请求ListPlatformRevisionsRequest

ListPlatformRevisionsRequest filters before it pages. key must carry all five fields or none of them; state UNSPECIFIED means every state.

响应ListPlatformRevisionsResponse

GetPlatformRevision

POST/kibotos.operator.v1.PlatformCatalogService/GetPlatformRevision一元调用
请求GetPlatformRevisionRequest
响应GetPlatformRevisionResponse

canonical_manifest is the exact byte sequence revision digests, so a caller can verify the two against each other without trusting this response.

ListPlatformDefaults

POST/kibotos.operator.v1.PlatformCatalogService/ListPlatformDefaults一元调用
请求ListPlatformDefaultsRequest
响应ListPlatformDefaultsResponse

ApprovePlatformRevision

POST/kibotos.operator.v1.PlatformCatalogService/ApprovePlatformRevision一元调用
请求ApprovePlatformRevisionRequest
响应ApprovePlatformRevisionResponse

WithdrawPlatformRevision

POST/kibotos.operator.v1.PlatformCatalogService/WithdrawPlatformRevision一元调用
请求WithdrawPlatformRevisionRequest

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

响应WithdrawPlatformRevisionResponse

SetPlatformDefault

POST/kibotos.operator.v1.PlatformCatalogService/SetPlatformDefault一元调用
请求SetPlatformDefaultRequest

expected_revision and expected_default_version are the compare-and-swap pair. Give both or neither: neither means this PlatformKey has no default yet.

响应SetPlatformDefaultResponse

ListPlatformRevisionBindings

POST/kibotos.operator.v1.PlatformCatalogService/ListPlatformRevisionBindings一元调用
请求ListPlatformRevisionBindingsRequest

ListPlatformRevisionBindingsRequest pages the Workspaces still bound to one exact Platform revision. It stays answerable after the revision is withdrawn: a withdrawal has no reverse action, and the Workspaces using it only leave on their own next explicit start.

响应ListPlatformRevisionBindingsResponse

WorkspaceLaunchBinding

WorkspaceLaunchBinding answers "who is still bound to this revision" and nothing else: no Workspace spec, no state, no ownership, no Platform manifest content.

消息与枚举

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

PlatformKey

PlatformKey addresses one line of Platform revisions. Every field comes from the Platform manifest; a caller cannot name a Platform any other way.

PlatformRevision

PlatformRevision is one registered Platform. revision is the sha256 digest of the canonical manifest and is the only stable name a Platform has.

PlatformDefault

PlatformDefault is the revision new Launches resolve to for one PlatformKey. version is the compare-and-swap token; it advances on every move.

PlatformRevisionState

PlatformRevisionState is derived from the authority record, not stored: a withdrawn revision stays withdrawn even though it was approved first.

  • PLATFORM_REVISION_STATE_UNSPECIFIED= 0
  • PLATFORM_REVISION_STATE_REGISTERED= 1
  • PLATFORM_REVISION_STATE_APPROVED= 2
  • PLATFORM_REVISION_STATE_WITHDRAWN= 3

本页内容