mirror of
https://github.com/aljazceru/kata-containers.git
synced 2026-01-11 02:14:20 +01:00
4887ce059c
Changes: 96be8229 release: Release v0.7.0 5115ad6e vmm: config: Support on/off/true/false for all booleans d5bfa2df vmm, vhost_user_block: Make parameter names match --disk 2f0bc06b vmm: Update default devices names as "internal" aaba6e77 vmm: Add virtio-console to the list of Migratable devices 9ab4bb1a devices: serial: Expect an identifier upon device creation 06487131 vm-virtio: pci: Expect an identifier upon device creation eeb7e10d vm-virtio: mmio: Expect an identifier upon device creation 9d84ef50 vmm: Make the virtio identifier mandatory 14350f5d devices: ioapic: Expect an identifier upon device creation 55687157 vm-virtio: iommu: Expect an identifier upon device creation 052eff1c vm-virtio: console: Expect an identifier upon device creation 354c2a4b vm-virtio: vhost-user-net: Expect an identifier upon device creation 46e0b3ff vm-virtio: vhost-user-blk: Expect an identifier upon device creation bb7fa71f vm-virtio: vhost-user-fs: Expect an identifier upon device creation ec5ff395 vm-virtio: vsock: Expect an identifier upon device creation 9b53044a vm-virtio: mem: Expect an identifier upon device creation 1592a929 vm-virtio: pmem: Expect an identifier upon device creation 2e91b738 vm-virtio: rng: Expect an identifier upon device creation 9eb7413f vm-virtio: net: Expect an identifier upon device creation be946caf vm-virtio: blk: Expect an identifier upon device creation ff9c8b84 vmm: Always generate the next device name 81831413 vmm: Add an identifier to the ioapic device e4386c8b vmm: Add an identifier to the virtio-iommu device 75ddd2a2 vmm: Add an identifier to the --console device eac350c4 vmm: Add an identifier to the virtio-mem device 6802ef54 vmm: Add an identifier to the --rng device d71d52e9 vmm: Fix virtio-console creation with virtual IOMMU b08fde59 vmm: Fix virtio-rng creation with virtual IOMMU 8031ac33 vmm: Fix virtio-vsock creation with virtual IOMMU 50134969 Jenkins: Run musl unit and integration tests on master branch ce794f78 ci: Pass target triple to the test scripts 33b0e158 resources: Add musl tools and toolchain to the Dockerfile ad9374bd dev_cli: Add --libc to the build and test commands 8cef3574 vmm: seccomp: Add fork, gettid and pipe2 syscalls to permitted list ce7678f2 vmm: seccomp: Add tkill syscall to permitted list 12758d7f vmm: seccomp: Add epoll_pwait syscall to permitted list 86fcd19b build: Initial musl support a5de4955 vmm: Only allow removal of specific types of virtio device 9ed880d7 vmm: Add an identifier to the --fs device 7e0ab6b5 vmm: Fix pmem device creation 3012975c tests: Enhance vsock integration test to support hotplug 6c2bca5f bin: ch-remote: Add support for adding vsock devices 8de7448d vmm: api: Add "add-vsock" API entry point bf09a1e6 openapi: Add "id" field to VsockConfig a76cf086 vmm: vm: Remove vsock device from config 99422324 vmm: vm: Add "add_vsock()" 1d61c476 vmm: device_manager: Add support for hotplugging virtio-vsock devices f8501a3b vmm: config: Move --vsock syntax to VsockConfig 6e049e0d vmm: Add an identifier to the --vsock device 10348f73 vmm, main: Support only zero or one vsock devices 9d1f95a3 openapi: Add missing "id" field 30e2e515 build(deps): bump serde_json from 1.0.51 to 1.0.52 dd9d0d04 build(deps): bump micro_http from `0d87a94` to `c9ffb90` cdc8493a build(deps): bump thiserror from 1.0.15 to 1.0.16 Fixes: kata-containers/runtime#2658 Signed-off-by: Bo Chen <chen.bo@intel.com> Signed-off-by: Peng Tao <bergwolf@hyper.sh>
924 lines
22 KiB
YAML
924 lines
22 KiB
YAML
openapi: 3.0.1
|
|
info:
|
|
description: Local HTTP based API for managing and inspecting a cloud-hypervisor
|
|
virtual machine.
|
|
license:
|
|
name: Apache 2.0
|
|
url: http://www.apache.org/licenses/LICENSE-2.0.html
|
|
title: Cloud Hypervisor API
|
|
version: 0.3.0
|
|
servers:
|
|
- url: http://localhost/api/v1
|
|
paths:
|
|
/vmm.ping:
|
|
get:
|
|
responses:
|
|
"200":
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/VmmPingResponse'
|
|
description: The VMM information
|
|
summary: Ping the VMM to check for API server availability
|
|
/vmm.shutdown:
|
|
put:
|
|
operationId: shutdownVMM
|
|
responses:
|
|
"204":
|
|
description: The VMM successfully shutdown.
|
|
summary: Shuts the cloud-hypervisor VMM.
|
|
/vm.info:
|
|
get:
|
|
responses:
|
|
"200":
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/VmInfo'
|
|
description: The VM information
|
|
summary: Returns general information about the cloud-hypervisor Virtual Machine
|
|
(VM) instance.
|
|
/vm.create:
|
|
put:
|
|
operationId: createVM
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/VmConfig'
|
|
description: The VM configuration
|
|
required: true
|
|
responses:
|
|
"204":
|
|
description: The VM instance was successfully created.
|
|
summary: Create the cloud-hypervisor Virtual Machine (VM) instance. The instance
|
|
is not booted, only created.
|
|
/vm.delete:
|
|
put:
|
|
operationId: deleteVM
|
|
responses:
|
|
"204":
|
|
description: The VM instance was successfully deleted.
|
|
summary: Delete the cloud-hypervisor Virtual Machine (VM) instance.
|
|
/vm.boot:
|
|
put:
|
|
operationId: bootVM
|
|
responses:
|
|
"204":
|
|
description: The VM instance successfully booted.
|
|
"404":
|
|
description: The VM instance could not boot because it is not created yet
|
|
summary: Boot the previously created VM instance.
|
|
/vm.pause:
|
|
put:
|
|
operationId: pauseVM
|
|
responses:
|
|
"204":
|
|
description: The VM instance successfully paused.
|
|
"404":
|
|
description: The VM instance could not pause because it is not created yet
|
|
"405":
|
|
description: The VM instance could not pause because it is not booted.
|
|
summary: Pause a previously booted VM instance.
|
|
/vm.resume:
|
|
put:
|
|
operationId: resumeVM
|
|
responses:
|
|
"204":
|
|
description: The VM instance successfully paused.
|
|
"404":
|
|
description: The VM instance could not resume because it is not booted yet
|
|
"405":
|
|
description: The VM instance could not resume because it is not paused.
|
|
summary: Resume a previously paused VM instance.
|
|
/vm.shutdown:
|
|
put:
|
|
operationId: shutdownVM
|
|
responses:
|
|
"204":
|
|
description: The VM instance successfully shut down.
|
|
"404":
|
|
description: The VM instance could not shut down because is not created.
|
|
"405":
|
|
description: The VM instance could not shut down because it is not started.
|
|
summary: Shut the VM instance down.
|
|
/vm.reboot:
|
|
put:
|
|
operationId: rebootVM
|
|
responses:
|
|
"204":
|
|
description: The VM instance successfully rebooted.
|
|
"404":
|
|
description: The VM instance could not reboot because it is not created.
|
|
"405":
|
|
description: The VM instance could not reboot because it is not booted.
|
|
summary: Reboot the VM instance.
|
|
/vm.resize:
|
|
put:
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/VmResize'
|
|
description: The target size for the VM
|
|
required: true
|
|
responses:
|
|
"204":
|
|
description: The VM instance was successfully resized.
|
|
"404":
|
|
description: The VM instance could not be resized because it is not created.
|
|
summary: Resize the VM
|
|
/vm.add-device:
|
|
put:
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/VmAddDevice'
|
|
description: The path of the new device
|
|
required: true
|
|
responses:
|
|
"204":
|
|
description: The new device was successfully added to the VM instance.
|
|
"404":
|
|
description: The new device could not be added to the VM instance.
|
|
summary: Add a new device to the VM
|
|
/vm.remove-device:
|
|
put:
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/VmRemoveDevice'
|
|
description: The identifier of the device
|
|
required: true
|
|
responses:
|
|
"204":
|
|
description: The device was successfully removed from the VM instance.
|
|
"404":
|
|
description: The device could not be removed from the VM instance.
|
|
summary: Remove a device from the VM
|
|
/vm.add-disk:
|
|
put:
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/DiskConfig'
|
|
description: The details of the new disk
|
|
required: true
|
|
responses:
|
|
"204":
|
|
description: The new disk was successfully added to the VM instance.
|
|
"500":
|
|
description: The new disk could not be added to the VM instance.
|
|
summary: Add a new disk to the VM
|
|
/vm.add-fs:
|
|
put:
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/FsConfig'
|
|
description: The details of the new virtio-fs
|
|
required: true
|
|
responses:
|
|
"204":
|
|
description: The new device was successfully added to the VM instance.
|
|
"500":
|
|
description: The new device could not be added to the VM instance.
|
|
summary: Add a new virtio-fs device to the VM
|
|
/vm.add-pmem:
|
|
put:
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/PmemConfig'
|
|
description: The details of the new pmem device
|
|
required: true
|
|
responses:
|
|
"204":
|
|
description: The new device was successfully added to the VM instance.
|
|
"500":
|
|
description: The new device could not be added to the VM instance.
|
|
summary: Add a new pmem device to the VM
|
|
/vm.add-net:
|
|
put:
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/NetConfig'
|
|
description: The details of the new network device
|
|
required: true
|
|
responses:
|
|
"204":
|
|
description: The new device was successfully added to the VM instance.
|
|
"500":
|
|
description: The new device could not be added to the VM instance.
|
|
summary: Add a new network device to the VM
|
|
/vm.add-vsock:
|
|
put:
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/VsockConfig'
|
|
description: The details of the new vsock device
|
|
required: true
|
|
responses:
|
|
"204":
|
|
description: The new device was successfully added to the VM instance.
|
|
"500":
|
|
description: The new device could not be added to the VM instance.
|
|
summary: Add a new vsock device to the VM
|
|
/vm.snapshot:
|
|
put:
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/VmSnapshotConfig'
|
|
description: The snapshot configuration
|
|
required: true
|
|
responses:
|
|
"204":
|
|
description: The VM instance was successfully snapshotted.
|
|
"404":
|
|
description: The VM instance could not be snapshotted because it is not
|
|
created.
|
|
"405":
|
|
description: The VM instance could not be snapshotted because it is not
|
|
booted.
|
|
summary: Returns a VM snapshot.
|
|
/vm.restore:
|
|
put:
|
|
requestBody:
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '#/components/schemas/RestoreConfig'
|
|
description: The restore configuration
|
|
required: true
|
|
responses:
|
|
"204":
|
|
description: The VM instance was successfully restored.
|
|
"404":
|
|
description: The VM instance could not be restored because it is already
|
|
created.
|
|
summary: Restore a VM from a snapshot.
|
|
components:
|
|
schemas:
|
|
VmmPingResponse:
|
|
description: Virtual Machine Monitor information
|
|
example:
|
|
version: version
|
|
properties:
|
|
version:
|
|
type: string
|
|
required:
|
|
- version
|
|
type: object
|
|
VmInfo:
|
|
description: Virtual Machine information
|
|
example:
|
|
state: Created
|
|
config:
|
|
console:
|
|
mode: "false"
|
|
file: file
|
|
iommu: false
|
|
memory:
|
|
hugepages: false
|
|
shared: false
|
|
mergeable: false
|
|
file: file
|
|
size: 1
|
|
hotplug_size: 5
|
|
hotplug_method: acpi
|
|
disks:
|
|
- path: path
|
|
num_queues: 5
|
|
readonly: false
|
|
iommu: false
|
|
queue_size: 2
|
|
vhost_socket: vhost_socket
|
|
vhost_user: false
|
|
direct: false
|
|
wce: true
|
|
poll_queue: true
|
|
id: id
|
|
- path: path
|
|
num_queues: 5
|
|
readonly: false
|
|
iommu: false
|
|
queue_size: 2
|
|
vhost_socket: vhost_socket
|
|
vhost_user: false
|
|
direct: false
|
|
wce: true
|
|
poll_queue: true
|
|
id: id
|
|
cpus:
|
|
boot_vcpus: 1
|
|
max_vcpus: 1
|
|
devices:
|
|
- path: path
|
|
iommu: false
|
|
id: id
|
|
- path: path
|
|
iommu: false
|
|
id: id
|
|
kernel:
|
|
path: path
|
|
rng:
|
|
iommu: false
|
|
src: /dev/urandom
|
|
fs:
|
|
- sock: sock
|
|
num_queues: 3
|
|
queue_size: 2
|
|
cache_size: 4
|
|
dax: true
|
|
tag: tag
|
|
id: id
|
|
- sock: sock
|
|
num_queues: 3
|
|
queue_size: 2
|
|
cache_size: 4
|
|
dax: true
|
|
tag: tag
|
|
id: id
|
|
vsock:
|
|
sock: sock
|
|
iommu: false
|
|
id: id
|
|
cid: 3
|
|
pmem:
|
|
- mergeable: false
|
|
file: file
|
|
size: 7
|
|
iommu: false
|
|
id: id
|
|
discard_writes: false
|
|
- mergeable: false
|
|
file: file
|
|
size: 7
|
|
iommu: false
|
|
id: id
|
|
discard_writes: false
|
|
cmdline:
|
|
args: args
|
|
iommu: false
|
|
serial:
|
|
mode: "false"
|
|
file: file
|
|
iommu: false
|
|
initramfs:
|
|
path: path
|
|
net:
|
|
- tap: tap
|
|
num_queues: 7
|
|
iommu: false
|
|
queue_size: 9
|
|
vhost_socket: vhost_socket
|
|
vhost_user: false
|
|
ip: 192.168.249.1
|
|
id: id
|
|
mac: mac
|
|
mask: 255.255.255.0
|
|
- tap: tap
|
|
num_queues: 7
|
|
iommu: false
|
|
queue_size: 9
|
|
vhost_socket: vhost_socket
|
|
vhost_user: false
|
|
ip: 192.168.249.1
|
|
id: id
|
|
mac: mac
|
|
mask: 255.255.255.0
|
|
properties:
|
|
config:
|
|
$ref: '#/components/schemas/VmConfig'
|
|
state:
|
|
enum:
|
|
- Created
|
|
- Running
|
|
- Shutdown
|
|
- Paused
|
|
type: string
|
|
required:
|
|
- config
|
|
- state
|
|
type: object
|
|
VmConfig:
|
|
description: Virtual machine configuration
|
|
example:
|
|
console:
|
|
mode: "false"
|
|
file: file
|
|
iommu: false
|
|
memory:
|
|
hugepages: false
|
|
shared: false
|
|
mergeable: false
|
|
file: file
|
|
size: 1
|
|
hotplug_size: 5
|
|
hotplug_method: acpi
|
|
disks:
|
|
- path: path
|
|
num_queues: 5
|
|
readonly: false
|
|
iommu: false
|
|
queue_size: 2
|
|
vhost_socket: vhost_socket
|
|
vhost_user: false
|
|
direct: false
|
|
wce: true
|
|
poll_queue: true
|
|
id: id
|
|
- path: path
|
|
num_queues: 5
|
|
readonly: false
|
|
iommu: false
|
|
queue_size: 2
|
|
vhost_socket: vhost_socket
|
|
vhost_user: false
|
|
direct: false
|
|
wce: true
|
|
poll_queue: true
|
|
id: id
|
|
cpus:
|
|
boot_vcpus: 1
|
|
max_vcpus: 1
|
|
devices:
|
|
- path: path
|
|
iommu: false
|
|
id: id
|
|
- path: path
|
|
iommu: false
|
|
id: id
|
|
kernel:
|
|
path: path
|
|
rng:
|
|
iommu: false
|
|
src: /dev/urandom
|
|
fs:
|
|
- sock: sock
|
|
num_queues: 3
|
|
queue_size: 2
|
|
cache_size: 4
|
|
dax: true
|
|
tag: tag
|
|
id: id
|
|
- sock: sock
|
|
num_queues: 3
|
|
queue_size: 2
|
|
cache_size: 4
|
|
dax: true
|
|
tag: tag
|
|
id: id
|
|
vsock:
|
|
sock: sock
|
|
iommu: false
|
|
id: id
|
|
cid: 3
|
|
pmem:
|
|
- mergeable: false
|
|
file: file
|
|
size: 7
|
|
iommu: false
|
|
id: id
|
|
discard_writes: false
|
|
- mergeable: false
|
|
file: file
|
|
size: 7
|
|
iommu: false
|
|
id: id
|
|
discard_writes: false
|
|
cmdline:
|
|
args: args
|
|
iommu: false
|
|
serial:
|
|
mode: "false"
|
|
file: file
|
|
iommu: false
|
|
initramfs:
|
|
path: path
|
|
net:
|
|
- tap: tap
|
|
num_queues: 7
|
|
iommu: false
|
|
queue_size: 9
|
|
vhost_socket: vhost_socket
|
|
vhost_user: false
|
|
ip: 192.168.249.1
|
|
id: id
|
|
mac: mac
|
|
mask: 255.255.255.0
|
|
- tap: tap
|
|
num_queues: 7
|
|
iommu: false
|
|
queue_size: 9
|
|
vhost_socket: vhost_socket
|
|
vhost_user: false
|
|
ip: 192.168.249.1
|
|
id: id
|
|
mac: mac
|
|
mask: 255.255.255.0
|
|
properties:
|
|
cpus:
|
|
$ref: '#/components/schemas/CpusConfig'
|
|
memory:
|
|
$ref: '#/components/schemas/MemoryConfig'
|
|
kernel:
|
|
$ref: '#/components/schemas/KernelConfig'
|
|
initramfs:
|
|
$ref: '#/components/schemas/InitramfsConfig'
|
|
cmdline:
|
|
$ref: '#/components/schemas/CmdLineConfig'
|
|
disks:
|
|
items:
|
|
$ref: '#/components/schemas/DiskConfig'
|
|
type: array
|
|
net:
|
|
items:
|
|
$ref: '#/components/schemas/NetConfig'
|
|
type: array
|
|
rng:
|
|
$ref: '#/components/schemas/RngConfig'
|
|
fs:
|
|
items:
|
|
$ref: '#/components/schemas/FsConfig'
|
|
type: array
|
|
pmem:
|
|
items:
|
|
$ref: '#/components/schemas/PmemConfig'
|
|
type: array
|
|
serial:
|
|
$ref: '#/components/schemas/ConsoleConfig'
|
|
console:
|
|
$ref: '#/components/schemas/ConsoleConfig'
|
|
devices:
|
|
items:
|
|
$ref: '#/components/schemas/DeviceConfig'
|
|
type: array
|
|
vsock:
|
|
$ref: '#/components/schemas/VsockConfig'
|
|
iommu:
|
|
default: false
|
|
type: boolean
|
|
required:
|
|
- cmdline
|
|
- kernel
|
|
type: object
|
|
CpusConfig:
|
|
example:
|
|
boot_vcpus: 1
|
|
max_vcpus: 1
|
|
properties:
|
|
boot_vcpus:
|
|
default: 1
|
|
minimum: 1
|
|
type: integer
|
|
max_vcpus:
|
|
default: 1
|
|
minimum: 1
|
|
type: integer
|
|
required:
|
|
- boot_vcpus
|
|
- max_vcpus
|
|
type: object
|
|
MemoryConfig:
|
|
example:
|
|
hugepages: false
|
|
shared: false
|
|
mergeable: false
|
|
file: file
|
|
size: 1
|
|
hotplug_size: 5
|
|
hotplug_method: acpi
|
|
properties:
|
|
size:
|
|
format: int64
|
|
type: integer
|
|
hotplug_size:
|
|
format: int64
|
|
type: integer
|
|
file:
|
|
type: string
|
|
mergeable:
|
|
default: false
|
|
type: boolean
|
|
hotplug_method:
|
|
default: acpi
|
|
type: string
|
|
shared:
|
|
default: false
|
|
type: boolean
|
|
hugepages:
|
|
default: false
|
|
type: boolean
|
|
required:
|
|
- size
|
|
type: object
|
|
KernelConfig:
|
|
example:
|
|
path: path
|
|
properties:
|
|
path:
|
|
type: string
|
|
required:
|
|
- path
|
|
type: object
|
|
InitramfsConfig:
|
|
example:
|
|
path: path
|
|
nullable: true
|
|
properties:
|
|
path:
|
|
type: string
|
|
required:
|
|
- path
|
|
type: object
|
|
CmdLineConfig:
|
|
example:
|
|
args: args
|
|
properties:
|
|
args:
|
|
type: string
|
|
required:
|
|
- args
|
|
type: object
|
|
DiskConfig:
|
|
example:
|
|
path: path
|
|
num_queues: 5
|
|
readonly: false
|
|
iommu: false
|
|
queue_size: 2
|
|
vhost_socket: vhost_socket
|
|
vhost_user: false
|
|
direct: false
|
|
wce: true
|
|
poll_queue: true
|
|
id: id
|
|
properties:
|
|
path:
|
|
type: string
|
|
readonly:
|
|
default: false
|
|
type: boolean
|
|
direct:
|
|
default: false
|
|
type: boolean
|
|
iommu:
|
|
default: false
|
|
type: boolean
|
|
num_queues:
|
|
default: 1
|
|
type: integer
|
|
queue_size:
|
|
default: 128
|
|
type: integer
|
|
vhost_user:
|
|
default: false
|
|
type: boolean
|
|
vhost_socket:
|
|
type: string
|
|
wce:
|
|
default: true
|
|
type: boolean
|
|
poll_queue:
|
|
default: true
|
|
type: boolean
|
|
id:
|
|
type: string
|
|
required:
|
|
- path
|
|
type: object
|
|
NetConfig:
|
|
example:
|
|
tap: tap
|
|
num_queues: 7
|
|
iommu: false
|
|
queue_size: 9
|
|
vhost_socket: vhost_socket
|
|
vhost_user: false
|
|
ip: 192.168.249.1
|
|
id: id
|
|
mac: mac
|
|
mask: 255.255.255.0
|
|
properties:
|
|
tap:
|
|
default: ""
|
|
type: string
|
|
ip:
|
|
default: 192.168.249.1
|
|
type: string
|
|
mask:
|
|
default: 255.255.255.0
|
|
type: string
|
|
mac:
|
|
type: string
|
|
iommu:
|
|
default: false
|
|
type: boolean
|
|
num_queues:
|
|
default: 2
|
|
type: integer
|
|
queue_size:
|
|
default: 256
|
|
type: integer
|
|
vhost_user:
|
|
default: false
|
|
type: boolean
|
|
vhost_socket:
|
|
type: string
|
|
id:
|
|
type: string
|
|
type: object
|
|
RngConfig:
|
|
example:
|
|
iommu: false
|
|
src: /dev/urandom
|
|
properties:
|
|
src:
|
|
default: /dev/urandom
|
|
type: string
|
|
iommu:
|
|
default: false
|
|
type: boolean
|
|
required:
|
|
- src
|
|
type: object
|
|
FsConfig:
|
|
example:
|
|
sock: sock
|
|
num_queues: 3
|
|
queue_size: 2
|
|
cache_size: 4
|
|
dax: true
|
|
tag: tag
|
|
id: id
|
|
properties:
|
|
tag:
|
|
type: string
|
|
sock:
|
|
type: string
|
|
num_queues:
|
|
default: 1
|
|
type: integer
|
|
queue_size:
|
|
default: 1024
|
|
type: integer
|
|
dax:
|
|
default: true
|
|
type: boolean
|
|
cache_size:
|
|
format: int64
|
|
type: integer
|
|
id:
|
|
type: string
|
|
required:
|
|
- sock
|
|
- tag
|
|
type: object
|
|
PmemConfig:
|
|
example:
|
|
mergeable: false
|
|
file: file
|
|
size: 7
|
|
iommu: false
|
|
id: id
|
|
discard_writes: false
|
|
properties:
|
|
file:
|
|
type: string
|
|
size:
|
|
format: int64
|
|
type: integer
|
|
iommu:
|
|
default: false
|
|
type: boolean
|
|
mergeable:
|
|
default: false
|
|
type: boolean
|
|
discard_writes:
|
|
default: false
|
|
type: boolean
|
|
id:
|
|
type: string
|
|
required:
|
|
- file
|
|
type: object
|
|
ConsoleConfig:
|
|
example:
|
|
mode: "false"
|
|
file: file
|
|
iommu: false
|
|
properties:
|
|
file:
|
|
type: string
|
|
mode:
|
|
enum:
|
|
- "false"
|
|
- Tty
|
|
- File
|
|
- null
|
|
type: string
|
|
iommu:
|
|
default: false
|
|
type: boolean
|
|
required:
|
|
- mode
|
|
type: object
|
|
DeviceConfig:
|
|
example:
|
|
path: path
|
|
iommu: false
|
|
id: id
|
|
properties:
|
|
path:
|
|
type: string
|
|
iommu:
|
|
default: false
|
|
type: boolean
|
|
id:
|
|
type: string
|
|
required:
|
|
- path
|
|
type: object
|
|
VsockConfig:
|
|
example:
|
|
sock: sock
|
|
iommu: false
|
|
id: id
|
|
cid: 3
|
|
properties:
|
|
cid:
|
|
description: Guest Vsock CID
|
|
format: int64
|
|
minimum: 3
|
|
type: integer
|
|
sock:
|
|
description: Path to UNIX domain socket, used to proxy vsock connections.
|
|
type: string
|
|
iommu:
|
|
default: false
|
|
type: boolean
|
|
id:
|
|
type: string
|
|
required:
|
|
- cid
|
|
- sock
|
|
type: object
|
|
VmResize:
|
|
example:
|
|
desired_vcpus: 1
|
|
desired_ram: 6
|
|
properties:
|
|
desired_vcpus:
|
|
minimum: 1
|
|
type: integer
|
|
desired_ram:
|
|
description: desired memory ram in bytes
|
|
format: int64
|
|
type: integer
|
|
type: object
|
|
VmAddDevice:
|
|
example:
|
|
path: path
|
|
properties:
|
|
path:
|
|
type: string
|
|
type: object
|
|
VmRemoveDevice:
|
|
example:
|
|
id: id
|
|
properties:
|
|
id:
|
|
type: string
|
|
type: object
|
|
VmSnapshotConfig:
|
|
example:
|
|
destination_url: destination_url
|
|
properties:
|
|
destination_url:
|
|
type: string
|
|
type: object
|
|
RestoreConfig:
|
|
example:
|
|
prefault: true
|
|
source_url: source_url
|
|
properties:
|
|
source_url:
|
|
type: string
|
|
prefault:
|
|
type: boolean
|
|
required:
|
|
- source_url
|
|
type: object
|