X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=osm_ro%2Fopenmano_schemas.py;h=5839e24fb9c788d08b49dc288e8556732358e9e7;hb=fc7cfbf916777271ba2cf1c8edfa5d62ab9c8ce3;hp=7d218ec191126f7bb63768c64be5264ed92f1534;hpb=4a2c09e0fd7280af219dcad61111311a440e936f;p=osm%2FRO.git diff --git a/osm_ro/openmano_schemas.py b/osm_ro/openmano_schemas.py index 7d218ec1..5839e24f 100644 --- a/osm_ro/openmano_schemas.py +++ b/osm_ro/openmano_schemas.py @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- ## -# Copyright 2015 Telefónica Investigación y Desarrollo, S.A.U. +# Copyright 2015 Telefonica Investigacion y Desarrollo, S.A.U. # This file is part of openmano # All Rights Reserved. # @@ -22,7 +22,7 @@ ## ''' -JSON schemas used by openmano httpserver.py module to parse the different files and messages sent through the API +JSON schemas used by openmano httpserver.py module to parse the different files and messages sent through the API ''' __author__="Alfonso Tierno, Gerardo Garcia, Pablo Montes" __date__ ="$09-oct-2014 09:09:48$" @@ -37,6 +37,9 @@ description_schema={"type" : ["string","null"], "maxLength":255, "pattern" : "^[ id_schema_fake = {"type" : "string", "minLength":2, "maxLength":36 } #"pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$" id_schema = {"type" : "string", "pattern": "^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$"} pci_schema={"type":"string", "pattern":"^[0-9a-fA-F]{4}(:[0-9a-fA-F]{2}){2}\.[0-9a-fA-F]$"} +# allows [] for wildcards. For that reason huge length limit is set +pci_extended_schema = {"type": "string", "pattern": "^[0-9a-fA-F.:-\[\]]{12,40}$"} + http_schema={"type":"string", "pattern":"^https?://[^'\"=]+$"} bandwidth_schema={"type":"string", "pattern" : "^[0-9]+ *([MG]bps)?$"} memory_schema={"type":"string", "pattern" : "^[0-9]+ *([MG]i?[Bb])?$"} @@ -45,7 +48,7 @@ integer1_schema={"type":"integer","minimum":1} path_schema={"type":"string", "pattern":"^(\.){0,2}(/[^/\"':{}\(\)]+)+$"} vlan_schema={"type":"integer","minimum":1,"maximum":4095} vlan1000_schema={"type":"integer","minimum":1000,"maximum":4095} -mac_schema={"type":"string", "pattern":"^[0-9a-fA-F][02468aceACE](:[0-9a-fA-F]{2}){5}$"} #must be unicast LSB bit of MSB byte ==0 +mac_schema={"type":"string", "pattern":"^[0-9a-fA-F][02468aceACE](:[0-9a-fA-F]{2}){5}$"} #must be unicast LSB bit of MSB byte ==0 #mac_schema={"type":"string", "pattern":"^([0-9a-fA-F]{2}:){5}[0-9a-fA-F]{2}$"} ip_schema={"type":"string","pattern":"^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$"} ip_prefix_schema={"type":"string","pattern":"^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)/(30|[12]?[0-9])$"} @@ -56,6 +59,8 @@ schema_version_2={"type":"integer","minimum":2,"maximum":2} log_level_schema={"type":"string", "enum":["DEBUG", "INFO", "WARNING","ERROR","CRITICAL"]} checksum_schema={"type":"string", "pattern":"^[0-9a-fA-F]{32}$"} size_schema={"type":"integer","minimum":1,"maximum":100} +boolean_schema = {"type": "boolean"} +null_schema = {"type": "null"} metadata_schema={ "type":"object", @@ -80,7 +85,7 @@ config_schema = { "http_port": port_schema, "http_admin_port": port_schema, "http_host": nameshort_schema, - "auto_push_VNF_to_VIMs": {"type":"boolean"}, + "auto_push_VNF_to_VIMs": boolean_schema, "vnf_repository": path_schema, "db_host": nameshort_schema, "db_user": nameshort_schema, @@ -96,26 +101,28 @@ config_schema = { "vim_name": nameshort_schema, "vim_tenant_name": nameshort_schema, "mano_tenant_name": nameshort_schema, - "mano_tenant_id": id_schema, - "http_console_proxy": {"type":"boolean"}, + "mano_tenant_id": id_schema, + "http_console_proxy": boolean_schema, "http_console_host": nameshort_schema, "http_console_ports": { - "type": "array", - "items": {"OneOf" : [ - port_schema, - {"type":"object", "properties":{"from": port_schema, "to": port_schema}, "required": ["from","to"]} + "type": "array", + "items": {"OneOf": [ + port_schema, + {"type": "object", "properties": {"from": port_schema, "to": port_schema}, "required": ["from", "to"]} ]} }, "log_level": log_level_schema, "log_socket_level": log_level_schema, "log_level_db": log_level_schema, "log_level_vim": log_level_schema, + "log_level_wim": log_level_schema, "log_level_nfvo": log_level_schema, "log_level_http": log_level_schema, "log_level_console": log_level_schema, "log_level_ovim": log_level_schema, "log_file_db": path_schema, "log_file_vim": path_schema, + "log_file_wim": path_schema, "log_file_nfvo": path_schema, "log_file_http": path_schema, "log_file_console": path_schema, @@ -257,7 +264,7 @@ datacenter_action_schema = { "net": name_schema, #name or uuid of net to change "name": name_schema, "description": description_schema, - "shared": {"type": "boolean"} + "shared": boolean_schema }, "minProperties": 1, "additionalProperties": False @@ -283,15 +290,17 @@ datacenter_associate_schema={ "type":"object", "properties":{ "datacenter":{ - "type":"object", - "properties":{ + "type": "object", + "properties": { + "name": name_schema, + "vim_id": id_schema, "vim_tenant": name_schema, "vim_tenant_name": name_schema, "vim_username": nameshort_schema, "vim_password": nameshort_schema, "config": {"type": "object"} }, -# "required": ["vim_tenant"], + # "required": ["vim_tenant"], "additionalProperties": True } }, @@ -300,23 +309,23 @@ datacenter_associate_schema={ } dhcp_schema = { - "title":"DHCP schema", + "title": "DHCP schema", "$schema": "http://json-schema.org/draft-04/schema#", - "type":"object", + "type": "object", "properties":{ - "enabled": {"type": "boolean"}, - "start-address": ip_schema, - "count": integer1_schema + "enabled": boolean_schema, + "start-address": {"OneOf": [null_schema, ip_schema]}, + "count": integer0_schema }, - "required": ["enabled", "start-address", "count"], + # "required": ["start-address", "count"], } ip_profile_schema = { - "title":"IP profile schema", + "title": "IP profile schema", "$schema": "http://json-schema.org/draft-04/schema#", - "type":"object", - "properties":{ - "ip-version": {"type": "string", "enum": ["IPv4","IPv6"]}, + "type": "object", + "properties": { + "ip-version": {"type": "string", "enum": ["IPv4", "IPv6"]}, "subnet-address": ip_prefix_schema, "gateway-address": ip_schema, "dns-address": {"oneOf": [ip_schema, # for backward compatibility @@ -386,7 +395,7 @@ internal_connection_schema = { "name": name_schema, "description":description_schema, "type":{"type":"string", "enum":["bridge","data","ptp"]}, - "elements": {"type" : "array", "items": internal_connection_element_schema, "minItems":2} + "elements": {"type" : "array", "items": internal_connection_element_schema, "minItems":1} }, "required": ["name", "type", "elements"], "additionalProperties": False @@ -400,7 +409,7 @@ internal_connection_schema_v02 = { "type": {"type": "string", "enum":["e-line", "e-lan"]}, "implementation": {"type": "string", "enum":["overlay", "underlay"]}, "ip-profile": ip_profile_schema, - "elements": {"type" : "array", "items": internal_connection_element_schema_v02, "minItems":2} + "elements": {"type" : "array", "items": internal_connection_element_schema_v02, "minItems":1} }, "required": ["name", "type", "implementation", "elements"], "additionalProperties": False @@ -424,8 +433,8 @@ external_connection_schema_v02 = { "type":"object", "properties":{ "name": name_schema, - "mgmt": {"type":"boolean"}, - "type": {"type": "string", "enum":["e-line", "e-lan"]}, + "mgmt": boolean_schema, + "type": {"type": "string", "enum":["e-line", "e-lan"]}, "implementation": {"type": "string", "enum":["overlay", "underlay"]}, "VNFC": name_schema, "local_iface_name": name_schema , @@ -460,9 +469,9 @@ bridge_interfaces_schema={ "bandwidth":bandwidth_schema, "vpci":pci_schema, "mac_address": mac_schema, - "model": {"type":"string", "enum":["virtio","e1000","ne2k_pci","pcnet","rtl8139"]}, - "port-security": {"type" : "boolean"}, - "floating-ip": {"type" : "boolean"} + "model": {"type":"string", "enum":["virtio","e1000","ne2k_pci","pcnet","rtl8139", "paravirt"]}, + "port-security": boolean_schema, + "floating-ip": boolean_schema, }, "additionalProperties": False, "required": ["name"] @@ -482,6 +491,7 @@ devices_schema={ "size": size_schema, "vpci":pci_schema, "xml":xml_text_schema, + "name": name_schema, }, "additionalProperties": False, "required": ["type"] @@ -531,7 +541,7 @@ boot_data_vdu_schema = { "user-data": {"type" : "string"}, # scrip to run "config-files": {"type": "array", "items": config_files_schema}, # NOTE: “user-data” are mutually exclusive with users and config-files because user/files are injected using user-data - "boot-data-drive": {"type": "boolean"}, + "boot-data-drive": boolean_schema, }, "additionalProperties": False, } @@ -541,10 +551,12 @@ vnfc_schema = { "properties":{ "name": name_schema, "description": description_schema, - "VNFC image": {"oneOf": [path_schema, http_schema]}, + "count": integer1_schema, "image name": name_schema, + "availability_zone": name_schema, + "VNFC image": {"oneOf": [path_schema, http_schema]}, "image checksum": checksum_schema, - "image metadata": metadata_schema, + "image metadata": metadata_schema, #"cloud-config": cloud_config_schema, #common for all vnfs in the scenario "processor": { "type":"object", @@ -572,7 +584,7 @@ vnfc_schema = { "bridge-ifaces": bridge_interfaces_schema, "devices": devices_schema, "boot-data" : boot_data_vdu_schema - + }, "required": ["name"], "oneOf": [ @@ -592,9 +604,11 @@ vnfd_schema_v01 = { "properties":{ "name": name_schema, "description": description_schema, + "class": nameshort_schema, - "public": {"type" : "boolean"}, - "physical": {"type" : "boolean"}, + "public": boolean_schema, + "physical": boolean_schema, + "default_user": name_schema, "tenant_id": id_schema, #only valid for admin "external-connections": {"type" : "array", "items": external_connection_schema, "minItems":1}, "internal-connections": {"type" : "array", "items": internal_connection_schema, "minItems":1}, @@ -608,7 +622,7 @@ vnfd_schema_v01 = { "additionalProperties": False } -#VNFD schema for OSM R1 +#VNFD schema for OSM R1 vnfd_schema_v02 = { "title":"vnfd information schema v0.2", "$schema": "http://json-schema.org/draft-04/schema#", @@ -621,8 +635,8 @@ vnfd_schema_v02 = { "name": name_schema, "description": description_schema, "class": nameshort_schema, - "public": {"type" : "boolean"}, - "physical": {"type" : "boolean"}, + "public": boolean_schema, + "physical": boolean_schema, "tenant_id": id_schema, #only valid for admin "external-connections": {"type" : "array", "items": external_connection_schema, "minItems":1}, "internal-connections": {"type" : "array", "items": internal_connection_schema_v02, "minItems":1}, @@ -671,7 +685,7 @@ nsd_schema_v01 = { "name":name_schema, "description": description_schema, "tenant_id": id_schema, #only valid for admin - "public": {"type": "boolean"}, + "public": boolean_schema, "topology":{ "type":"object", "properties":{ @@ -727,7 +741,7 @@ nsd_schema_v02 = { "name": name_schema, "description": description_schema, "tenant_id": id_schema, #only valid for admin - "public": {"type": "boolean"}, + "public": boolean_schema, "vnfs": { "type":"object", "patternProperties":{ @@ -750,14 +764,14 @@ nsd_schema_v02 = { "properties":{ "interfaces":{"type":"array", "minLength":1}, "type": {"type": "string", "enum":["dataplane", "bridge"]}, - "external" : {"type": "boolean"}, + "external" : boolean_schema, "graph": graph_schema }, "required": ["interfaces"] }, } }, - + }, "required": ["vnfs", "name"], "additionalProperties": False @@ -780,7 +794,7 @@ nsd_schema_v03 = { "name": name_schema, "description": description_schema, "tenant_id": id_schema, #only valid for admin - "public": {"type": "boolean"}, + "public": boolean_schema, "cloud-config": cloud_config_schema, #common for all vnfs in the scenario #"datacenter": name_schema, "vnfs": { @@ -808,7 +822,7 @@ nsd_schema_v03 = { "properties":{ "VNFC": name_schema, "local_iface_name": name_schema, - "ip_address": ip_schema + "ip_address": ip_schema, }, "required": ["VNFC", "local_iface_name"], } @@ -843,7 +857,7 @@ nsd_schema_v03 = { }, "type": {"type": "string", "enum":["e-line", "e-lan"]}, "implementation": {"type": "string", "enum":["overlay", "underlay"]}, - "external" : {"type": "boolean"}, + "external" : boolean_schema, "graph": graph_schema, "ip-profile": ip_profile_schema }, @@ -851,7 +865,7 @@ nsd_schema_v03 = { }, } }, - + }, "required": ["vnfs", "networks","name"], "additionalProperties": False @@ -953,21 +967,48 @@ scenario_action_schema = { "additionalProperties": False } +instance_scenario_object = { + "title": "scenario object used to create an instance not based on any nsd", + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "properties": { + "nets": { + "type": "array", + "minLength": 1, + "items": { + "type": "object", + "properties": { + "name": name_schema, + "external": boolean_schema, + "type": {"enum": ["bridge", "ptp", "data"]}, # for overlay, underlay E-LINE, underlay E-LAN + }, + "additionalProperties": False, + "required": ["name", "external", "type"] + } + } + }, + "additionalProperties": False, + "required": ["nets"] +} + instance_scenario_create_schema_v01 = { - "title":"instance scenario create information schema v0.1", + "title": "instance scenario create information schema v0.1", "$schema": "http://json-schema.org/draft-04/schema#", - "type":"object", - "properties":{ + "type": "object", + "properties": { "schema_version": {"type": "string", "enum": ["0.1"]}, - "instance":{ - "type":"object", - "properties":{ - "name":name_schema, + "instance": { + "type": "object", + "properties": { + "mgmt_keys": {"type": "array", "items": {"type":"string"}}, + "vduImage": name_schema, + "name": name_schema, "description":description_schema, "datacenter": name_schema, - "scenario" : name_schema, #can be an UUID or name + "wim_account": {"oneOf": [boolean_schema, id_schema, null_schema]}, + "scenario" : {"oneOff": [name_schema, instance_scenario_object]}, # can be an UUID or name or a dict "action":{"enum": ["deploy","reserve","verify" ]}, - "connect_mgmt_interfaces": {"oneOf": [{"type":"boolean"}, {"type":"object"}]},# can be true or a dict with datacenter: net_name + "connect_mgmt_interfaces": {"oneOf": [boolean_schema, {"type":"object"}]},# can be true or a dict with datacenter: net_name "cloud-config": cloud_config_schema, #common to all vnfs in the instance scenario "vnfs":{ #mapping from scenario to datacenter "type": "object", @@ -980,41 +1021,51 @@ instance_scenario_create_schema_v01 = { #"metadata": {"type": "object"}, #"user_data": {"type": "string"} #"cloud-config": cloud_config_schema, #particular for a vnf - "external-connections": { + "vdus": { "type": "object", "patternProperties": { ".": { "type": "object", "properties": { - "vim-network-name": name_schema, - "ip_address": ip_schema - } + "name": name_schema, # overrides vdu name schema + "mgmt_keys": {"type": "array", "items": {"type": "string"}}, + "vduImage": name_schema, + "devices": { + "type": "object", + "patternProperties": { + ".": { + "vim_id": name_schema, + } + } + }, + "interfaces": { + "type": "object", + "patternProperties": { + ".": { + "ip_address": ip_schema, + "mac_address": mac_schema, + "floating-ip": boolean_schema, + } + } + } + } } } }, - "internal-connections": { + "networks": { "type": "object", "patternProperties": { ".": { "type": "object", "properties": { + "vim-network-name": name_schema, + "vim-network-id": name_schema, "ip-profile": ip_profile_schema, - "elements": { - "type" : "array", - "items":{ - "type":"object", - "properties":{ - "VNFC": name_schema, - "local_iface_name": name_schema, - "ip_address": ip_schema - }, - "required": ["VNFC", "local_iface_name"], - } - } + "name": name_schema, } } } - } + }, } } }, @@ -1033,15 +1084,17 @@ instance_scenario_create_schema_v01 = { "properties":{ "ip_address": ip_schema, "datacenter": name_schema, - "vim-network-name": name_schema + "vim-network-name": name_schema, + "vim-network-id": name_schema }, "patternProperties":{ ".": {"type": "string"} } } }, + "wim_account": {"oneOf": [boolean_schema, id_schema, null_schema]}, "ip-profile": ip_profile_schema, - #if the network connects VNFs deployed at different sites, you must specify one entry per site that this network connect to + #if the network connects VNFs deployed at different sites, you must specify one entry per site that this network connect to "sites": { "type":"array", "minLength":1, @@ -1050,22 +1103,20 @@ instance_scenario_create_schema_v01 = { "properties":{ # By default for an scenario 'external' network openmano looks for an existing VIM network to map this external scenario network, # for other networks openamno creates at VIM - # Use netmap-create to force to create an external scenario network - "netmap-create": {"oneOf":[name_schema,{"type": "null"}]}, #datacenter network to use. Null if must be created as an internal net - #netmap-use: Indicates an existing VIM network that must be used for this scenario network. + # Use netmap-create to force to create an external scenario network + "netmap-create": {"oneOf":[name_schema,null_schema]}, #datacenter network to use. Null if must be created as an internal net + #netmap-use: Indicates an existing VIM network that must be used for this scenario network. #Can use both the VIM network name (if it is not ambiguous) or the VIM net UUID #If both 'netmap-create' and 'netmap-use'are supplied, netmap-use precedes, but if fails openmano follows the netmap-create #In oder words, it is the same as 'try to map to the VIM network (netmap-use) if exist, and if not create the network (netmap-create) - "netmap-use": name_schema, # + "netmap-use": name_schema, # "vim-network-name": name_schema, #override network name + "vim-network-id": name_schema, #"ip-profile": ip_profile_schema, - "datacenter": name_schema, + "datacenter": name_schema, } } }, - - - } } }, @@ -1080,23 +1131,40 @@ instance_scenario_create_schema_v01 = { } instance_scenario_action_schema = { - "title":"instance scenario action information schema", + "title": "instance scenario action information schema", "$schema": "http://json-schema.org/draft-04/schema#", - "type":"object", - "properties":{ - "start":{"type": "null"}, - "pause":{"type": "null"}, - "resume":{"type": "null"}, - "shutoff":{"type": "null"}, - "shutdown":{"type": "null"}, - "forceOff":{"type": "null"}, - "rebuild":{"type": "null"}, - "reboot":{ - "type": ["object","null"], + "type": "object", + "properties": { + "start": null_schema, + "pause": null_schema, + "resume": null_schema, + "shutoff": null_schema, + "shutdown": null_schema, + "forceOff": null_schema, + "rebuild": null_schema, + "reboot": { + "type": ["object", "null"], }, + "add_public_key": description_schema, "console": {"type": ["string", "null"], "enum": ["novnc", "xvpvnc", "rdp-html5", "spice-html5", None]}, - "vnfs":{"type": "array", "items":{"type":"string"}}, - "vms":{"type": "array", "items":{"type":"string"}} + "vdu-scaling": { + "type": "array", + "items": { + "type": "object", + "properties": { + "vdu-id": id_schema, + "osm_vdu_id": name_schema, + "member-vnf-index": name_schema, + "count": integer1_schema, + "type": {"enum": ["create", "delete"]} + }, + "additionalProperties": False, + "minProperties": 1, + "required": ["type"] + } + }, + "vnfs": {"type": "array", "items": {"type": "string"}}, + "vms": {"type": "array", "items": {"type": "string"}} }, "minProperties": 1, #"maxProperties": 1, @@ -1160,7 +1228,7 @@ sdn_port_mapping_schema = { "items": { "type": "object", "properties": { - "pci": pci_schema, + "pci": {"OneOf": [null_schema, pci_extended_schema]}, # pci_schema, "switch_port": nameshort_schema, "switch_mac": mac_schema }, @@ -1185,4 +1253,4 @@ sdn_external_port_schema = { "mac": mac_schema }, "required": ["port"] -} \ No newline at end of file +}