X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=openmano_schemas.py;h=e1fc2bd7c253fbeb9ced68363951b4abec8630f7;hb=ed1be4b1591c258748261f21947dc388c28c6fd9;hp=0ac30a72638874ff4999d25d730728f40ca607c7;hpb=f97fd27f5902c7be87d888c095ffb0acc156e126;p=osm%2FRO.git diff --git a/openmano_schemas.py b/openmano_schemas.py index 0ac30a72..e1fc2bd7 100644 --- a/openmano_schemas.py +++ b/openmano_schemas.py @@ -47,11 +47,14 @@ 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]{2}:){5}[0-9a-fA-F]{2}$"} -ip_schema={"type":"string","pattern":"^([0-9]{1,3}.){3}[0-9]{1,3}$"} +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])$"} port_schema={"type":"integer","minimum":1,"maximum":65534} object_schema={"type":"object"} schema_version_2={"type":"integer","minimum":2,"maximum":2} +#schema_version_string={"type":"string","enum": ["0.1", "2", "0.2", "3", "0.3"]} log_level_schema={"type":"string", "enum":["DEBUG", "INFO", "WARNING","ERROR","CRITICAL"]} +checksum_schema={"type":"string", "pattern":"^[0-9a-fA-F]{32}$"} metadata_schema={ "type":"object", @@ -88,6 +91,8 @@ config_schema = { "vim_tenant_name": nameshort_schema, "mano_tenant_name": nameshort_schema, "mano_tenant_id": id_schema, + "http_console_proxy": {"type":"boolean"}, + "http_console_host": nameshort_schema, "http_console_ports": { "type": "array", "items": {"OneOf" : [ @@ -96,11 +101,17 @@ config_schema = { ]} }, "log_level": log_level_schema, + "log_socket_level": log_level_schema, "log_level_db": log_level_schema, - "log_level_vimconn": log_level_schema, + "log_level_vim": log_level_schema, "log_level_nfvo": log_level_schema, - "log_host": nameshort_schema, - "log_port": port_schema, + "log_level_http": log_level_schema, + "log_file_db": path_schema, + "log_file_vim": path_schema, + "log_file_nfvo": path_schema, + "log_file_http": path_schema, + "log_socket_host": nameshort_schema, + "log_socket_port": port_schema, "log_file": path_schema, }, "required": ['db_host', 'db_user', 'db_passwd', 'db_name'], @@ -125,6 +136,7 @@ tenant_schema = { "required": ["tenant"], "additionalProperties": False } + tenant_edit_schema = { "title":"tenant edit information schema", "$schema": "http://json-schema.org/draft-04/schema#", @@ -144,13 +156,13 @@ tenant_edit_schema = { } datacenter_schema_properties={ - "name": name_schema, - "description": description_schema, - "type": nameshort_schema, #currently "openvim" or "openstack", can be enlarge with plugins - "vim_url": description_schema, - "vim_url_admin": description_schema, - "config": { "type":"object" } - } + "name": name_schema, + "description": description_schema, + "type": nameshort_schema, #currently "openvim" or "openstack", can be enlarged with plugins + "vim_url": description_schema, + "vim_url_admin": description_schema, + "config": { "type":"object" } +} datacenter_schema = { "title":"datacenter information schema", @@ -276,6 +288,69 @@ datacenter_associate_schema={ "additionalProperties": False } +dhcp_schema = { + "title":"DHCP schema", + "$schema": "http://json-schema.org/draft-04/schema#", + "type":"object", + "properties":{ + "enabled": {"type": "boolean"}, + "start-address": ip_schema, + "count": integer1_schema + }, + "required": ["enabled", "start-address", "count"], +} + +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"]}, + "subnet-address": ip_prefix_schema, + "gateway-address": ip_schema, + "dns-address": ip_schema, + "dhcp": dhcp_schema + }, +} + +key_pair_schema = { + "title": "Key-pair schema for cloud-init configuration schema", + "$schema": "http://json-schema.org/draft-04/schema#", + "type":"object", + "properties":{ + "name": name_schema, + "key": {"type":"string"} + }, + "required": ["key"], + "additionalProperties": False +} + +cloud_config_user_schema = { + "title": "User schema for cloud-init configuration schema", + "$schema": "http://json-schema.org/draft-04/schema#", + "type":"object", + "properties":{ + "name": nameshort_schema, + "user-info": {"type":"string"}, + #"key-pairs": {"type" : "array", "items": key_pair_schema} + "key-pairs": {"type" : "array", "items": {"type":"string"}} + }, + "required": ["name"], + "additionalProperties": False +} + +cloud_config_schema = { + "title": "Cloud-init configuration schema", + "$schema": "http://json-schema.org/draft-04/schema#", + "type":"object", + "properties":{ + #"key-pairs": {"type" : "array", "items": key_pair_schema}, + "key-pairs": {"type" : "array", "items": {"type":"string"}}, + "users": {"type" : "array", "items": cloud_config_user_schema} + }, + "additionalProperties": False +} + internal_connection_element_schema = { "type":"object", "properties":{ @@ -284,6 +359,15 @@ internal_connection_element_schema = { } } +internal_connection_element_schema_v02 = { + "type":"object", + "properties":{ + "VNFC": name_schema, + "local_iface_name": name_schema, + "ip_address": ip_schema + } +} + internal_connection_schema = { "type":"object", "properties":{ @@ -296,6 +380,20 @@ internal_connection_schema = { "additionalProperties": False } +internal_connection_schema_v02 = { + "type":"object", + "properties":{ + "name": name_schema, + "description":description_schema, + "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} + }, + "required": ["name", "type", "implementation", "elements"], + "additionalProperties": False +} + external_connection_schema = { "type":"object", "properties":{ @@ -309,6 +407,22 @@ external_connection_schema = { "additionalProperties": False } +#Not yet used +external_connection_schema_v02 = { + "type":"object", + "properties":{ + "name": name_schema, + "mgmt": {"type":"boolean"}, + "type": {"type": "string", "enum":["e-line", "e-lan"]}, + "implementation": {"type": "string", "enum":["overlay", "underlay"]}, + "VNFC": name_schema, + "local_iface_name": name_schema , + "description":description_schema + }, + "required": ["name", "type", "VNFC", "local_iface_name"], + "additionalProperties": False +} + interfaces_schema={ "type":"array", "items":{ @@ -348,6 +462,8 @@ devices_schema={ "properties":{ "type":{"type":"string", "enum":["disk","cdrom","xml"] }, "image": path_schema, + "image name": name_schema, + "image checksum": checksum_schema, "image metadata": metadata_schema, "vpci":pci_schema, "xml":xml_text_schema, @@ -380,7 +496,10 @@ vnfc_schema = { "name": name_schema, "description": description_schema, "VNFC image": {"oneOf": [path_schema, http_schema]}, + "image name": name_schema, + "image checksum": checksum_schema, "image metadata": metadata_schema, + #"cloud-config": cloud_config_schema, #common for all vnfs in the scenario "processor": { "type":"object", "properties":{ @@ -402,12 +521,17 @@ vnfc_schema = { "disk": integer1_schema, "numas": { "type": "array", - "items":numa_schema + "items": numa_schema }, "bridge-ifaces": bridge_interfaces_schema, "devices": devices_schema + }, - "required": ["name", "VNFC image"], + "required": ["name"], + "oneOf": [ + {"required": ["VNFC image"]}, + {"required": ["image name"]} + ], "additionalProperties": False } @@ -437,17 +561,26 @@ vnfd_schema_v01 = { "additionalProperties": False } -#Future VNFD schema to be defined +#VNFD schema for OSM R1 vnfd_schema_v02 = { "title":"vnfd information schema v0.2", "$schema": "http://json-schema.org/draft-04/schema#", "type":"object", "properties":{ - "schema_version": schema_version_2, + "schema_version": {"type": "string", "enum": ["0.2"]}, "vnf":{ "type":"object", "properties":{ "name": name_schema, + "description": description_schema, + "class": nameshort_schema, + "public": {"type" : "boolean"}, + "physical": {"type" : "boolean"}, + "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}, + # "cloud-config": cloud_config_schema, #common for all vnfcs + "VNFC":{"type" : "array", "items": vnfc_schema, "minItems":1} }, "required": ["name"], "additionalProperties": True @@ -535,7 +668,6 @@ nsd_schema_v01 = { "additionalProperties": False } -#Future NSD schema to be defined nsd_schema_v02 = { "title":"network scenario descriptor information schema v0.2", "$schema": "http://json-schema.org/draft-04/schema#", @@ -545,7 +677,7 @@ nsd_schema_v02 = { "scenario":{ "type":"object", "properties":{ - "name":name_schema, + "name": name_schema, "description": description_schema, "tenant_id": id_schema, #only valid for admin "public": {"type": "boolean"}, @@ -579,6 +711,100 @@ nsd_schema_v02 = { } }, + }, + "required": ["vnfs", "name"], + "additionalProperties": False + } + }, + "required": ["scenario","schema_version"], + "additionalProperties": False +} + +#NSD schema for OSM R1 +nsd_schema_v03 = { + "title":"network scenario descriptor information schema v0.3", + "$schema": "http://json-schema.org/draft-04/schema#", + "type":"object", + "properties":{ + "schema_version": {"type": "string", "enum": ["0.3"]}, + "scenario":{ + "type":"object", + "properties":{ + "name": name_schema, + "description": description_schema, + "tenant_id": id_schema, #only valid for admin + "public": {"type": "boolean"}, + "cloud-config": cloud_config_schema, #common for all vnfs in the scenario + #"datacenter": name_schema, + "vnfs": { + "type":"object", + "patternProperties":{ + ".": { + "type": "object", + "properties":{ + "vnf_id": id_schema, + "graph": graph_schema, + "vnf_name": name_schema, + #"cloud-config": cloud_config_schema, #particular for a vnf + #"datacenter": name_schema, + "internal-connections": { + "type": "object", + "patternProperties": { + ".": { + "type": "object", + "properties": { + "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"], + } + } + } + } + } + } + }, + } + }, + "minProperties": 1 + }, + "networks": { + "type":"object", + "patternProperties":{ + ".": { + "type": "object", + "properties":{ + "interfaces":{ + "type":"array", + "minLength":1, + "items":{ + "type":"object", + "properties":{ + "vnf": name_schema, + "vnf_interface": name_schema, + "ip_address": ip_schema + }, + "required": ["vnf", "vnf_interface"], + } + }, + "type": {"type": "string", "enum":["e-line", "e-lan"]}, + "implementation": {"type": "string", "enum":["overlay", "underlay"]}, + "external" : {"type": "boolean"}, + "graph": graph_schema, + "ip-profile": ip_profile_schema + }, + "required": ["interfaces"] + }, + } + }, + }, "required": ["vnfs", "networks","name"], "additionalProperties": False @@ -680,7 +906,7 @@ scenario_action_schema = { "additionalProperties": False } -instance_scenario_create_schema = { +instance_scenario_create_schema_v01 = { "title":"instance scenario create information schema v0.1", "$schema": "http://json-schema.org/draft-04/schema#", "type":"object", @@ -694,17 +920,54 @@ instance_scenario_create_schema = { "datacenter": name_schema, "scenario" : name_schema, #can be an UUID or name "action":{"enum": ["deploy","reserve","verify" ]}, - "connect_mgmt_interfaces": {"oneOff": [{"type":"boolean"}, {"type":"object"}]},# can be true or a dict with datacenter: net_name + "connect_mgmt_interfaces": {"oneOf": [{"type":"boolean"}, {"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", "patternProperties":{ ".": { "type": "object", "properties":{ - "name": name_schema,#override vnf name + "name": name_schema, #override vnf name "datacenter": name_schema, - "metadata": {"type": "object"}, - "user_data": {"type": "string"} + #"metadata": {"type": "object"}, + #"user_data": {"type": "string"} + #"cloud-config": cloud_config_schema, #particular for a vnf + "external-connections": { + "type": "object", + "patternProperties": { + ".": { + "type": "object", + "properties": { + "vim-network-name": name_schema, + "ip_address": ip_schema + } + } + } + }, + "internal-connections": { + "type": "object", + "patternProperties": { + ".": { + "type": "object", + "properties": { + "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"], + } + } + } + } + } + } } } }, @@ -715,22 +978,58 @@ instance_scenario_create_schema = { ".": { "type": "object", "properties":{ - "netmap-create": {"oneOf":[name_schema,{"type": "null"}]}, #datacenter network to use. Null if must be created as an internal net - "netmap-use": name_schema, - "name": name_schema,#override network name - "datacenter": name_schema, + "interfaces":{ + "type":"array", + "minLength":1, + "items":{ + "type":"object", + "properties":{ + "ip_address": ip_schema, + "datacenter": name_schema, + "vim-network-name": name_schema + }, + "patternProperties":{ + ".": {"type": "string"} + } + } + }, + "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 + "sites": { + "type":"array", + "minLength":1, + "items":{ + "type":"object", + "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. + #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, # + "vim-network-name": name_schema, #override network name + #"ip-profile": ip_profile_schema, + "datacenter": name_schema, + } + } + }, + + + } } }, }, }, "additionalProperties": False, - "required": ["scenario", "name"] + "required": ["name"] }, }, "required": ["instance"], "additionalProperties": False - } instance_scenario_action_schema = {