Skip to content
This repository has been archived by the owner on Oct 16, 2024. It is now read-only.

Latest commit

 

History

History
196 lines (141 loc) · 4.7 KB

README.md

File metadata and controls

196 lines (141 loc) · 4.7 KB
Raw

DataCentred Staging Hypervisor Agent

Description

Simple REST daemon which listens for VM related requests on a staging hypervisor and enacts them. It is in essence a simplified version of OpenStack compute which is responsible for spawning (and installing) virtual machines and provisioning tagged VLAN ports in Openvswitch.

Virtual machines are provisioned to be as alike physical machines as possible. Disk controllers for example are forced to use the virtio-scsi driver so they appear as sdX in /dev and not vdX. This also means the related directories are present in /sys also.

Building

apt-get -y install gcc make libffi-dev
gem install fpm
gem build staging-hypervisor-agent.gemspec
fpm -s gem -t deb \
  --depends ruby \
  --depends ruby-sinatra \
  --depends ruby-nokogiri \
  --depends libvirt-bin \
  --depends virtinst \
  --depends openvswitch-switch \
  --gem-package-name-prefix ruby \
  --deb-systemd etc/systemd/system/staging-hypervisor-agent.service \
  --deb-default etc/default/staging-hypervisor-agent \
  --post-install scripts/post-install \
  staging-hypervisor-agent-x.y.z.gem

API

All requests and responses are JSON formatted.

All requests may respond with a 500 error, typically an exception was thrown and more information can be gained from the server logs.

GET /hosts

List all hosts on the hypervisor

Response

Code Meaning
200 Command success
Parameter Type Value
id String Unique identifier
name String Libvirt domain name
state String State the host is in

GET /hosts/:host

Probe the hypervisor for the existence of a libvirt domain for the specific hostname.

Response

Code Meaning
200 Libvirt domain exists
404 Libvirt domain does not exist
Parameter Type Value
id String Unique identifier
name String Libvirt domain name
state String State the host is in

POST /hosts/:host

Create the libvirt domain for the specified hostname.

Request

Parameter Type Flags Value
memory Integer Required Amount of memory to allocate in MB
disks Array[Integer] Required List of amounts of disk to allocate in GB
networks Array[String] Required List of libvirt networks
install Boolean Optional Whether to network install an operating system
location String Optional with install URL of libvirt network install location
cmdline Strin Optional with install Kernel command line parameters

Response

Code Meaning
201 Libvirt domain has been successfully created
400 Malformed JSON or missing required parameters
409 Libvirt domain already exists

Example

POST /hosts/ns.example.com/ HTTP/1.1

{
  "memory":512,
  "disks":[
    8
  ],
  "networks":[
    "ns_example_com_vlan_10"
  ],
  "install":true,
  "location":"http://gb.archive.ubuntu.com/ubuntu/dists/xenial/main/installer-amd64"
}

DELETE /hosts/:host

Delete the libvirt domain and disks associated with a hostname

Response

Code Meaning
204 Domain successfully deleted
404 Libvirt domain does not exist

PUT /hosts/:host/start

Code Meaning
204 Domain successfully started
404 Domain not found

GET /networks

List all networks on the hypervisor

Response

Code Meaning
200 Command success
Parameter Type Value
name String Libvirt network name
state String State the network is in
autostart String Whether the network starts on boot
persistent String Whether the network persists across reboot

GET /networks/:network

Probe the hypervisor for the existence of a natwork for a specific host.

Response

Code Meaning
200 Libvirt vlan network exists for the host
404 Libvirt vlan network doesn't exist for the host

POST /networks/:network

Create the specified network

Request

Parameter Type Flags Value
bridge String Required Openvswitch bridge to attach to
vlan Integer Required VLAN tag to apply to the access port

Response

Code Meaning
201 Libvirt network has been successfully created
400 Malformed JSON or missing required parameters
409 Libvirt network already exists

Example

POST /hosts/ns.example.com/networks/managment-network

{
  "bridge":"br0",
  "vlan":10
}

DELETE /networks/:network

Delete the libvirt network

Response

Code Meaning
204 Network successfully deleted
404 Network does not exist