X-Git-Url: https://osm.etsi.org/gitweb/?a=blobdiff_plain;f=RO%2Fosm_ro%2Fopenmano_schemas.py;fp=RO%2Fosm_ro%2Fopenmano_schemas.py;h=0000000000000000000000000000000000000000;hb=e4d1a3d01fee5d5e234bd3e2d9b26ec0ae4eef44;hp=14e334d4f4816e626d0d963b18bffb4fd43c78de;hpb=ee6a62063244ab492bc4d09cc5fe89388a5d1ea6;p=osm%2FRO.git diff --git a/RO/osm_ro/openmano_schemas.py b/RO/osm_ro/openmano_schemas.py deleted file mode 100644 index 14e334d4..00000000 --- a/RO/osm_ro/openmano_schemas.py +++ /dev/null @@ -1,1280 +0,0 @@ -# -*- coding: utf-8 -*- - -## -# Copyright 2015 Telefonica Investigacion y Desarrollo, S.A.U. -# This file is part of openmano -# All Rights Reserved. -# -# Licensed under the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. You may obtain -# a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT -# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the -# License for the specific language governing permissions and limitations -# under the License. -# -# For those usages not covered by the Apache License, Version 2.0 please -# contact with: nfvlabs@tid.es -## - -''' -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$" - -#Basis schemas -patern_name="^[ -~]+$" -passwd_schema={"type" : "string", "minLength":1, "maxLength":60} -nameshort_schema={"type" : "string", "minLength":1, "maxLength":60, "pattern" : "^[^,;()'\"]+$"} -name_schema={"type" : "string", "minLength":1, "maxLength":255, "pattern" : "^[^,;()'\"]+$"} -xml_text_schema={"type" : "string", "minLength":1, "maxLength":1000, "pattern" : "^[^']+$"} -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])?$"} -integer0_schema={"type":"integer","minimum":0} -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]{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])$"} -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"]} -string_list = {"type": "array", "items": {"type": "string"}} -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", - "properties":{ - "architecture": {"type":"string"}, - "use_incremental": {"type":"string","enum":["yes","no"]}, - "vpci": pci_schema, - "os_distro": {"type":"string"}, - "os_type": {"type":"string"}, - "os_version": {"type":"string"}, - "bus": {"type":"string"}, - "topology": {"type":"string", "enum": ["oneSocket"]} - } -} - -#Schema for the configuration file -config_schema = { - "title":"configuration response information schema", - "$schema": "http://json-schema.org/draft-04/schema#", - "type":"object", - "properties":{ - "http_port": port_schema, - "http_admin_port": port_schema, - "http_host": nameshort_schema, - "auto_push_VNF_to_VIMs": boolean_schema, - "vnf_repository": path_schema, - "db_host": nameshort_schema, - "db_user": nameshort_schema, - "db_passwd": {"type":"string"}, - "db_name": nameshort_schema, - "db_ovim_host": nameshort_schema, - "db_ovim_user": nameshort_schema, - "db_ovim_passwd": {"type":"string"}, - "db_ovim_name": nameshort_schema, - # Next fields will disappear once the MANO API includes appropriate primitives - "vim_url": http_schema, - "vim_url_admin": http_schema, - "vim_name": nameshort_schema, - "vim_tenant_name": nameshort_schema, - "mano_tenant_name": nameshort_schema, - "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"]} - ]} - }, - "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_level_sdn": log_level_schema, - "log_level_sdnconn": 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, - "log_file_ovim": path_schema, - "log_file_sdn": path_schema, - "log_file_sdnconn": path_schema, - "log_socket_host": nameshort_schema, - "log_socket_port": port_schema, - "log_file": path_schema, - }, - "required": ['db_user', 'db_passwd', 'db_name'], - "additionalProperties": False -} - -tenant_schema = { - "title":"tenant information schema", - "$schema": "http://json-schema.org/draft-04/schema#", - "type":"object", - "properties":{ - "tenant":{ - "type":"object", - "properties":{ - "name": nameshort_schema, - "description": description_schema, - }, - "required": ["name"], - "additionalProperties": True - } - }, - "required": ["tenant"], - "additionalProperties": False -} - -tenant_edit_schema = { - "title":"tenant edit information schema", - "$schema": "http://json-schema.org/draft-04/schema#", - "type":"object", - "properties":{ - "tenant":{ - "type":"object", - "properties":{ - "name": name_schema, - "description": description_schema, - }, - "additionalProperties": False - } - }, - "required": ["tenant"], - "additionalProperties": False -} - -datacenter_schema_properties={ - "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", - "$schema": "http://json-schema.org/draft-04/schema#", - "type":"object", - "properties":{ - "datacenter":{ - "type":"object", - "properties":datacenter_schema_properties, - "required": ["name", "vim_url"], - "additionalProperties": True - } - }, - "required": ["datacenter"], - "additionalProperties": False -} - - -datacenter_edit_schema = { - "title":"datacenter edit nformation schema", - "$schema": "http://json-schema.org/draft-04/schema#", - "type":"object", - "properties":{ - "datacenter":{ - "type":"object", - "properties":datacenter_schema_properties, - "additionalProperties": False - } - }, - "required": ["datacenter"], - "additionalProperties": False -} - - -netmap_new_schema = { - "title":"netmap new information schema", - "$schema": "http://json-schema.org/draft-04/schema#", - "type":"object", - "properties":{ - "netmap":{ #delete from datacenter - "type":"object", - "properties":{ - "name": name_schema, #name or uuid of net to change - "vim_id": id_schema, - "vim_name": name_schema - }, - "minProperties": 1, - "additionalProperties": False - }, - }, - "required": ["netmap"], - "additionalProperties": False -} - -netmap_edit_schema = { - "title":"netmap edit information schema", - "$schema": "http://json-schema.org/draft-04/schema#", - "type":"object", - "properties":{ - "netmap":{ #delete from datacenter - "type":"object", - "properties":{ - "name": name_schema, #name or uuid of net to change - }, - "minProperties": 1, - "additionalProperties": False - }, - }, - "required": ["netmap"], - "additionalProperties": False -} - -datacenter_action_schema = { - "title":"datacenter action information schema", - "$schema": "http://json-schema.org/draft-04/schema#", - "type":"object", - "properties":{ - "check-connectivity": {"type": "null"}, - "net-update": {"type": "null"}, - "net-edit": { - "type":"object", - "properties":{ - "net": name_schema, #name or uuid of net to change - "name": name_schema, - "description": description_schema, - "shared": boolean_schema - }, - "minProperties": 1, - "additionalProperties": False - }, - "net-delete":{ - "type":"object", - "properties":{ - "net": name_schema, #name or uuid of net to change - }, - "required": ["net"], - "additionalProperties": False - }, - }, - "minProperties": 1, - "maxProperties": 1, - "additionalProperties": False -} - - -datacenter_associate_schema={ - "title":"datacenter associate information schema", - "$schema": "http://json-schema.org/draft-04/schema#", - "type":"object", - "properties":{ - "datacenter":{ - "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"], - "additionalProperties": True - } - }, - "required": ["datacenter"], - "additionalProperties": False -} - -dhcp_schema = { - "title": "DHCP schema", - "$schema": "http://json-schema.org/draft-04/schema#", - "type": "object", - "properties":{ - "enabled": boolean_schema, - "start-address": {"oneOf": [null_schema, ip_schema]}, - "count": integer0_schema - }, - # "required": ["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": {"oneOf": [ip_schema, # for backward compatibility - {"type": "array", "items": 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":{ - "VNFC": name_schema, - "local_iface_name": name_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":{ - "name": name_schema, - "description":description_schema, - "type":{"type":"string", "enum":["bridge","data","ptp"]}, - "elements": {"type" : "array", "items": internal_connection_element_schema, "minItems":1} - }, - "required": ["name", "type", "elements"], - "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":1} - }, - "required": ["name", "type", "implementation", "elements"], - "additionalProperties": False -} - -external_connection_schema = { - "type":"object", - "properties":{ - "name": name_schema, - "type":{"type":"string", "enum":["mgmt","bridge","data"]}, - "VNFC": name_schema, - "local_iface_name": name_schema , - "description":description_schema - }, - "required": ["name", "type", "VNFC", "local_iface_name"], - "additionalProperties": False -} - -#Not yet used -external_connection_schema_v02 = { - "type":"object", - "properties":{ - "name": name_schema, - "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 , - "description":description_schema - }, - "required": ["name", "type", "VNFC", "local_iface_name"], - "additionalProperties": False -} - -interfaces_schema={ - "type":"array", - "items":{ - "type":"object", - "properties":{ - "name":name_schema, - "dedicated":{"type":"string","enum":["yes","no","yes:sriov"]}, - "bandwidth":bandwidth_schema, - "vpci":pci_schema, - "mac_address": mac_schema - }, - "additionalProperties": False, - "required": ["name","dedicated", "bandwidth"] - } -} - -bridge_interfaces_schema={ - "type":"array", - "items":{ - "type":"object", - "properties":{ - "name": name_schema, - "bandwidth":bandwidth_schema, - "vpci":pci_schema, - "mac_address": mac_schema, - "model": {"type":"string", "enum":["virtio","e1000","ne2k_pci","pcnet","rtl8139", "paravirt"]}, - "port-security": boolean_schema, - "floating-ip": boolean_schema, - }, - "additionalProperties": False, - "required": ["name"] - } -} - -devices_schema={ - "type":"array", - "items":{ - "type":"object", - "properties":{ - "type":{"type":"string", "enum":["disk","cdrom","xml"] }, - "image": path_schema, - "image name": name_schema, - "image checksum": checksum_schema, - "image metadata": metadata_schema, - "size": size_schema, - "vpci":pci_schema, - "xml":xml_text_schema, - "name": name_schema, - }, - "additionalProperties": False, - "required": ["type"] - } -} - - -numa_schema = { - "type": "object", - "properties": { - "memory":integer1_schema, - "cores":integer1_schema, - "paired-threads":integer1_schema, - "threads":integer1_schema, - "cores-id":{"type":"array","items":integer0_schema}, - "paired-threads-id":{"type":"array","items":{"type":"array","minItems":2,"maxItems":2,"items":integer0_schema}}, - "threads-id":{"type":"array","items":integer0_schema}, - "interfaces":interfaces_schema - }, - "additionalProperties": False, - #"required": ["memory"] -} - -config_files_schema = { - "title": "Config files for cloud init schema", - "$schema": "http://json-schema.org/draft-04/schema#", - "type": "object", - "properties": { - "dest": path_schema, - "encoding": {"type": "string", "enum": ["b64", "base64", "gz", "gz+b64", "gz+base64", "gzip+b64", "gzip+base64"]}, #by default text - "content": {"type": "string"}, - "permissions": {"type": "string"}, # tiypically octal notation '0644' - "owner": {"type": "string"}, # format: owner:group - - }, - "additionalProperties": False, - "required": ["dest", "content"], -} - -boot_data_vdu_schema = { - "title": "Boot data (Cloud-init) configuration schema", - "$schema": "http://json-schema.org/draft-04/schema#", - "type": "object", - "properties":{ - "key-pairs": {"type" : "array", "items": {"type":"string"}}, - "users": {"type" : "array", "items": cloud_config_user_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": boolean_schema, - }, - "additionalProperties": False, -} - -vnfc_schema = { - "type":"object", - "properties":{ - "name": name_schema, - "description": description_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, - #"cloud-config": cloud_config_schema, #common for all vnfs in the scenario - "processor": { - "type":"object", - "properties":{ - "model":description_schema, - "features":{"type":"array","items":nameshort_schema} - }, - "required": ["model"], - "additionalProperties": False - }, - "hypervisor": { - "type":"object", - "properties":{ - "type":nameshort_schema, - "version":description_schema - }, - }, - "ram":integer0_schema, - "vcpus":integer0_schema, - "disk": integer1_schema, - "numas": { - "type": "array", - "items": numa_schema - }, - "bridge-ifaces": bridge_interfaces_schema, - "devices": devices_schema, - "boot-data" : boot_data_vdu_schema - - }, - "required": ["name"], - "oneOf": [ - {"required": ["VNFC image"]}, - {"required": ["image name"]} - ], - "additionalProperties": False -} - -vnfd_schema_v01 = { - "title":"vnfd information schema v0.1", - "$schema": "http://json-schema.org/draft-04/schema#", - "type":"object", - "properties":{ - "vnf":{ - "type":"object", - "properties":{ - "name": name_schema, - "description": description_schema, - - "class": nameshort_schema, - "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}, - "VNFC":{"type" : "array", "items": vnfc_schema, "minItems":1} - }, - "required": ["name","external-connections"], - "additionalProperties": True - } - }, - "required": ["vnf"], - "additionalProperties": False -} - -#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": {"type": "string", "enum": ["0.2"]}, - "vnf":{ - "type":"object", - "properties":{ - "name": name_schema, - "description": description_schema, - "class": nameshort_schema, - "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}, - # "cloud-config": cloud_config_schema, #common for all vnfcs - "VNFC":{"type" : "array", "items": vnfc_schema, "minItems":1} - }, - "required": ["name"], - "additionalProperties": True - } - }, - "required": ["vnf", "schema_version"], - "additionalProperties": False -} - -#vnfd_schema = vnfd_schema_v01 -#{ -# "title":"vnfd information schema v0.2", -# "$schema": "http://json-schema.org/draft-04/schema#", -# "oneOf": [vnfd_schema_v01, vnfd_schema_v02] -#} - -graph_schema = { - "title":"graphical scenario descriptor information schema", - "$schema": "http://json-schema.org/draft-04/schema#", - "type":"object", - "properties":{ - "x": integer0_schema, - "y": integer0_schema, - "ifaces": { - "type":"object", - "properties":{ - "left": {"type":"array"}, - "right": {"type":"array"}, - "bottom": {"type":"array"}, - } - } - }, - "required": ["x","y"] -} - -nsd_schema_v01 = { - "title":"network scenario descriptor information schema v0.1", - "$schema": "http://json-schema.org/draft-04/schema#", - "type":"object", - "properties":{ - "name":name_schema, - "description": description_schema, - "tenant_id": id_schema, #only valid for admin - "public": boolean_schema, - "topology":{ - "type":"object", - "properties":{ - "nodes": { - "type":"object", - "patternProperties":{ - ".": { - "type": "object", - "properties":{ - "type":{"type":"string", "enum":["VNF", "other_network", "network", "external_network"]}, - "vnf_id": id_schema, - "graph": graph_schema, - }, - "patternProperties":{ - "^(VNF )?model$": {"type": "string"} - }, - "required": ["type"] - } - } - }, - "connections": { - "type":"object", - "patternProperties":{ - ".": { - "type": "object", - "properties":{ - "nodes":{"oneOf":[{"type":"object", "minProperties":2}, {"type":"array", "minLength":1}]}, - "type": {"type": "string", "enum":["link", "external_network", "dataplane_net", "bridge_net"]}, - "graph": graph_schema - }, - "required": ["nodes"] - }, - } - } - }, - "required": ["nodes"], - "additionalProperties": False - } - }, - "required": ["name","topology"], - "additionalProperties": False -} - -nsd_schema_v02 = { - "title":"network scenario descriptor information schema v0.2", - "$schema": "http://json-schema.org/draft-04/schema#", - "type":"object", - "properties":{ - "schema_version": schema_version_2, - "scenario":{ - "type":"object", - "properties":{ - "name": name_schema, - "description": description_schema, - "tenant_id": id_schema, #only valid for admin - "public": boolean_schema, - "vnfs": { - "type":"object", - "patternProperties":{ - ".": { - "type": "object", - "properties":{ - "vnf_id": id_schema, - "graph": graph_schema, - "vnf_name": name_schema, - }, - } - }, - "minProperties": 1 - }, - "networks": { - "type":"object", - "patternProperties":{ - ".": { - "type": "object", - "properties":{ - "interfaces":{"type":"array", "minLength":1}, - "type": {"type": "string", "enum":["dataplane", "bridge"]}, - "external" : boolean_schema, - "graph": graph_schema - }, - "required": ["interfaces"] - }, - } - }, - - }, - "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": boolean_schema, - "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" : boolean_schema, - "graph": graph_schema, - "ip-profile": ip_profile_schema - }, - "required": ["interfaces"] - }, - } - }, - - }, - "required": ["vnfs", "networks","name"], - "additionalProperties": False - } - }, - "required": ["scenario","schema_version"], - "additionalProperties": False -} - -#scenario_new_schema = { -# "title":"new scenario information schema", -# "$schema": "http://json-schema.org/draft-04/schema#", -# #"oneOf": [nsd_schema_v01, nsd_schema_v02] -# "oneOf": [nsd_schema_v01] -#} - -scenario_edit_schema = { - "title":"edit scenario information schema", - "$schema": "http://json-schema.org/draft-04/schema#", - "type":"object", - "properties":{ - "name":name_schema, - "description": description_schema, - "topology":{ - "type":"object", - "properties":{ - "nodes": { - "type":"object", - "patternProperties":{ - "^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$": { - "type":"object", - "properties":{ - "graph":{ - "type": "object", - "properties":{ - "x": integer0_schema, - "y": integer0_schema, - "ifaces":{ "type": "object"} - } - }, - "description": description_schema, - "name": name_schema - } - } - } - } - }, - "required": ["nodes"], - "additionalProperties": False - } - }, - "additionalProperties": False -} - -scenario_action_schema = { - "title":"scenario action information schema", - "$schema": "http://json-schema.org/draft-04/schema#", - "type":"object", - "properties":{ - "start":{ - "type": "object", - "properties": { - "instance_name":name_schema, - "description":description_schema, - "datacenter": {"type": "string"} - }, - "required": ["instance_name"] - }, - "deploy":{ - "type": "object", - "properties": { - "instance_name":name_schema, - "description":description_schema, - "datacenter": {"type": "string"} - }, - "required": ["instance_name"] - }, - "reserve":{ - "type": "object", - "properties": { - "instance_name":name_schema, - "description":description_schema, - "datacenter": {"type": "string"} - }, - "required": ["instance_name"] - }, - "verify":{ - "type": "object", - "properties": { - "instance_name":name_schema, - "description":description_schema, - "datacenter": {"type": "string"} - }, - "required": ["instance_name"] - } - }, - "minProperties": 1, - "maxProperties": 1, - "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", - "$schema": "http://json-schema.org/draft-04/schema#", - "type": "object", - "properties": { - "schema_version": {"type": "string", "enum": ["0.1"]}, - "instance": { - "type": "object", - "properties": { - "mgmt_keys": {"type": "array", "items": {"type":"string"}}, - "vduImage": name_schema, - "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": [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", - "patternProperties":{ - ".": { - "type": "object", - "properties":{ - "name": name_schema, #override vnf name - "datacenter": name_schema, - #"metadata": {"type": "object"}, - #"user_data": {"type": "string"} - #"cloud-config": cloud_config_schema, #particular for a vnf - "vdus": { - "type": "object", - "patternProperties": { - ".": { - "type": "object", - "properties": { - "name": name_schema, # overrides vdu name schema - "mgmt_keys": string_list, - "vduImage": name_schema, - "cloud_init": string_list, - "devices": { - "type": "object", - "patternProperties": { - ".": { - "vim_id": name_schema, - } - } - }, - "interfaces": { - "type": "object", - "patternProperties": { - ".": { - "ip_address": ip_schema, - "mac_address": mac_schema, - "floating-ip": boolean_schema, - } - } - } - } - } - } - }, - "networks": { - "type": "object", - "patternProperties": { - ".": { - "type": "object", - "properties": { - "vim-network-name": name_schema, - "vim-network-id": name_schema, - "ip-profile": ip_profile_schema, - "name": name_schema, - } - } - } - }, - } - } - }, - }, - "networks":{ #mapping from scenario to datacenter - "type": "object", - "patternProperties":{ - ".": { - "type": "object", - "properties":{ - "interfaces":{ - "type":"array", - "minLength":1, - "items":{ - "type":"object", - "properties":{ - "ip_address": ip_schema, - "datacenter": 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, - "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, - "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,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, # - "vim-network-name": name_schema, #override network name - "vim-network-id": name_schema, - #"ip-profile": ip_profile_schema, - "datacenter": name_schema, - } - } - }, - } - } - }, - }, - }, - "additionalProperties": False, - "required": ["name"] - }, - }, - "required": ["instance"], - "additionalProperties": False -} - -instance_scenario_action_schema = { - "title": "instance scenario action information schema", - "$schema": "http://json-schema.org/draft-04/schema#", - "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": {"type" : "string"}, - "user": nameshort_schema, - "console": {"type": ["string", "null"], "enum": ["novnc", "xvpvnc", "rdp-html5", "spice-html5", None]}, - "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"]}, - "cloud_init": string_list, - }, - "additionalProperties": False, - "minProperties": 1, - "required": ["type"] - } - }, - "vnfs": {"type": "array", "items": {"type": "string"}}, - "vms": {"type": "array", "items": {"type": "string"}} - }, - "minProperties": 1, - #"maxProperties": 1, - "additionalProperties": False -} - -sdn_controller_properties={ - "name": name_schema, - "dpid": {"type": "string", "pattern": "^[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){7}$"}, - "description": name_schema, - "ip": ip_schema, - "port": port_schema, - "type": nameshort_schema, - "url": name_schema, - "version": {"type": "string", "minLength": 1, "maxLength": 12}, - "user": nameshort_schema, - "password": passwd_schema, - "config": object_schema, -} -sdn_controller_schema = { - "title": "sdn controller information schema", - "$schema": "http://json-schema.org/draft-04/schema#", - "type": "object", - "properties":{ - "sdn_controller":{ - "type": "object", - "properties": sdn_controller_properties, - "required": ["name", 'type'], - "additionalProperties": False - } - }, - "required": ["sdn_controller"], - "additionalProperties": False -} - -sdn_controller_edit_schema = { - "title": "sdn controller update information schema", - "$schema": "http://json-schema.org/draft-04/schema#", - "type": "object", - "properties": { - "sdn_controller": { - "type": "object", - "properties": sdn_controller_properties, - "additionalProperties": False - } - }, - "required": ["sdn_controller"], - "additionalProperties": False -} - -sdn_port_mapping_schema = { - "$schema": "http://json-schema.org/draft-04/schema#", - "title":"sdn port mapping information schema", - "type": "object", - "properties": { - "sdn_port_mapping": { - "type": "array", - "items": { - "type": "object", - "properties": { - "compute_node": nameshort_schema, - "ports": { - "type": "array", - "items": { - "type": "object", - "properties": { - "pci": {"oneOf": [null_schema, pci_extended_schema]}, # pci_schema, - "switch_port": nameshort_schema, - "switch_id": nameshort_schema, - "switch_dpid": nameshort_schema, - "switch_mac": mac_schema - }, - "required": ["pci"] - } - } - }, - "required": ["compute_node", "ports"] - } - } - }, - "required": ["sdn_port_mapping"] -} - -sdn_external_port_schema = { - "$schema": "http://json-schema.org/draft-04/schema#", - "title":"External port ingformation", - "type": "object", - "properties": { - "port": {"type" : "string", "minLength":1, "maxLength":60}, - "vlan": vlan_schema, - "mac": mac_schema - }, - "required": ["port"] -}