Kibotos
kibo commands

kibo transfer

Export a Workspace's data and restore it elsewhere. This page lists the usage, examples, and flags of kibo transfer and its subcommands, generated from the kibo source code.

Every command on this page also takes the global flags --endpoint, --json, and --timeout. See CLI reference for kibo.

Subcommands:

kibo transfer delete

Delete a Transfer.

kibo transfer delete <transfer-id> [flags]

Also available as kibo transfer rm.

FlagDefaultDescription
--command-id <key>idempotency key for this change; see kibo help command-ids
-y, --yesdo not ask for confirmation

kibo transfer export

Exports the Volume of a stopped Workspace as a Transfer. A node packs the Volume's files into an archive and uploads it to the artifact store, which takes minutes for a large Volume.

kibo waits until the command finishes, sending the same command ID again while ctrl reports it still executing. Ending the wait, by --wait-timeout or Ctrl-C, never cancels the command: run it again with the same --command-id to wait for it. See kibo help command-ids.

kibo transfer export <workspace-id> [flags]

Examples:

kibo transfer export ws-01k6…
FlagDefaultDescription
--command-id <key>idempotency key for this change; see kibo help command-ids
-q, --quietprint only the IDs of the resources in the result
--wait-timeout <duration>2hhow long to wait for the command to finish; running out does not cancel it

kibo transfer get

Get a Transfer.

kibo transfer get <transfer-id> [flags]
FlagDefaultDescription
-q, --quietprint only the IDs of the resources in the result

kibo transfer import

Creates a new Volume from a complete Transfer.

--storage-pool names the storage the imported Volume lives in, as reported by kibo storage-pool list. Omitted, it lands in the pool the exported Volume lived in. Which node runs the import is the deployment's choice among the nodes that reach that pool.

kibo waits until the command finishes, sending the same command ID again while ctrl reports it still executing. Ending the wait, by --wait-timeout or Ctrl-C, never cancels the command: run it again with the same --command-id to wait for it. See kibo help command-ids.

kibo transfer import <transfer-id> [flags]

Examples:

kibo transfer import xfer-01k6… --storage-pool shared
FlagDefaultDescription
--command-id <key>idempotency key for this change; see kibo help command-ids
--storage-pool <pool>storage pool the imported Volume lives in; the exported Volume's pool when omitted
--wait-timeout <duration>2hhow long to wait for the command to finish; running out does not cancel it

kibo transfer restore

Creates a Workspace bound to the Volume that kibo transfer import produced, and starts it.

kibo waits until the command finishes, sending the same command ID again while ctrl reports it still executing. Ending the wait, by --wait-timeout or Ctrl-C, never cancels the command: run it again with the same --command-id to wait for it. See kibo help command-ids.

kibo transfer restore <transfer-id> [flags]

Examples:

kibo transfer restore xfer-01k6… --volume vol-01k6… --template kibotos-coding
FlagDefaultDescription
--capability <key=value>node capability the Workspace requires (repeatable)
--command-id <key>idempotency key for this change; see kibo help command-ids
--cpu <cpus>1CPU the Workspace requests, in cpus: 2, 0.5 or 1500m
--disk <size>capacity of the writable root filesystem, a size such as 20G; the storage default when omitted
--expiration-action <action>stopaction at expiration: stop or delete
--expires-in <duration>stop or delete the Workspace this long after the command is accepted, such as 8h
--memory <size>256MiBmemory the Workspace requests, a size such as 4G or 512MiB
--mount-path <path>/dataabsolute guest path the Volume is mounted at
--template <id>RequiredTemplate the Workspace is created from, by id
--template-revision <revision>exact Template revision; the Template's default when omitted
--volume <id>Requiredid of the Volume that transfer import produced
--wait-timeout <duration>1hhow long to wait for the command to finish; running out does not cancel it

On this page