Disks API Reference

Disks

class apolo_sdk.Disks

Persistent disks subsystems. Disks can be passed as mounted volumes into a running job.

async list(cluster_name: str | None = None) → AsyncContextManager[AsyncIterator[Disk]]

List user’s disks, async iterator. Yields Disk instances.

Parameters:

cluster_name (str) – cluster to list disks. Default is current cluster.

async create(storage: int, life_span: Optional[datetime.timedelta], name: Optional[str], cluster_name: str | None = None, org_name: str | None = None) → Disk

Create a disk with capacity of storage bytes.

Parameters:

• storage (int) – storage capacity in bytes.

• life_span (Optional[datetime.timedelta]) – Duration of no usage after which disk will be deleted. None means no limit.

• name (Optional[str]) – Name of the disk. Should be unique among all user’s disk.

• cluster_name (str) – cluster to create a disk. Default is current cluster.

• org_name (str) – org to create a disk. Default is current org.

Returns:

Newly created disk info (Disk)

async get(disk_id_or_name: str, cluster_name: str | None = None) → Disk

Get a disk with id or name disk_id_or_name.

Parameters:

• disk_id_or_name (str) – disk’s id or name.

• cluster_name (str) – cluster to look for a disk. Default is current cluster.

Returns:

Disk info (Disk)

async rm(disk_id_or_name: str, cluster_name: str | None = None) → None

Delete a disk with id or name disk_id_or_name.

Parameters:

• disk_id_or_name (str) – disk’s id or name.

• cluster_name (str) – cluster to look for a disk. Default is current cluster.

Disk

class apolo_sdk.Disk

Read-only dataclass for describing persistent disk instance.

id

The disk id, str.

storage

The disk capacity, in bytes, int.

used_bytes

The amount of used bytes on disk, int or None if this information is not available. Note that this field is updated periodically, so it can contain incorrect data.

owner

The disk owner username, str.

name

The disk name set by user, unique among all user’s disks, str or None if no name was set.

status

Current disk status, Disk.Status.

uri

URI of the disk resource, yarl.URL.

cluster_name

Cluster disk resource belongs to, str.

org_name

Org disk resource belongs to, str or None if there is no such org.

created_at

Disk creation timestamp, datetime.

last_usage

Timestamp when disk was last attached to job, datetime or None if disk was never used.

timeout_unused

Max unused duration after which disk will be deleted by platform, timedelta or None if there is no limit.

Disk.Status

class Disk.Status

Enumeration that describes disk status.

Can be one of the following values:

PENDING

Disk is still creating. It can be attached to job, but job will not start until disk is created.

READY

Disk is created and ready to use.

BROKEN

Disk is broken and cannot be used anymore. Can happen if underneath storage device was destroyed.