instance-kvm-input-schema.json 10.8 KB
Newer Older
1
{
2 3 4 5
  "type": "object",
  "$schema": "http://json-schema.org/draft-04/schema",

  "title": "Input Parameters",
6 7 8 9 10 11 12
  "properties": {
    "ram-size": {
      "title": "RAM size",
      "description": "RAM size, in MB.",
      "type": "integer",
      "default": 1024,
      "minimum": 128,
13
      "multipleOf": 128
14
    },
15 16 17 18 19 20
    "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
    },
21 22 23 24 25 26
    "disk-size": {
      "title": "Disk size",
      "description": "Disk size, in GB.",
      "type": "integer",
      "default": 10,
      "minimum": 1,
27
      "maximum": 1000
28
    },
29 30 31 32 33 34 35
    "disk-type": {
      "title": "Disk type",
      "description": "Type of QEMU disk drive.",
      "type": "string",
      "default": "virtio",
      "enum": ["ide", "scsi", "sd", "mtd", "floppy", "pflash", "virtio"]
    },
36 37 38 39 40 41 42 43 44 45 46 47 48 49
    "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"]
    },
50 51 52 53 54

    "cpu-count": {
      "title": "CPU count",
      "description": "Number of CPU cores.",
      "type": "integer",
55
      "minimum": 1
56
    },
57
    "cpu-options": {
58 59
      "title": "CPU Additional options: cores, threads, sockets, maxcpus.",
      "description": "Additional options to use with cpu-count. Options are separated by coma: [cores=cores][,threads=threads][,sockets=sockets][,maxcpus=maxcpus]. Set this option if you know what you're doing.",
60 61 62
      "type": "string"
    },
    "numa": {
63 64
      "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.",
65 66
      "type": "string"
    },
67 68 69 70 71 72 73 74 75 76 77
    "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"
    },

78 79 80 81 82 83
    "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"]
    },
84

85
    "nbd-host": {
86 87 88 89 90 91 92 93 94 95 96 97 98 99
      "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
    },
100

101 102 103 104
    "nbd2-host": {
      "title": "Second NBD hostname",
      "description": "hostname (or IP) of the second NBD server (containing drivers for example).",
      "type": "string",
105
      "format": ["host-name", "ip-address", "ipv6"]
106 107 108 109 110 111 112 113 114
    },
    "nbd2-port": {
      "title": "Second NBD port",
      "description": "Port of the second NBD server containing the boot image.",
      "type": "integer",
      "minimum": 1,
      "maximum": 65535
    },

115 116 117 118
    "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",
119
      "type": "string"
120
    },
121 122 123
    "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.",
124
      "type": "string"
125
    },
126 127 128 129 130 131
    "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
    },
132 133 134 135 136 137
    "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
    },
138 139 140 141 142 143 144 145 146

    "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": {
147 148
      "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.",
149
      "type": "integer",
150
      "minimum": 10,
151
      "maximum": 1000,
152 153
      "default": 20
    },
154 155 156 157 158
    "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",
159
      "enum": ["qcow2", "raw", "vdi", "vmdk", "cloop", "qed"]
160
    },
161

162 163
    "use-tap": {
      "title": "Use QEMU TAP network interface",
164
      "description": "Use QEMU TAP network interface, might require a bridge on SlapOS Node.",
165 166 167
      "type": "boolean",
      "default": false
    },
168
    "use-nat": {
169
      "title": "Use QEMU USER Mode interface (NAT)",
170 171 172 173
      "description": "Use QEMU user-mode network stack (NAT).",
      "type": "boolean",
      "default": true
    },
174 175 176
    "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.",
177
      "type": "string"
178
    },
179 180 181 182 183 184
    "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": true
    },
185 186 187 188 189 190
    "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
    },
Alain Takoudjou's avatar
Alain Takoudjou committed
191 192 193 194 195 196
    "enable-monitor": {
      "title": "Deploy monitoring tools",
      "description": "Deploy monitor instance to this kvm instance. It help to check instance status, log and promise results.",
      "type": "boolean",
      "default": true
    },
197 198 199 200
    "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",
201
        "format": "uri",
202
        "default": "https://monitor.app.officejs.com"
203 204 205 206 207
    },
    "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",
208
        "default": "monitor.app.officejs.com"
209
    },
210 211 212 213 214 215 216 217 218 219 220 221 222 223
    "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
    },
224
    "authorized-key": {
225
      "title": "Public keys to get from all virtual machines.",
226 227 228
      "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"
    },
229 230 231
    "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.",
232 233
      "type": "string",
      "format": "uri"
234
    },
235 236 237
    "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.",
238 239
      "type": "string"
    },
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256
    "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",
257
      "default": "https://lab.nexedi.com/nexedi/slapos/raw/slapos-0.92/software/kvm/software.cfg"
258 259 260
    }
  }
}