knot knot

knot.volume

The knot.volume library provides volume management functions. Volumes are CSI volume definitions that can be attached to spaces.

Functions

Function Description
list() List all volumes
get(volume_id) Get volume by ID or name
create(name, definition, platform='') Create a new volume
update(volume_id, ...) Update volume properties
delete(volume_id) Delete a volume
start(volume_id) Start a volume
stop(volume_id) Stop a volume
is_running(volume_id) Check if volume is running

Usage

import knot.volume as volume

# List all volumes
volumes = volume.list()
for v in volumes:
    status = "active" if v['active'] else "inactive"
    print(f"{v['name']}: {status} ({v['platform']})")

# Create a volume
volume_id = volume.create(
    "my-volume",
    definition="type: host\npath: /data",
    platform="docker"
)

# Start a volume
volume.start("my-volume")

# Check if running
if volume.is_running("my-volume"):
    print("Volume is active")

# Stop a volume
volume.stop("my-volume")

Volume Properties

Volumes contain:

  • id - Volume ID
  • name - Volume name
  • definition - Volume definition YAML
  • active - Whether the volume is active/running
  • zone - Zone where volume is running
  • platform - Platform type (docker, podman, nomad, etc.)

Definition Format

The volume definition is a YAML string that defines the CSI volume configuration. Example:

type: host
path: /data