instance-kvm-input-schema.json 12 KB
{
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema",

  "title": "Input Parameters",
  "properties": {
    "enable-device-hotplug": {
      "title": "Enable device hotplug mode",
      "description": "If yes, this will allow to Create devices like CPU and Memory in hotplug mode without restart the VM. Operatin System should be configured to Online new created devices.",
      "type": "boolean",
      "default": false
    },
    "ram-size": {
      "title": "RAM size",
      "description": "RAM size, in MB.",
      "type": "integer",
      "default": 1024,
      "minimum": 1024,
      "multipleOf": 512
    },
    "ram-max-size": {
      "title": "Maximum RAM size, in MB",
      "description": "Define the maximum size of the memory. The size is in MB and should be a multiple of 512.",
      "type": "integer",
      "default": 51200,
      "minimum": 1024,
      "multipleOf": 512
    },
    "ram-hotplug-slot-size": {
      "title": "Size of Hotpluggable RAM slot, in MB",
      "description": "Define the RAM size to plug on one hotpluggable slot in MB, understand the size of one RAM bar. The RAM hotplugged on each slot will always have the same RAM size.",
      "type": "integer",
      "default": 512,
      "minimum": 512,
      "multipleOf": 512
    },
    "auto-ballooning": {
      "title": "Enable qemu auto ballooning.",
      "description": "Enable virtio balloon device to allows KVM guests to reduce/re-increase their memory size.",
      "type": "boolean",
      "default": true
    },
    "disk-size": {
      "title": "Disk size",
      "description": "Disk size, in GB.",
      "type": "integer",
      "default": 10,
      "minimum": 1,
      "maximum": 1000
    },
    "disk-type": {
      "title": "Disk type",
      "description": "Type of QEMU disk drive.",
      "type": "string",
      "default": "virtio",
      "enum": ["ide", "scsi", "sd", "mtd", "floppy", "pflash", "virtio"]
    },
    "disk-cache": {
      "title": "Cache option to use with Disk.",
      "description": "Disk cache controls how the host cache is used to access block data.",
      "type": "string",
      "default": "writeback",
      "enum": ["none", "writeback", "unsafe", "directsync", "writethrough"]
    },
    "disk-aio": {
      "title": "Disk aio to use.",
      "description": "Selects between pthread based disk I/O and native Linux AIO.",
      "type": "string",
      "default": "threads",
      "enum": ["threads", "native"]
    },

    "cpu-count": {
      "title": "CPU count",
      "description": "Number of CPU cores.",
      "type": "integer",
      "minimum": 1
    },
    "cpu-max-count": {
      "title": "Maximum CPU amount",
      "description": "Specifies the maximum number of CPUs.",
      "type": "integer",
      "default": 24,
      "minimum": 1,
      "maximum": 64
    },
    "numa": {
      "title": "Simulate a multi node NUMA system.",
      "description": "Simulate a multi node NUMA system. If mem and cpus are omitted, resources are split equally. Each numa option are separated by space: node,nodeid=4,cpus=40-49,mem=64g node,nodeid=1,cpus=10-19,mem=128g. Set this option if you know what you're doing.",
      "type": "string"
    },
    "machine-options": {
      "title": "Machine options.",
      "description": "Select the emulated machine by name. Ex: pc-i440fx-2.4,accel=kvm",
      "type": "string"
    },
    "cpu-model": {
      "title": "CPU model.",
      "description": "Select the emulated CPU model. Ex: SandyBridge,+erms,+smep,+smx,+vmx",
      "type": "string"
    },

    "keyboard-layout-language": {
      "title": "Use keyboard layout language",
      "description": "Use keyboard layout language (for example fr for French). Can be usefull with VNC display",
      "type": "string",
      "enum": ["ar", "da", "de", "de-ch", "en-gb", "en-us", "es", "et", "fi", "fo", "fr", "fr-be", "fr-ca", "fr-ch", "hr", "hu", "is", "it", "ja", "lt", "lv", "mk", "nl", "nl-be", "no", "pl", "pt", "pt-br", "ru", "sl", "sv", "th", "tr"]
    },

    "nbd-host": {
      "title": "NBD hostname",
      "description": "hostname (or IP) of the NBD server containing the boot image.",
      "type": "string",
      "format": ["host-name", "ip-address", "ipv6"],
      "default": "debian.nbd.vifib.net"
    },
    "nbd-port": {
      "title": "NBD port",
      "description": "Port of the NBD server containing the boot image.",
      "type": "integer",
      "default": 1024,
      "minimum": 1,
      "maximum": 65535
    },

    "nbd2-host": {
      "title": "Second NBD hostname",
      "description": "hostname (or IP) of the second NBD server (containing drivers for example).",
      "type": "string",
      "format": ["host-name", "ip-address", "ipv6"]
    },
    "nbd2-port": {
      "title": "Second NBD port",
      "description": "Port of the second NBD server containing the boot image.",
      "type": "integer",
      "minimum": 1,
      "maximum": 65535
    },

    "virtual-hard-drive-url": {
      "title": "Existing disk image URL",
      "description": "If specified, will download an existing disk image (qcow2, raw, ...), and will use it as main virtual hard drive. Can be used to download and use an already installed and customized virtual hard drive.",
      "format": "uri",
      "type": "string"
    },
    "virtual-hard-drive-md5sum": {
      "title": "Checksum of virtual hard drive",
      "description": "MD5 checksum of virtual hard drive, used if virtual-hard-drive-url is specified.",
      "type": "string"
    },
    "virtual-hard-drive-gzipped": {
      "title": "Define if virtual hard drive to download is gzipped",
      "description": "Define if virtual hard drive to download is gzipped using gzip. This help to reduce size of file to download.",
      "type": "boolean",
      "default": false
    },
    "hard-drive-url-check-certificate": {
      "title": "Check certificate when downloading virtual hard drive from https.",
      "description": "Define if certificate should be checked when downloading virtual hard drive from https url.",
      "type": "boolean",
      "default": true
    },

    "external-disk-number": {
      "title": "Number of additional disk to create for virtual machine",
      "description": "Specify the number of additional disk to create for virtual machine in data folder of SlapOS Node. Requires instance_storage_home to be configured on SlapOS Node.",
      "type": "integer",
      "minimum": 0,
      "default": 0
    },
    "external-disk-size": {
      "title": "Size of additional disk to create for virtual machine, in Gigabytes",
      "description": "Specify the size of additional disk to create for virtual machine in data folder of SlapOS Node. Requires instance_storage_home to be configured on SlapOS Node.",
      "type": "integer",
      "minimum": 10,
      "maximum": 1000,
      "default": 20
    },
    "external-disk-format": {
      "title": "Type of external disk drive to create by QEMU.",
      "description": "Type of QEMU disk drive, to create.",
      "type": "string",
      "default": "qcow2",
      "enum": ["qcow2", "raw", "vdi", "vmdk", "cloop", "qed"]
    },

    "wipe-disk-ondestroy": {
      "title": "Wipe disks when destroy the VM",
      "description": "Say if disks should be wiped by writing new data over every single bit before delete them. This option is used to securely delete VM disks",
      "type": "boolean",
      "default": false
    },
    "wipe-disk-iterations": {
      "title": "Wipe disk iterations",
      "description": "Number of disk overwrite iterations with random data. Default is 1. WARNING: Increase this value will slow down partition destruction and increase IO.",
      "type": "integer",
      "default": 1,
      "minimum": 1,
      "maximum": 5
    },

    "use-tap": {
      "title": "Use QEMU TAP network interface",
      "description": "Use QEMU TAP network interface, might require a bridge on SlapOS Node.",
      "type": "boolean",
      "default": false
    },
    "use-nat": {
      "title": "Use QEMU USER Mode interface (NAT)",
      "description": "Use QEMU user-mode network stack (NAT).",
      "type": "boolean",
      "default": true
    },
    "nat-rules": {
      "title": "List of rules for NAT of QEMU user mode network stack.",
      "description": "List of rules for NAT of QEMU user mode network stack, as comma-separated list of ports. For each port specified, it will redirect port x of the VM (example: 80) to the port x + 10000 of the public IPv6 (example: 10080). Defaults to \"22 80 443\". Ignored if \"use-tap\" parameter is enabled.",
      "type": "string"
    },
    "nat-restrict-mode": {
      "title": "Isolate the NAT Interface (No Internet access)",
      "description": "If this option is enabled, the NAT interface will be isolated, i.e. it will not be able to contact the host and no guest IP packets will be routed over the host to the outside. This option does not affect any explicitly set nat rules.",
      "type": "boolean",
      "default": false
    },
    "enable-vhost": {
      "title": "Use vhost-net to improve network performance of tap interface",
      "description": "The vhost-net provides much improved network performance for your VM. Only work if the vhost-net kernel module is loaded and available on host machine, please keep this option off if you're not shure.",
      "type": "boolean",
      "default": false
    },
    "monitor-interface-url": {
        "title": "Monitor Web Interface URL",
        "description": "Give Url of HTML web interface that will be used to render this monitor instance.",
        "type": "string",
        "format": "uri",
        "default": "https://monitor.app.officejs.com"
    },
    "monitor-cors-domains": {
        "title": "Monitor CORS domains",
        "description": "List of cors domains separated with space. Needed for ajax query on this monitor instance from a different domain.",
        "type": "string",
        "default": "monitor.app.officejs.com"
    },
    "enable-http-server": {
      "title": "Enable local http server",
      "description": "Set if local http server which serve files to the vm should be deployed. If set to true, get file into the vm with URL: http://10.0.2.100/FILE.",
      "type": "boolean",
      "default": false
    },
    "httpd-port": {
      "title": "Local http server port",
      "description": "Port of the local http server used to share files.",
      "type": "integer",
      "default": 8081,
      "minimum": 1,
      "maximum": 65535
    },
    "authorized-key": {
      "title": "Public keys to get from all virtual machines.",
      "description": "Set the public keys to add in your virtual machine. The public key file will be available in the VM via url http://10.0.2.100/authorized_keys if you keep the NAT interface enabled",
      "type": "string"
    },
    "bootstrap-script-url": {
      "title": "VM bootstrap script URL.",
      "description": "If dedicaced disk image is used, this script will be downloaded and run at first boot of the virtual machine. Set md5sum to URL like: http://example.com/file#MD5SUM. Get file in vm at http://10.0.2.100/vm-bootstrap.",
      "type": "string",
      "format": "uri"
    },
    "data-to-vm": {
      "title": "Text content to send to this virtual machine.",
      "description": "Text content which will be written in a file 'data' of http server of this virtual machine instance. The file will be available via URL: http://10.0.2.100/data in the VM.",
      "type": "string"
    },
    "frontend-instance-guid": {
      "title": "Frontend Instance ID",
      "description": "Unique identifier of the frontend instance, like \"SOFTINST-11031\".",
      "type": "string",
      "default": "SOFTINST-11031"
    },
    "frontend-software-type": {
      "title": "Frontend Software Type",
      "description": "Type of the frontend instance, like \"frontend\".",
      "type": "string",
      "default": "frontend"
    },
    "frontend-software-url": {
      "title": "Frontend Software URL",
      "description": "Software Release URL of the frontend instance, like \"http://example.com/path/to/software.cfg\".",
      "type": "string",
      "format": "uri",
      "default": "https://lab.nexedi.com/nexedi/slapos/raw/slapos-0.92/software/kvm/software.cfg"
    }
  }
}