Compute

Compute instances management library and tools.

Docs

Run make serve-docs. See Development below.

Roadmap

• Create instances
• CDROM
• cloud-init for provisioning instances
• Instance power management
• Instance pause and resume
• vCPU hotplug
• Memory hotplug
• Hot disk resize [not tested]
• CPU topology customization
• CPU customization (emulation mode, model, vendor, features)
• BIOS/UEFI settings
• Device attaching
• Device detaching
• GPU passthrough
• CPU guarantied resource percent support
• QEMU Guest Agent management
• Instance resources usage stats
• SSH-keys management
• Setting user passwords in guest
• QCOW2 disks support
• ZVOL support
• Network disks support
• Images service integration (Images service is not implemented yet)
• Manage storage pools
• Idempotency
• CLI [in progress]
• HTTP API
• Instance migrations
• Instance snapshots
• Instance backups
• LXC

Development

Python 3.11+ is required.

Install poetry, clone this repository and run:

poetry install --with dev --with docs

Build Debian package

Install Docker first, then run:

make build-deb

compute and compute-doc packages will built. See packaging/build directory.

Installation

Packages can be installed via dpkg or apt-get:

# apt-get install ./compute*.deb

After installation prepare environment, run following command to start libvirtd and create required storage pools:

# systemctl enable --now libvirtd.service
# virsh net-start default
# virsh net-autostart default
# for pool in images volumes; do
    virsh pool-define-as $pool dir - - - - "/$pool"
    virsh pool-build $pool
    virsh pool-start $pool
done

Then set environment variables in your ~/.profile, ~/.bashrc or global in /etc/profile.d/compute or /etc/bash.bashrc:

export CMP_IMAGES_POOL=images
export CMP_VOLUMES_POOL=volumes

Configuration file is yet not supported.

Make sure the variables are exported to the environment:

printenv | grep CMP_

If the command didn't show anything source your rc files or relogin.

Basic usage

To get help run:

compute --help

Also you can use compute as generic Python library. For example:

from compute import Session

with Session() as session:
    instance = session.get_instance('myinstance')
    if not instance.is_running():
        instance.start()
    else:
        print('instance is already running')

Create compute instances

Place your qcow2 image in /images directory. For example debian_12.qcow2.

Create instance.yaml file with following content:

name: myinstance
memory: 2048  # memory in MiB
vcpus: 2
image: debian_12.qcow2
volumes:
  - type: file
    is_system: true
    target: vda
    capacity:
      value: 10
      unit: GiB

Refer to Instance class docs for more info. Full instance.yaml example will be provided later.

To initialise instance run:

compute -l debug init instance.yaml

Start instance:

compute start myinstance