kibo volume
Create, inspect, resize, move, and delete Volumes. This page lists the usage, examples, and flags of kibo volume 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 volume annotations: Replace or clear the annotations of a Volumekibo volume command: Inspect a persisted Volume commandkibo volume create: Create a standalone Volumekibo volume delete: Delete a Volumekibo volume get: Get a Volumekibo volume labels: Replace or clear the labels of a Volumekibo volume list: List Volumeskibo volume move: Move a Volume to another storage poolkibo volume resize: Grow a Volume that is not in use
kibo volume annotations
Replace or clear the annotations of a Volume.
Subcommands:
kibo volume annotations clear: Remove all annotations of a Volumekibo volume annotations set: Replace all annotations of a Volume
kibo volume annotations clear
Replaces the annotations of a Volume with an empty map.
Submitting the annotations already stored succeeds without changing anything. See kibo help command-ids for --command-id and --expected-revision.
kibo volume annotations clear <volume-id> [flags]| Flag | Default | Description |
|---|---|---|
--command-id <key> | idempotency key for this change; see kibo help command-ids | |
--expected-revision <revision> | annotations revision the command is submitted against; read from the server when omitted |
kibo volume annotations set
Replaces the complete annotations of a Volume with the given key=value pairs. Keys not named are removed; nothing is merged. Use "volume annotations clear" to remove every annotation.
Submitting the annotations already stored succeeds without changing anything. See kibo help command-ids for --command-id and --expected-revision.
kibo volume annotations set <volume-id> <key=value>... [flags]| Flag | Default | Description |
|---|---|---|
--command-id <key> | idempotency key for this change; see kibo help command-ids | |
--expected-revision <revision> | annotations revision the command is submitted against; read from the server when omitted |
kibo volume command
Inspect a persisted Volume command.
Subcommands:
kibo volume command get: Get the original command status and result
kibo volume command get
Get the original command status and result.
kibo volume command get <volume-id> <command-id> [flags]kibo volume create
Creates a Volume that no Workspace owns. It can later be bound with "workspace create --volume <id>", and outlives every Workspace that binds it.
Without --capacity the configured storage profile picks the capacity; the returned Volume always reports the capacity it actually has.
--storage-pool names the storage the Volume lives in, as reported by kibo storage-pool list. Where a Volume lives decides where the Workspace bound to it can run; omitted, the deployment picks its default pool.
kibo volume create [flags]Examples:
kibo volume create --capacity 50G
kibo workspace create --template kibotos-coding --volume vol-01k6…| Flag | Default | Description |
|---|---|---|
--annotation <key=value> | annotation key=value; stored as given and never selectable (repeatable) | |
--capacity <size> | capacity of the Volume, a size such as 10G or 512MiB | |
--command-id <key> | idempotency key for this change; see kibo help command-ids | |
--label <key=value> | label key=value; selectable with list --label (repeatable) | |
-q, --quiet | print only the IDs of the resources in the result | |
--storage-pool <pool> | storage pool the Volume lives in; the deployment's default when omitted |
kibo volume delete
Delete a Volume.
kibo volume delete <volume-id> [flags]Also available as kibo volume rm.
| Flag | Default | Description |
|---|---|---|
--command-id <key> | idempotency key for this change; see kibo help command-ids | |
-y, --yes | do not ask for confirmation |
kibo volume get
Get a Volume.
kibo volume get <volume-id> [flags]| Flag | Default | Description |
|---|---|---|
-q, --quiet | print only the IDs of the resources in the result | |
--wide | show every field, including revisions and full digests |
kibo volume labels
Replace or clear the labels of a Volume.
Subcommands:
kibo volume labels clear: Remove all labels of a Volumekibo volume labels set: Replace all labels of a Volume
kibo volume labels clear
Replaces the labels of a Volume with an empty map.
Submitting the labels already stored succeeds without changing anything. See kibo help command-ids for --command-id and --expected-revision.
kibo volume labels clear <volume-id> [flags]| Flag | Default | Description |
|---|---|---|
--command-id <key> | idempotency key for this change; see kibo help command-ids | |
--expected-revision <revision> | labels revision the command is submitted against; read from the server when omitted |
kibo volume labels set
Replaces the complete labels of a Volume with the given key=value pairs. Keys not named are removed; nothing is merged. Use "volume labels clear" to remove every label.
Submitting the labels already stored succeeds without changing anything. See kibo help command-ids for --command-id and --expected-revision.
kibo volume labels set <volume-id> <key=value>... [flags]| Flag | Default | Description |
|---|---|---|
--command-id <key> | idempotency key for this change; see kibo help command-ids | |
--expected-revision <revision> | labels revision the command is submitted against; read from the server when omitted |
kibo volume list
List Volumes.
kibo volume list [flags]Also available as kibo volume ls.
| Flag | Default | Description |
|---|---|---|
--all | read every page, not only the first | |
--include-deleted | include deleted Volumes | |
-l, --label <key=value> | only list resources whose label key has exactly this value; every entry must match (repeatable) | |
-L, --label-column <key> | show this label key as a column of its own (repeatable) | |
--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 | |
--wide | show every field, including revisions and full digests |
kibo volume move
Moves a Volume to another storage pool, as reported by kibo storage-pool list. Its ID, content, capacity and binding stay the same. A node that reaches both pools copies the Volume, so it moves only while nothing uses it: the Volume is AVAILABLE and the Workspace it is bound to, if any, is stopped. Until the move settles, that Workspace does not start and the Volume is not resized, bound, released, deleted or exported. The Volume reserves its capacity in both pools until then.
kibo waits until the move settles, sending the same command ID again while ctrl reports the copy still running. Ending the wait, by --wait-timeout or Ctrl-C, never cancels the move: run the command again with the same --command-id to wait for it. See kibo help command-ids.
kibo volume move <volume-id> [flags]Examples:
kibo volume move vol-01k6… --storage-pool shared| Flag | Default | Description |
|---|---|---|
--command-id <key> | idempotency key for this change; see kibo help command-ids | |
-q, --quiet | print only the IDs of the resources in the result | |
--storage-pool <pool> | Required | storage pool the Volume moves to |
--wait-timeout <duration> | 2h | how long to wait for the move to settle; running out does not cancel it |
kibo volume resize
Grows a Volume to an absolute target capacity. --capacity is the capacity the Volume should end up with, not an increment: a target equal to the current capacity succeeds without changing anything, and a smaller target is rejected because shrinking cannot preserve the data already written.
Only a Volume that is mounted nowhere accepts the command. A Volume still attached to a node, or bound to a Workspace that is running or otherwise busy with an execution, is refused; stop that Workspace first. Growing the block device does not by itself grow the filesystem inside it.
kibo volume resize <volume-id> [flags]Examples:
kibo volume resize vol-01k6… --capacity 100G| Flag | Default | Description |
|---|---|---|
--capacity <size> | Required | capacity of the Volume, a size such as 10G or 512MiB |
--command-id <key> | idempotency key for this change; see kibo help command-ids | |
-q, --quiet | print only the IDs of the resources in the result |
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.
kibo workspace
Create, run and change Workspaces. This page lists the usage, examples, and flags of kibo workspace and its subcommands, generated from the kibo source code.