kibo template
本页列出 kibo template 及其子命令的用法、示例与参数,由 kibo 的源码生成;说明文字与 kibo --help 相同,为英文。
Build, publish, admit and discover Workspace Templates.
本页的每个命令还接受全局参数 --endpoint、--json 与 --timeout,见 kibo CLI 参考。
子命令:
kibo template approve: Make one Template revision selectablekibo template disable: Stop one Template revision from being selectablekibo template get: Get a Template or exact revisionkibo template list: List Templateskibo template prepare: Prepare and verify an exact Template launch on the nodekibo template publish: Publish one verified rootfs result to ctrlkibo template set-default: Point a Template at one of its revisionskibo template withdraw: Withdraw one Template revision for good
kibo template approve
Makes one published Template revision selectable, so new Workspaces may be created from it. It changes nothing else: the Template keeps whatever default it had, and no Platform revision is named or moved. Picking the Platform a Workspace launches on is a separate decision, taken with kibo platform.
kibo template approve <template-id> [flags]| 参数 | 默认值 | 说明 |
|---|---|---|
--command-id <key> | idempotency key for this change; see kibo help command-ids | |
--revision <revision> | 必填 | exact Template revision the change applies to |
kibo template disable
Takes one Template revision out of the selectable set, so no new Workspace is created from it. Workspaces already created from it keep running. A reason is required and must be admin-disabled or admission-rejected, so the recorded answer to "why can nobody pick this revision" is one of a known few. The revision stays registered: kibo template approve puts it back.
kibo template disable <template-id> [flags]| 参数 | 默认值 | 说明 |
|---|---|---|
--command-id <key> | idempotency key for this change; see kibo help command-ids | |
--reason <string> | 必填 | why the revision is not selectable: admin-disabled or admission-rejected |
--revision <revision> | 必填 | exact Template revision the change applies to |
kibo template get
Get a Template or exact revision.
kibo template get <template-id> [flags]| 参数 | 默认值 | 说明 |
|---|---|---|
--revision <revision> | exact Template revision; the default revision when omitted |
kibo template list
List Templates.
kibo template list [flags]也可以写作 kibo template ls。
示例:
kibo template list
kibo template list --selection any --wide| 参数 | 默认值 | 说明 |
|---|---|---|
--delivery <filter> | any | delivery filter: any, ready, not-ready, or unknown |
--page-size <number> | maximum number of results on a page | |
--page-token <token> | token from the Next line of the previous page | |
-q, --quiet | print only the IDs of the resources in the result | |
--selection <filter> | selectable | selection filter: selectable, not-selectable, or any |
--wide | show every field, including revisions and full digests |
kibo template prepare
Prepare and verify an exact Template launch on the node.
kibo template prepare <template-id> [flags]| 参数 | 默认值 | 说明 |
|---|---|---|
--command-id <key> | idempotency key for this change; see kibo help command-ids | |
--no-wait | return once the preparation has started instead of waiting for it | |
--node <id> | id of the node to warm; required, preparation targets one node | |
--platform-revision <revision> | Platform revision, used only to choose between candidates | |
--revision <revision> | Template revision, used only to choose between candidates | |
--wait-timeout <duration> | 1h | total time to wait for the preparation to reach a terminal state |
kibo template publish
Publish one verified rootfs result to ctrl.
kibo template publish <build-result-directory> [flags]| 参数 | 默认值 | 说明 |
|---|---|---|
--build-cache-root <directory> | read-only artifact stage cache directory containing the Kibotos marker and the stages/ directory | |
--command-id <key> | idempotency key for this change; see kibo help command-ids | |
--wait-timeout <duration> | 2h | maximum time to wait for durable background finalization; timing out does not abort it |
kibo template set-default
Moves the revision new Workspaces get when none is named. A Template with no default yet has nothing to compare against: say so with --expect-no-default. No Platform revision is named or moved: releasing a Template never drags another team's kernel along.
See kibo help command-ids for --command-id and --expected-revision.
kibo template set-default <template-id> [flags]| 参数 | 默认值 | 说明 |
|---|---|---|
--command-id <key> | idempotency key for this change; see kibo help command-ids | |
--expect-no-default | state that the Template has no default yet instead of reading the current one | |
--expected-revision <revision> | revision the Template is expected to default to; read from the server when omitted | |
--revision <revision> | 必填 | exact Template revision the change applies to |
kibo template withdraw
Withdraws one Template revision. Workspaces already created from it keep running and are not migrated, but the revision never becomes selectable again: a withdrawal is the one admission change kibo template approve cannot undo. A reason is required: a Template revision that disappears without one leaves nobody able to say why.
kibo template withdraw <template-id> [flags]| 参数 | 默认值 | 说明 |
|---|---|---|
--command-id <key> | idempotency key for this change; see kibo help command-ids | |
--reason <text> | 必填 | text saying why this Template revision is withdrawn; required |
--revision <revision> | 必填 | exact Template revision the change applies to |