X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=osm_ro%2Fopenmano_schemas.py;h=988b6ca0469f04666b319edded7c1bdcd071528b;hb=1d55a23c9cd32f17bb7a6f21e5b6c2b476c5804f;hp=4a7d5f597c538fe88ed6bd946e982b9792254b63;hpb=7fe82640f590cc66a9b11adf0d25abceedf892de;p=osm%2FRO.git diff --git a/osm_ro/openmano_schemas.py b/osm_ro/openmano_schemas.py index 4a7d5f59..988b6ca0 100644 --- a/osm_ro/openmano_schemas.py +++ b/osm_ro/openmano_schemas.py @@ -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$" @@ -48,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])$"} @@ -59,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", @@ -83,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, @@ -99,13 +101,13 @@ 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", + "type": "array", "items": {"OneOf": [ - port_schema, + port_schema, {"type": "object", "properties": {"from": port_schema, "to": port_schema}, "required": ["from", "to"]} ]} }, @@ -113,12 +115,14 @@ config_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, @@ -260,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 @@ -309,8 +313,8 @@ dhcp_schema = { "$schema": "http://json-schema.org/draft-04/schema#", "type": "object", "properties":{ - "enabled": {"type": "boolean"}, - "start-address": {"OneOf": [{"type": "null"}, ip_schema]}, + "enabled": boolean_schema, + "start-address": {"OneOf": [null_schema, ip_schema]}, "count": integer0_schema }, # "required": ["start-address", "count"], @@ -429,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 , @@ -466,8 +470,8 @@ bridge_interfaces_schema={ "vpci":pci_schema, "mac_address": mac_schema, "model": {"type":"string", "enum":["virtio","e1000","ne2k_pci","pcnet","rtl8139", "paravirt"]}, - "port-security": {"type" : "boolean"}, - "floating-ip": {"type" : "boolean"} + "port-security": boolean_schema, + "floating-ip": boolean_schema, }, "additionalProperties": False, "required": ["name"] @@ -537,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, } @@ -580,7 +584,7 @@ vnfc_schema = { "bridge-ifaces": bridge_interfaces_schema, "devices": devices_schema, "boot-data" : boot_data_vdu_schema - + }, "required": ["name"], "oneOf": [ @@ -602,8 +606,8 @@ vnfd_schema_v01 = { "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}, @@ -631,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}, @@ -681,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":{ @@ -737,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":{ @@ -760,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 @@ -790,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": { @@ -853,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 }, @@ -861,7 +865,7 @@ nsd_schema_v03 = { }, } }, - + }, "required": ["vnfs", "networks","name"], "additionalProperties": False @@ -975,7 +979,7 @@ instance_scenario_object = { "type": "object", "properties": { "name": name_schema, - "external": {"type": "boolean"}, + "external": boolean_schema, "type": {"enum": ["bridge", "ptp", "data"]}, # for overlay, underlay E-LINE, underlay E-LAN }, "additionalProperties": False, @@ -1001,9 +1005,10 @@ instance_scenario_create_schema_v01 = { "name": name_schema, "description":description_schema, "datacenter": name_schema, + "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", @@ -1039,7 +1044,7 @@ instance_scenario_create_schema_v01 = { ".": { "ip_address": ip_schema, "mac_address": mac_schema, - "floating-ip": {"type": "boolean"}, + "floating-ip": boolean_schema, } } } @@ -1054,9 +1059,10 @@ instance_scenario_create_schema_v01 = { "type": "object", "properties": { "vim-network-name": name_schema, + "vim-network-id": name_schema, "ip-profile": ip_profile_schema, "name": name_schema, - } + } } } }, @@ -1078,15 +1084,27 @@ 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 + "use-network": { + "type": "object", + "properties": { + "instance_scenario_id": id_schema, + # "member_vnf_index": name_schema, # if not null, network inside VNF + "osm_id": name_schema, # sce_network osm_id or name + }, + "additionalProperties": False, + "required": ["instance_scenario_id", "osm_id"] + }, + #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, @@ -1095,16 +1113,17 @@ 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, } } }, @@ -1126,13 +1145,13 @@ instance_scenario_action_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"}, + "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"], }, @@ -1219,7 +1238,7 @@ sdn_port_mapping_schema = { "items": { "type": "object", "properties": { - "pci": pci_extended_schema, # pci_schema, + "pci": {"OneOf": [null_schema, pci_extended_schema]}, # pci_schema, "switch_port": nameshort_schema, "switch_mac": mac_schema },