{
"description": "Schema for IOx application descriptor - version 2.12",
"additionalProperties": false,
"definitions": {
"descriptorschema_2_12.SourceDetails": {
"additionalProperties": false,
"type": "object",
"properties": {
"usage": {
"type": "integer"
},
"name": {
"type": "string"
},
"file": {
"type": "string"
}
}
},
"descriptorschema_2_12.CopyFromHost": {
"additionalProperties": false,
"required": [
"parent-dirname"
],
"type": "object",
"properties": {
"nested-dirname": {
"type": "string"
},
"parent-dirname": {
"type": "string"
}
}
},
"descriptorschema_2_12.StartupNotGenericLinux": {
"additionalProperties": false,
"required": [
"target",
"runtime-version"
],
"type": "object",
"properties": {
"runtime-version": {
"oneOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"runtime-options": {
"$ref": "#/definitions/descriptorschema_2_12.RuntimeOptions"
},
"runtime": {
"not": {
"enum": [
"generic-linux"
],
"type": "string"
}
},
"target": {
"pattern": "^[a-zA-Z]([^/]+(/)?)+$",
"type": "string"
}
}
},
"descriptorschema_2_12.ServiceSecuritySchemas": {
"additionalProperties": false,
"type": "object",
"properties": {
"default-scopes": {
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"oauth2"
],
"type": "string"
},
"available-scopes": {
"items": {
"type": "string"
},
"type": "array"
}
}
},
"descriptorschema_2_12.Rescue": {
"additionalProperties": false,
"required": [
"remove_on_rescue",
"active_app_callback_on_reset",
"callback_timeout"
],
"type": "object",
"properties": {
"active_app_callback_on_reset": {
"type": "string"
},
"remove_on_rescue": {
"type": "string"
},
"callback_timeout": {
"type": "integer"
}
}
},
"descriptorschema_2_12.Devices": {
"additionalProperties": false,
"required": [
"type",
"label"
],
"type": "object",
"properties": {
"function": {
"type": "string"
},
"vendorID": {
"type": "string"
},
"mandatory": {
"type": "boolean"
},
"device-id": {
"type": "string"
},
"device-directory-to-mount": {
"type": "string"
},
"label": {
"type": "string"
},
"alias": {
"type": "string"
},
"mount-point": {
"type": "string"
},
"usage": {
"type": "string"
},
"type": {
"type": "string"
},
"productID": {
"type": "string"
}
}
},
"descriptorschema_2_12.StartupVM_2_1_DISKS": {
"additionalProperties": false,
"required": [
"disks"
],
"type": "object",
"properties": {
"ostype": {
"type": "string"
},
"cdrom": {
"$ref": "#/definitions/descriptorschema_2_12.StartupVM_2_1_CDROM"
},
"disks": {
"items": {
"type": "object",
"properties": {
"target-dev": {
"type": "string"
},
"file": {
"type": "string"
}
}
},
"type": "array"
},
"qemu-guest-agent": {
"type": "boolean"
}
}
},
"descriptorschema_2_12.FileSystem": {
"additionalProperties": false,
"required": [
"fstype"
],
"type": "object",
"properties": {
"target": {
"type": "string"
},
"permission": {
"type": "string"
},
"accessmode": {
"type": "string"
},
"driver": {
"$ref": "#/definitions/descriptorschema_2_12.Driver"
},
"fstype": {
"type": "string"
},
"source": {
"$ref": "#/definitions/descriptorschema_2_12.SourceDetails"
}
}
},
"descriptorschema_2_12.PostUpgrade": {
"additionalProperties": false,
"required": [
"post_script"
],
"type": "object",
"properties": {
"initial_wait_time": {
"type": "number"
},
"post_script": {
"type": "string"
}
}
},
"descriptorschema_2_12.StartupVM_2_1_RFS": {
"additionalProperties": false,
"required": [
"rootfs",
"kernel"
],
"type": "object",
"properties": {
"ostype": {
"type": "string"
},
"kernel": {
"type": "string"
},
"cdrom": {
"$ref": "#/definitions/descriptorschema_2_12.StartupVM_2_1_CDROM"
},
"qemu-guest-agent": {
"type": "boolean"
},
"rootfs": {
"type": "string"
}
}
},
"descriptorschema_2_12.ServiceDependsOn": {
"additionalProperties": false,
"required": [
"id"
],
"type": "object",
"properties": {
"label": {
"type": "string"
},
"required": {
"type": "boolean"
},
"max-api-version": {
"type": "number"
},
"id": {
"type": "string"
},
"min-api-version": {
"type": "number"
}
}
},
"descriptorschema_2_12.ServiceSecurity": {
"additionalProperties": false,
"type": "object",
"properties": {
"type": {
"enum": [
"oauth2"
],
"type": "string"
},
"role": {
"items": {
"enum": [
"OauthClient",
"OauthValidator"
],
"type": "string"
},
"type": "array"
},
"scopes": {
"items": {
"type": "string"
},
"type": "array"
}
}
},
"descriptorschema_2_12.StartupVM_2_1_CDROM": {
"additionalProperties": false,
"required": [
"target-dev",
"file"
],
"type": "object",
"properties": {
"target-dev": {
"type": "string"
},
"file": {
"type": "string"
}
}
},
"descriptorschema_2_12.ResourcesRecommendations": {
"additionalProperties": false,
"required": [
"profile",
"label",
"description"
],
"type": "object",
"properties": {
"profile": {
"type": "string"
},
"description": {
"type": "string"
},
"label": {
"type": "string"
}
}
},
"descriptorschema_2_12.CpuTopologyParams": {
"additionalProperties": false,
"required": [
"sockets-per-core",
"cores"
],
"type": "object",
"properties": {
"cores": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"sockets-per-core": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
}
}
},
"descriptorschema_2_12.AppVM": {
"additionalProperties": false,
"required": [
"cpuarch",
"type",
"startup"
],
"type": "object",
"properties": {
"cpu-core": {
"type": "string"
},
"post_upgrade": {
"$ref": "#/definitions/descriptorschema_2_12.PostUpgrade"
},
"system-capabilities": {
"type": "object",
"properties": {}
},
"startup": {
"oneOf": [
{
"$ref": "#/definitions/descriptorschema_2_12.StartupVM_2_1_RFS"
},
{
"$ref": "#/definitions/descriptorschema_2_12.StartupVM_2_1_DISKS"
}
]
},
"monitor": {
"$ref": "#/definitions/descriptorschema_2_12.Monitor"
},
"depends-on": {
"oneOf": [
{
"required": [
"packages"
],
"type": "object",
"properties": {
"packages": {
"items": {
"$ref": "#/definitions/descriptorschema_2_12.PackageDependsOn"
},
"type": "array"
}
}
}
]
},
"cpuarch": {
"type": "string"
},
"env": {
"additionalProperties": true,
"type": "object",
"properties": {}
},
"type": {
"enum": [
"vm"
],
"type": "string"
},
"resources": {
"$ref": "#/definitions/descriptorschema_2_12.Resources"
},
"rescue": {
"$ref": "#/definitions/descriptorschema_2_12.Rescue"
}
}
},
"descriptorschema_2_12.StartupLXC": {
"additionalProperties": false,
"required": [
"rootfs",
"target"
],
"type": "object",
"properties": {
"target": {
"pattern": "^[/a-zA-Z]([^/]+(/)?)+$",
"type": "string"
},
"rootfs": {
"type": "string"
}
}
},
"descriptorschema_2_12.Service": {
"additionalProperties": false,
"required": [
"id",
"api-version",
"version"
],
"type": "object",
"properties": {
"api-version": {
"type": "number"
},
"port-mapping": {
"items": {
"pattern": "^[\\w]+:(tcp|udp){1}:[0-9-]+$",
"type": "string"
},
"type": "array"
},
"version": {
"type": "string"
},
"id": {
"type": "string"
},
"description": {
"type": "string"
}
}
},
"descriptorschema_2_12.StartupGenericLinux": {
"additionalProperties": false,
"required": [
"runtime",
"target"
],
"type": "object",
"properties": {
"runtime": {
"enum": [
"generic-linux"
],
"type": "string"
},
"target": {
"pattern": "^[a-zA-Z]([^/]+(/)?)+$",
"type": "string"
}
}
},
"descriptorschema_2_12.CharDev": {
"additionalProperties": false,
"required": [
"dev",
"type"
],
"type": "object",
"properties": {
"type": {
"type": "string"
},
"dev": {
"type": "string"
}
}
},
"descriptorschema_2_12.Graphics": {
"additionalProperties": false,
"type": "object",
"properties": {
"vnc": {
"type": "boolean"
}
}
},
"descriptorschema_2_12.AppDocker_2_2": {
"additionalProperties": false,
"required": [
"cpuarch",
"type",
"startup"
],
"type": "object",
"properties": {
"cpu-core": {
"type": "string"
},
"post_upgrade": {
"$ref": "#/definitions/descriptorschema_2_12.PostUpgrade"
},
"system-capabilities": {
"type": "object",
"properties": {}
},
"startup": {
"oneOf": [
{
"$ref": "#/definitions/descriptorschema_2_12.StartupDocker_2"
},
{
"$ref": "#/definitions/descriptorschema_2_12.StartupDocker"
}
]
},
"monitor": {
"$ref": "#/definitions/descriptorschema_2_12.Monitor"
},
"depends-on": {
"oneOf": [
{
"required": [
"packages"
],
"type": "object",
"properties": {
"packages": {
"items": {
"$ref": "#/definitions/descriptorschema_2_12.PackageDependsOn"
},
"type": "array"
}
}
}
]
},
"cpuarch": {
"type": "string"
},
"env": {
"additionalProperties": true,
"type": "object",
"properties": {}
},
"type": {
"enum": [
"docker"
],
"type": "string"
},
"resources": {
"$ref": "#/definitions/descriptorschema_2_12.Resources"
},
"rescue": {
"$ref": "#/definitions/descriptorschema_2_12.Rescue"
}
}
},
"descriptorschema_2_12.RamFS": {
"additionalProperties": false,
"required": [
"size"
],
"type": "object",
"properties": {
"size": {
"type": "string"
}
}
},
"descriptorschema_2_12.StartupDocker": {
"additionalProperties": false,
"required": [
"rootfs",
"target"
],
"type": "object",
"properties": {
"os-mode": {
"type": "boolean"
},
"workdir": {
"type": "string"
},
"group": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"target": {
"oneOf": [
{
"pattern": "^[/a-zA-Z]([^/]+(/)?)+$",
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"accessmode": {
"enum": [
"readonly",
"readwrite"
],
"type": "string"
},
"args": {
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
},
"user": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"users": {
"enum": [
"single",
"multiple"
],
"type": "string"
},
"runtime_options": {
"type": "string"
},
"rootfs": {
"type": "string"
}
}
},
"descriptorschema_2_12.CartridgeDependsOn": {
"additionalProperties": false,
"required": [
"id",
"version"
],
"type": "object",
"properties": {
"version": {
"type": "number"
},
"id": {
"type": "string"
}
}
},
"descriptorschema_2_12.HostMounts": {
"additionalProperties": false,
"required": [
"target_mount"
],
"type": "object",
"properties": {
"description": {
"type": "string"
},
"target_mount": {
"type": "string"
},
"host_mount_path": {
"type": "string"
}
}
},
"descriptorschema_2_12.StartupDocker_2": {
"additionalProperties": false,
"required": [
"image-name",
"tag",
"target"
],
"type": "object",
"properties": {
"image-name": {
"type": "string"
},
"tag": {
"type": "string"
},
"target": {
"oneOf": [
{
"pattern": "^[/a-zA-Z]([^/]+(/)?)+$",
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
}
}
},
"descriptorschema_2_12.Resources": {
"additionalProperties": false,
"required": [
"profile"
],
"type": "object",
"properties": {
"host_mounts": {
"items": {
"$ref": "#/definitions/descriptorschema_2_12.HostMounts"
},
"type": "array"
},
"ramfs": {
"$ref": "#/definitions/descriptorschema_2_12.RamFS"
},
"copy-from-host": {
"$ref": "#/definitions/descriptorschema_2_12.CopyFromHost"
},
"datastore": {
"type": "boolean"
},
"platform-env": {
"items": {
"type": "string"
},
"type": "array"
},
"visualization": {
"type": "boolean"
},
"disk": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"network": {
"items": {
"$ref": "#/definitions/descriptorschema_2_12.Network"
},
"type": "array"
},
"vcpu": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"memory": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"rootfs_expanded_size": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"access-control": {
"$ref": "#/definitions/descriptorschema_2_12.ServiceSecurity"
},
"privileged": {
"type": "boolean"
},
"profile": {
"type": "string"
},
"rootfs_size": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"filesystem": {
"items": {
"$ref": "#/definitions/descriptorschema_2_12.FileSystem"
},
"type": "array"
},
"device-info": {
"items": {
"enum": [
"udi"
],
"type": "string"
},
"type": "array"
},
"broker": {
"items": {
"enum": [
"BrokerClient",
"Broker"
],
"type": "string"
},
"type": "array"
},
"graphics": {
"$ref": "#/definitions/descriptorschema_2_12.Graphics"
},
"oauth": {
"items": {
"enum": [
"OauthClient",
"OauthValidator"
],
"type": "string"
},
"type": "array"
},
"container-size": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"cpu-topology": {
"oneOf": [
{
"$ref": "#/definitions/descriptorschema_2_12.CpuTopologyParams"
}
]
},
"extended-resources": {
"type": "boolean"
},
"devices": {
"items": {
"$ref": "#/definitions/descriptorschema_2_12.Devices"
},
"type": "array"
},
"persistent_data_target": {
"type": "string"
},
"chardev": {
"items": {
"$ref": "#/definitions/descriptorschema_2_12.CharDev"
},
"type": "array"
},
"recommendations": {
"items": {
"$ref": "#/definitions/descriptorschema_2_12.ResourcesRecommendations"
},
"type": "array"
},
"cpu": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"seed-controller-certificate": {
"type": "boolean"
}
}
},
"descriptorschema_2_12.Driver": {
"additionalProperties": false,
"type": "object",
"properties": {
"type": {
"type": "string"
},
"name": {
"type": "string"
},
"wrpolicy": {
"type": "string"
}
}
},
"descriptorschema_2_12.ServiceBundle": {
"additionalProperties": false,
"required": [
"provides"
],
"type": "object",
"properties": {
"security-schemas": {
"items": {
"$ref": "#/definitions/descriptorschema_2_12.ServiceSecuritySchemas"
},
"type": "array"
},
"provides": {
"items": {
"$ref": "#/definitions/descriptorschema_2_12.Service"
},
"type": "array"
}
}
},
"descriptorschema_2_12.Ports": {
"additionalProperties": false,
"required": [
"port"
],
"type": "object",
"properties": {
"port": {
"type": "string"
},
"description": {
"type": "string"
}
}
},
"descriptorschema_2_12.RuntimeOptions": {
"additionalProperties": true,
"required": [
"classpath"
],
"type": "object",
"properties": {
"classpath": {
"type": "string"
}
}
},
"descriptorschema_2_12.Monitor": {
"additionalProperties": false,
"required": [
"script"
],
"type": "object",
"properties": {
"period_seconds": {
"type": "number"
},
"initial_delay_seconds": {
"type": "number"
},
"script": {
"type": "string"
}
}
},
"descriptorschema_2_12.AppPaas": {
"additionalProperties": false,
"required": [
"type",
"startup"
],
"type": "object",
"properties": {
"post_upgrade": {
"$ref": "#/definitions/descriptorschema_2_12.PostUpgrade"
},
"system-capabilities": {
"type": "object",
"properties": {}
},
"stop": {
"$ref": "#/definitions/descriptorschema_2_12.Stop"
},
"startup": {
"oneOf": [
{
"$ref": "#/definitions/descriptorschema_2_12.StartupGenericLinux"
},
{
"$ref": "#/definitions/descriptorschema_2_12.StartupNotGenericLinux"
}
]
},
"monitor": {
"$ref": "#/definitions/descriptorschema_2_12.Monitor"
},
"depends-on": {
"anyOf": [
{
"required": [
"cartridges"
],
"type": "object",
"properties": {
"cartridges": {
"items": {
"$ref": "#/definitions/descriptorschema_2_12.CartridgeDependsOn"
},
"type": "array"
}
}
},
{
"required": [
"packages"
],
"type": "object",
"properties": {
"packages": {
"items": {
"$ref": "#/definitions/descriptorschema_2_12.PackageDependsOn"
},
"type": "array"
}
}
}
]
},
"cpuarch": {
"type": "string"
},
"env": {
"additionalProperties": true,
"type": "object",
"properties": {}
},
"type": {
"enum": [
"paas"
],
"type": "string"
},
"resources": {
"$ref": "#/definitions/descriptorschema_2_12.Resources"
},
"rescue": {
"$ref": "#/definitions/descriptorschema_2_12.Rescue"
}
}
},
"descriptorschema_2_12.Network": {
"additionalProperties": false,
"required": [
"interface-name"
],
"type": "object",
"properties": {
"interface-name": {
"type": "string"
},
"hint": {
"type": "string"
},
"mac_forward_disable_mask": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"mirroring": {
"type": "boolean"
},
"mac_forward_enable_mask": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"ipv6_required": {
"type": "boolean"
},
"type": {
"enum": [
"external",
"east-west",
"eobc"
],
"type": "string"
},
"ports": {
"anyOf": [
{
"type": "object",
"properties": {
"tcp": {
"items": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"$ref": "#/definitions/descriptorschema_2_12.Ports"
}
]
}
],
"type": "array"
}
}
},
{
"type": "object",
"properties": {
"udp": {
"items": [
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"$ref": "#/definitions/descriptorschema_2_12.Ports"
}
]
}
],
"type": "array"
}
}
}
]
},
"voice-vlan": {
"type": "boolean"
},
"description": {
"type": "string"
}
}
},
"descriptorschema_2_12.AppLXC": {
"additionalProperties": false,
"required": [
"cpuarch",
"type",
"startup"
],
"type": "object",
"properties": {
"cpu-core": {
"type": "string"
},
"post_upgrade": {
"$ref": "#/definitions/descriptorschema_2_12.PostUpgrade"
},
"system-capabilities": {
"type": "object",
"properties": {}
},
"startup": {
"$ref": "#/definitions/descriptorschema_2_12.StartupLXC"
},
"monitor": {
"$ref": "#/definitions/descriptorschema_2_12.Monitor"
},
"depends-on": {
"oneOf": [
{
"required": [
"packages"
],
"type": "object",
"properties": {
"packages": {
"items": {
"$ref": "#/definitions/descriptorschema_2_12.PackageDependsOn"
},
"type": "array"
}
}
}
]
},
"kernel-version": {
"type": "string"
},
"cpuarch": {
"type": "string"
},
"env": {
"additionalProperties": true,
"type": "object",
"properties": {}
},
"type": {
"enum": [
"lxc"
],
"type": "string"
},
"resources": {
"$ref": "#/definitions/descriptorschema_2_12.Resources"
},
"rescue": {
"$ref": "#/definitions/descriptorschema_2_12.Rescue"
}
}
},
"descriptorschema_2_12.AppInfo": {
"additionalProperties": false,
"required": [
"name",
"version"
],
"type": "object",
"properties": {
"author-name": {
"type": "string"
},
"version": {
"type": "string"
},
"author-link": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
}
}
},
"descriptorschema_2_12.PackageDependsOn": {
"additionalProperties": false,
"required": [
"name",
"version"
],
"type": "object",
"properties": {
"services": {
"items": {
"$ref": "#/definitions/descriptorschema_2_12.ServiceDependsOn"
},
"type": "array"
},
"version": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"descriptorschema_2_12.Stop": {
"additionalProperties": false,
"required": [
"target"
],
"type": "object",
"properties": {
"target": {
"pattern": "^[a-zA-Z]([^/]+(/)?)+$",
"type": "string"
}
}
}
},
"$schema": "http://json-schema.org/draft-04/schema#",
"required": [
"descriptor-schema-version",
"info",
"app"
],
"type": "object",
"properties": {
"info": {
"$ref": "#/definitions/descriptorschema_2_12.AppInfo"
},
"service-bundle": {
"$ref": "#/definitions/descriptorschema_2_12.ServiceBundle"
},
"app": {
"oneOf": [
{
"$ref": "#/definitions/descriptorschema_2_12.AppPaas"
},
{
"$ref": "#/definitions/descriptorschema_2_12.AppLXC"
},
{
"$ref": "#/definitions/descriptorschema_2_12.AppVM"
},
{
"$ref": "#/definitions/descriptorschema_2_12.AppDocker_2_2"
}
]
},
"descriptor-schema-version": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
}
}
}