openmano_schemas.py

   1 # -*- coding: utf-8 -*-
   2
   3 ##
   4 # Copyright 2015 Telefónica Investigación y Desarrollo, S.A.U.
   5 # This file is part of openmano
   6 # All Rights Reserved.
   7 #
   8 # Licensed under the Apache License, Version 2.0 (the "License"); you may
   9 # not use this file except in compliance with the License. You may obtain
  10 # a copy of the License at
  11 #
  12 #         http://www.apache.org/licenses/LICENSE-2.0
  13 #
  14 # Unless required by applicable law or agreed to in writing, software
  15 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  16 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  17 # License for the specific language governing permissions and limitations
  18 # under the License.
  19 #
  20 # For those usages not covered by the Apache License, Version 2.0 please
  21 # contact with: nfvlabs@tid.es
  22 ##
  23
  24 '''
  25 JSON schemas used by openmano httpserver.py module to parse the different files and messages sent through the API
  26 '''
  27 __author__="Alfonso Tierno, Gerardo Garcia, Pablo Montes"
  28 __date__ ="$09-oct-2014 09:09:48$"
  29
  30 #Basis schemas
  31 patern_name="^[ -~]+$"
  32 passwd_schema={"type" : "string", "minLength":1, "maxLength":60}
  33 nameshort_schema={"type" : "string", "minLength":1, "maxLength":60, "pattern" : "^[^,;()'\"]+$"}
  34 name_schema={"type" : "string", "minLength":1, "maxLength":255, "pattern" : "^[^,;()'\"]+$"}
  35 xml_text_schema={"type" : "string", "minLength":1, "maxLength":1000, "pattern" : "^[^']+$"}
  36 description_schema={"type" : ["string","null"], "maxLength":255, "pattern" : "^[^'\"]+$"}
  37 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}$"
  38 id_schema = {"type" : "string", "pattern": "^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$"}
  39 pci_schema={"type":"string", "pattern":"^[0-9a-fA-F]{4}(:[0-9a-fA-F]{2}){2}\.[0-9a-fA-F]$"}
  40 http_schema={"type":"string", "pattern":"^https?://[^'\"=]+$"}
  41 bandwidth_schema={"type":"string", "pattern" : "^[0-9]+ *([MG]bps)?$"}
  42 memory_schema={"type":"string", "pattern" : "^[0-9]+ *([MG]i?[Bb])?$"}
  43 integer0_schema={"type":"integer","minimum":0}
  44 integer1_schema={"type":"integer","minimum":1}
  45 path_schema={"type":"string", "pattern":"^(\.){0,2}(/[^/\"':{}\(\)]+)+$"}
  46 vlan_schema={"type":"integer","minimum":1,"maximum":4095}
  47 vlan1000_schema={"type":"integer","minimum":1000,"maximum":4095}
  48 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
  49 #mac_schema={"type":"string", "pattern":"^([0-9a-fA-F]{2}:){5}[0-9a-fA-F]{2}$"}
  50 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]?)$"}
  51 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])$"}
  52 port_schema={"type":"integer","minimum":1,"maximum":65534}
  53 object_schema={"type":"object"}
  54 schema_version_2={"type":"integer","minimum":2,"maximum":2}
  55 #schema_version_string={"type":"string","enum": ["0.1", "2", "0.2", "3", "0.3"]}
  56 log_level_schema={"type":"string", "enum":["DEBUG", "INFO", "WARNING","ERROR","CRITICAL"]}
  57 checksum_schema={"type":"string", "pattern":"^[0-9a-fA-F]{32}$"}
  58 size_schema={"type":"integer","minimum":1,"maximum":100}
  59
  60 metadata_schema={
  61     "type":"object",
  62     "properties":{
  63         "architecture": {"type":"string"},
  64         "use_incremental": {"type":"string","enum":["yes","no"]},
  65         "vpci": pci_schema,
  66         "os_distro": {"type":"string"},
  67         "os_type": {"type":"string"},
  68         "os_version": {"type":"string"},
  69         "bus": {"type":"string"},
  70         "topology": {"type":"string", "enum": ["oneSocket"]}
  71     }
  72 }
  73
  74 #Schema for the configuration file
  75 config_schema = {
  76     "title":"configuration response information schema",
  77     "$schema": "http://json-schema.org/draft-04/schema#",
  78     "type":"object",
  79     "properties":{
  80         "http_port": port_schema,
  81         "http_admin_port": port_schema,
  82         "http_host": nameshort_schema,
  83         "vnf_repository": path_schema,
  84         "db_host": nameshort_schema,
  85         "db_user": nameshort_schema,
  86         "db_passwd": {"type":"string"},
  87         "db_name": nameshort_schema,
  88         # Next fields will disappear once the MANO API includes appropriate primitives
  89         "vim_url": http_schema,
  90         "vim_url_admin": http_schema,
  91         "vim_name": nameshort_schema,
  92         "vim_tenant_name": nameshort_schema,
  93         "mano_tenant_name": nameshort_schema,
  94         "mano_tenant_id": id_schema,
  95         "http_console_proxy": {"type":"boolean"},
  96         "http_console_host": nameshort_schema,
  97         "http_console_ports": {
  98             "type": "array",
  99             "items": {"OneOf" : [
 100                 port_schema,
 101                 {"type":"object", "properties":{"from": port_schema, "to": port_schema}, "required": ["from","to"]}
 102             ]}
 103         },
 104         "log_level": log_level_schema,
 105         "log_socket_level": log_level_schema,
 106         "log_level_db": log_level_schema,
 107         "log_level_vim": log_level_schema,
 108         "log_level_nfvo": log_level_schema,
 109         "log_level_http": log_level_schema,
 110         "log_file_db": path_schema,
 111         "log_file_vim": path_schema,
 112         "log_file_nfvo": path_schema,
 113         "log_file_http": path_schema,
 114         "log_socket_host": nameshort_schema,
 115         "log_socket_port": port_schema,
 116         "log_file": path_schema,
 117     },
 118     "required": ['db_host', 'db_user', 'db_passwd', 'db_name'],
 119     "additionalProperties": False
 120 }
 121
 122 tenant_schema = {
 123     "title":"tenant information schema",
 124     "$schema": "http://json-schema.org/draft-04/schema#",
 125     "type":"object",
 126     "properties":{
 127         "tenant":{
 128             "type":"object",
 129             "properties":{
 130                 "name": nameshort_schema,
 131                 "description": description_schema,
 132             },
 133             "required": ["name"],
 134             "additionalProperties": True
 135         }
 136     },
 137     "required": ["tenant"],
 138     "additionalProperties": False
 139 }
 140
 141 tenant_edit_schema = {
 142     "title":"tenant edit information schema",
 143     "$schema": "http://json-schema.org/draft-04/schema#",
 144     "type":"object",
 145     "properties":{
 146         "tenant":{
 147             "type":"object",
 148             "properties":{
 149                 "name": name_schema,
 150                 "description": description_schema,
 151             },
 152             "additionalProperties": False
 153         }
 154     },
 155     "required": ["tenant"],
 156     "additionalProperties": False
 157 }
 158
 159 datacenter_schema_properties={
 160     "name": name_schema,
 161     "description": description_schema,
 162     "type": nameshort_schema, #currently "openvim" or "openstack", can be enlarged with plugins
 163     "vim_url": description_schema,
 164     "vim_url_admin": description_schema,
 165     "config": { "type":"object" }
 166 }
 167
 168 datacenter_schema = {
 169     "title":"datacenter information schema",
 170     "$schema": "http://json-schema.org/draft-04/schema#",
 171     "type":"object",
 172     "properties":{
 173         "datacenter":{
 174             "type":"object",
 175             "properties":datacenter_schema_properties,
 176             "required": ["name", "vim_url"],
 177             "additionalProperties": True
 178         }
 179     },
 180     "required": ["datacenter"],
 181     "additionalProperties": False
 182 }
 183
 184
 185 datacenter_edit_schema = {
 186     "title":"datacenter edit nformation schema",
 187     "$schema": "http://json-schema.org/draft-04/schema#",
 188     "type":"object",
 189     "properties":{
 190         "datacenter":{
 191             "type":"object",
 192             "properties":datacenter_schema_properties,
 193             "additionalProperties": False
 194         }
 195     },
 196     "required": ["datacenter"],
 197     "additionalProperties": False
 198 }
 199
 200
 201 netmap_new_schema = {
 202     "title":"netmap new information schema",
 203     "$schema": "http://json-schema.org/draft-04/schema#",
 204     "type":"object",
 205     "properties":{
 206         "netmap":{   #delete from datacenter
 207             "type":"object",
 208             "properties":{
 209                 "name": name_schema,  #name or uuid of net to change
 210                 "vim_id": id_schema,
 211                 "vim_name": name_schema
 212             },
 213             "minProperties": 1,
 214             "additionalProperties": False
 215         },
 216     },
 217     "required": ["netmap"],
 218     "additionalProperties": False
 219 }
 220
 221 netmap_edit_schema = {
 222     "title":"netmap edit information schema",
 223     "$schema": "http://json-schema.org/draft-04/schema#",
 224     "type":"object",
 225     "properties":{
 226         "netmap":{   #delete from datacenter
 227             "type":"object",
 228             "properties":{
 229                 "name": name_schema,  #name or uuid of net to change
 230             },
 231             "minProperties": 1,
 232             "additionalProperties": False
 233         },
 234     },
 235     "required": ["netmap"],
 236     "additionalProperties": False
 237 }
 238
 239 datacenter_action_schema = {
 240     "title":"datacenter action information schema",
 241     "$schema": "http://json-schema.org/draft-04/schema#",
 242     "type":"object",
 243     "properties":{
 244         "net-update":{"type":"null",},
 245         "net-edit":{
 246             "type":"object",
 247             "properties":{
 248                 "net": name_schema,  #name or uuid of net to change
 249                 "name": name_schema,
 250                 "description": description_schema,
 251                 "shared": {"type": "boolean"}
 252             },
 253             "minProperties": 1,
 254             "additionalProperties": False
 255         },
 256         "net-delete":{
 257             "type":"object",
 258             "properties":{
 259                 "net": name_schema,  #name or uuid of net to change
 260             },
 261             "required": ["net"],
 262             "additionalProperties": False
 263         },
 264     },
 265     "minProperties": 1,
 266     "maxProperties": 1,
 267     "additionalProperties": False
 268 }
 269
 270
 271 datacenter_associate_schema={
 272     "title":"datacenter associate information schema",
 273     "$schema": "http://json-schema.org/draft-04/schema#",
 274     "type":"object",
 275     "properties":{
 276         "datacenter":{
 277             "type":"object",
 278             "properties":{
 279                 "vim_tenant": name_schema,
 280                 "vim_tenant_name": name_schema,
 281                 "vim_username": nameshort_schema,
 282                 "vim_password": nameshort_schema,
 283                 "config": {"type": "object"}
 284             },
 285 #            "required": ["vim_tenant"],
 286             "additionalProperties": True
 287         }
 288     },
 289     "required": ["datacenter"],
 290     "additionalProperties": False
 291 }
 292
 293 dhcp_schema = {
 294     "title":"DHCP schema",
 295     "$schema": "http://json-schema.org/draft-04/schema#",
 296     "type":"object",
 297     "properties":{
 298         "enabled": {"type": "boolean"},
 299         "start-address": ip_schema,
 300         "count": integer1_schema
 301     },
 302     "required": ["enabled", "start-address", "count"],
 303 }
 304
 305 ip_profile_schema = {
 306     "title":"IP profile schema",
 307     "$schema": "http://json-schema.org/draft-04/schema#",
 308     "type":"object",
 309     "properties":{
 310         "ip-version": {"type":"string", "enum":["IPv4","IPv6"]},
 311         "subnet-address": ip_prefix_schema,
 312         "gateway-address": ip_schema,
 313         "dns-address": ip_schema,
 314         "dhcp": dhcp_schema
 315     },
 316 }
 317
 318 key_pair_schema = {
 319     "title": "Key-pair schema for cloud-init configuration schema",
 320     "$schema": "http://json-schema.org/draft-04/schema#",
 321     "type":"object",
 322     "properties":{
 323         "name": name_schema,
 324         "key": {"type":"string"}
 325     },
 326     "required": ["key"],
 327     "additionalProperties": False
 328 }
 329
 330 cloud_config_user_schema = {
 331     "title": "User schema for cloud-init configuration schema",
 332     "$schema": "http://json-schema.org/draft-04/schema#",
 333     "type":"object",
 334     "properties":{
 335         "name": nameshort_schema,
 336         "user-info": {"type":"string"},
 337         #"key-pairs": {"type" : "array", "items": key_pair_schema}
 338         "key-pairs": {"type" : "array", "items": {"type":"string"}}
 339     },
 340     "required": ["name"],
 341     "additionalProperties": False
 342 }
 343
 344 cloud_config_schema = {
 345     "title": "Cloud-init configuration schema",
 346     "$schema": "http://json-schema.org/draft-04/schema#",
 347     "type":"object",
 348     "properties":{
 349         #"key-pairs": {"type" : "array", "items": key_pair_schema},
 350         "key-pairs": {"type" : "array", "items": {"type":"string"}},
 351         "users": {"type" : "array", "items": cloud_config_user_schema}
 352     },
 353     "additionalProperties": False
 354 }
 355
 356 internal_connection_element_schema = {
 357     "type":"object",
 358     "properties":{
 359         "VNFC": name_schema,
 360         "local_iface_name": name_schema
 361     }
 362 }
 363
 364 internal_connection_element_schema_v02 = {
 365     "type":"object",
 366     "properties":{
 367         "VNFC": name_schema,
 368         "local_iface_name": name_schema,
 369         "ip_address": ip_schema
 370     }
 371 }
 372
 373 internal_connection_schema = {
 374     "type":"object",
 375     "properties":{
 376         "name": name_schema,
 377         "description":description_schema,
 378         "type":{"type":"string", "enum":["bridge","data","ptp"]},
 379         "elements": {"type" : "array", "items": internal_connection_element_schema, "minItems":2}
 380     },
 381     "required": ["name", "type", "elements"],
 382     "additionalProperties": False
 383 }
 384
 385 internal_connection_schema_v02 = {
 386     "type":"object",
 387     "properties":{
 388         "name": name_schema,
 389         "description":description_schema,
 390         "type": {"type": "string", "enum":["e-line", "e-lan"]},
 391         "implementation": {"type": "string", "enum":["overlay", "underlay"]},
 392         "ip-profile": ip_profile_schema,
 393         "elements": {"type" : "array", "items": internal_connection_element_schema_v02, "minItems":2}
 394     },
 395     "required": ["name", "type", "implementation", "elements"],
 396     "additionalProperties": False
 397 }
 398
 399 external_connection_schema = {
 400     "type":"object",
 401     "properties":{
 402         "name": name_schema,
 403         "type":{"type":"string", "enum":["mgmt","bridge","data"]},
 404         "VNFC": name_schema,
 405         "local_iface_name": name_schema ,
 406         "description":description_schema
 407     },
 408     "required": ["name", "type", "VNFC", "local_iface_name"],
 409     "additionalProperties": False
 410 }
 411
 412 #Not yet used
 413 external_connection_schema_v02 = {
 414     "type":"object",
 415     "properties":{
 416         "name": name_schema,
 417         "mgmt": {"type":"boolean"},
 418         "type": {"type": "string", "enum":["e-line", "e-lan"]},
 419         "implementation": {"type": "string", "enum":["overlay", "underlay"]},
 420         "VNFC": name_schema,
 421         "local_iface_name": name_schema ,
 422         "description":description_schema
 423     },
 424     "required": ["name", "type", "VNFC", "local_iface_name"],
 425     "additionalProperties": False
 426 }
 427
 428 interfaces_schema={
 429     "type":"array",
 430     "items":{
 431         "type":"object",
 432         "properties":{
 433             "name":name_schema,
 434             "dedicated":{"type":"string","enum":["yes","no","yes:sriov"]},
 435             "bandwidth":bandwidth_schema,
 436             "vpci":pci_schema,
 437             "mac_address": mac_schema
 438         },
 439         "additionalProperties": False,
 440         "required": ["name","dedicated", "bandwidth"]
 441     }
 442 }
 443
 444 bridge_interfaces_schema={
 445     "type":"array",
 446     "items":{
 447         "type":"object",
 448         "properties":{
 449             "name": name_schema,
 450             "bandwidth":bandwidth_schema,
 451             "vpci":pci_schema,
 452             "mac_address": mac_schema,
 453             "model": {"type":"string", "enum":["virtio","e1000","ne2k_pci","pcnet","rtl8139"]},
 454             "port-security": {"type" : "boolean"},
 455             "floating-ip": {"type" : "boolean"}
 456         },
 457         "additionalProperties": False,
 458         "required": ["name"]
 459     }
 460 }
 461
 462 devices_schema={
 463     "type":"array",
 464     "items":{
 465         "type":"object",
 466         "properties":{
 467             "type":{"type":"string", "enum":["disk","cdrom","xml"] },
 468             "image": path_schema,
 469             "image name": name_schema,
 470             "image checksum": checksum_schema,
 471             "image metadata": metadata_schema,
 472             "size": size_schema,
 473             "vpci":pci_schema,
 474             "xml":xml_text_schema,
 475         },
 476         "additionalProperties": False,
 477         "required": ["type"]
 478     }
 479 }
 480
 481
 482 numa_schema = {
 483     "type": "object",
 484     "properties": {
 485         "memory":integer1_schema,
 486         "cores":integer1_schema,
 487         "paired-threads":integer1_schema,
 488         "threads":integer1_schema,
 489         "cores-id":{"type":"array","items":integer0_schema},
 490         "paired-threads-id":{"type":"array","items":{"type":"array","minItems":2,"maxItems":2,"items":integer0_schema}},
 491         "threads-id":{"type":"array","items":integer0_schema},
 492         "interfaces":interfaces_schema
 493     },
 494     "additionalProperties": False,
 495     #"required": ["memory"]
 496 }
 497
 498 vnfc_schema = {
 499     "type":"object",
 500     "properties":{
 501         "name": name_schema,
 502         "description": description_schema,
 503         "VNFC image": {"oneOf": [path_schema, http_schema]},
 504         "image name": name_schema,
 505         "image checksum": checksum_schema,
 506         "image metadata": metadata_schema,
 507         #"cloud-config": cloud_config_schema, #common for all vnfs in the scenario
 508         "processor": {
 509             "type":"object",
 510             "properties":{
 511                 "model":description_schema,
 512                 "features":{"type":"array","items":nameshort_schema}
 513             },
 514             "required": ["model"],
 515             "additionalProperties": False
 516         },
 517         "hypervisor": {
 518             "type":"object",
 519             "properties":{
 520                 "type":nameshort_schema,
 521                 "version":description_schema
 522             },
 523         },
 524         "ram":integer0_schema,
 525         "vcpus":integer0_schema,
 526         "disk": integer1_schema,
 527         "numas": {
 528             "type": "array",
 529             "items": numa_schema
 530         },
 531         "bridge-ifaces": bridge_interfaces_schema,
 532         "devices": devices_schema
 533
 534     },
 535     "required": ["name"],
 536     "oneOf": [
 537         {"required": ["VNFC image"]},
 538         {"required": ["image name"]}
 539     ],
 540     "additionalProperties": False
 541 }
 542
 543 vnfd_schema_v01 = {
 544     "title":"vnfd information schema v0.1",
 545     "$schema": "http://json-schema.org/draft-04/schema#",
 546     "type":"object",
 547     "properties":{
 548         "vnf":{
 549             "type":"object",
 550             "properties":{
 551                 "name": name_schema,
 552                 "description": description_schema,
 553                 "class": nameshort_schema,
 554                 "public": {"type" : "boolean"},
 555                 "physical": {"type" : "boolean"},
 556                 "tenant_id": id_schema, #only valid for admin
 557                 "external-connections": {"type" : "array", "items": external_connection_schema, "minItems":1},
 558                 "internal-connections": {"type" : "array", "items": internal_connection_schema, "minItems":1},
 559                 "VNFC":{"type" : "array", "items": vnfc_schema, "minItems":1}
 560             },
 561             "required": ["name","external-connections"],
 562             "additionalProperties": True
 563         }
 564     },
 565     "required": ["vnf"],
 566     "additionalProperties": False
 567 }
 568
 569 #VNFD schema for OSM R1
 570 vnfd_schema_v02 = {
 571     "title":"vnfd information schema v0.2",
 572     "$schema": "http://json-schema.org/draft-04/schema#",
 573     "type":"object",
 574     "properties":{
 575         "schema_version": {"type": "string", "enum": ["0.2"]},
 576         "vnf":{
 577             "type":"object",
 578             "properties":{
 579                 "name": name_schema,
 580                 "description": description_schema,
 581                 "class": nameshort_schema,
 582                 "public": {"type" : "boolean"},
 583                 "physical": {"type" : "boolean"},
 584                 "tenant_id": id_schema, #only valid for admin
 585                 "external-connections": {"type" : "array", "items": external_connection_schema, "minItems":1},
 586                 "internal-connections": {"type" : "array", "items": internal_connection_schema_v02, "minItems":1},
 587                 # "cloud-config": cloud_config_schema, #common for all vnfcs
 588                 "VNFC":{"type" : "array", "items": vnfc_schema, "minItems":1}
 589             },
 590             "required": ["name"],
 591             "additionalProperties": True
 592         }
 593     },
 594     "required": ["vnf", "schema_version"],
 595     "additionalProperties": False
 596 }
 597
 598 #vnfd_schema = vnfd_schema_v01
 599 #{
 600 #    "title":"vnfd information schema v0.2",
 601 #    "$schema": "http://json-schema.org/draft-04/schema#",
 602 #    "oneOf": [vnfd_schema_v01, vnfd_schema_v02]
 603 #}
 604
 605 graph_schema = {
 606     "title":"graphical scenario descriptor information schema",
 607     "$schema": "http://json-schema.org/draft-04/schema#",
 608     "type":"object",
 609     "properties":{
 610         "x":      integer0_schema,
 611         "y":      integer0_schema,
 612         "ifaces": {
 613             "type":"object",
 614             "properties":{
 615                 "left": {"type":"array"},
 616                 "right": {"type":"array"},
 617                 "bottom": {"type":"array"},
 618             }
 619         }
 620     },
 621     "required": ["x","y"]
 622 }
 623
 624 nsd_schema_v01 = {
 625     "title":"network scenario descriptor information schema v0.1",
 626     "$schema": "http://json-schema.org/draft-04/schema#",
 627     "type":"object",
 628     "properties":{
 629         "name":name_schema,
 630         "description": description_schema,
 631         "tenant_id": id_schema, #only valid for admin
 632         "public": {"type": "boolean"},
 633         "topology":{
 634             "type":"object",
 635             "properties":{
 636                 "nodes": {
 637                     "type":"object",
 638                     "patternProperties":{
 639                         ".": {
 640                             "type": "object",
 641                             "properties":{
 642                                 "type":{"type":"string", "enum":["VNF", "other_network", "network", "external_network"]},
 643                                 "vnf_id": id_schema,
 644                                 "graph": graph_schema,
 645                             },
 646                             "patternProperties":{
 647                                 "^(VNF )?model$": {"type": "string"}
 648                             },
 649                             "required": ["type"]
 650                         }
 651                     }
 652                 },
 653                 "connections": {
 654                     "type":"object",
 655                     "patternProperties":{
 656                         ".": {
 657                             "type": "object",
 658                             "properties":{
 659                                 "nodes":{"oneOf":[{"type":"object", "minProperties":2}, {"type":"array", "minLength":1}]},
 660                                 "type": {"type": "string", "enum":["link", "external_network", "dataplane_net", "bridge_net"]},
 661                                 "graph": graph_schema
 662                             },
 663                             "required": ["nodes"]
 664                         },
 665                     }
 666                 }
 667             },
 668             "required": ["nodes"],
 669             "additionalProperties": False
 670         }
 671     },
 672     "required": ["name","topology"],
 673     "additionalProperties": False
 674 }
 675
 676 nsd_schema_v02 = {
 677     "title":"network scenario descriptor information schema v0.2",
 678     "$schema": "http://json-schema.org/draft-04/schema#",
 679     "type":"object",
 680     "properties":{
 681         "schema_version": schema_version_2,
 682         "scenario":{
 683             "type":"object",
 684             "properties":{
 685                 "name": name_schema,
 686                 "description": description_schema,
 687                 "tenant_id": id_schema, #only valid for admin
 688                 "public": {"type": "boolean"},
 689                 "vnfs": {
 690                     "type":"object",
 691                     "patternProperties":{
 692                         ".": {
 693                             "type": "object",
 694                             "properties":{
 695                                 "vnf_id": id_schema,
 696                                 "graph": graph_schema,
 697                                 "vnf_name": name_schema,
 698                             },
 699                         }
 700                     },
 701                     "minProperties": 1
 702                 },
 703                 "networks": {
 704                     "type":"object",
 705                     "patternProperties":{
 706                         ".": {
 707                             "type": "object",
 708                             "properties":{
 709                                 "interfaces":{"type":"array", "minLength":1},
 710                                 "type": {"type": "string", "enum":["dataplane", "bridge"]},
 711                                 "external" : {"type": "boolean"},
 712                                 "graph": graph_schema
 713                             },
 714                             "required": ["interfaces"]
 715                         },
 716                     }
 717                 },
 718
 719             },
 720             "required": ["vnfs", "name"],
 721             "additionalProperties": False
 722         }
 723     },
 724     "required": ["scenario","schema_version"],
 725     "additionalProperties": False
 726 }
 727
 728 #NSD schema for OSM R1
 729 nsd_schema_v03 = {
 730     "title":"network scenario descriptor information schema v0.3",
 731     "$schema": "http://json-schema.org/draft-04/schema#",
 732     "type":"object",
 733     "properties":{
 734         "schema_version": {"type": "string", "enum": ["0.3"]},
 735         "scenario":{
 736             "type":"object",
 737             "properties":{
 738                 "name": name_schema,
 739                 "description": description_schema,
 740                 "tenant_id": id_schema, #only valid for admin
 741                 "public": {"type": "boolean"},
 742                 "cloud-config": cloud_config_schema, #common for all vnfs in the scenario
 743                 #"datacenter": name_schema,
 744                 "vnfs": {
 745                     "type":"object",
 746                     "patternProperties":{
 747                         ".": {
 748                             "type": "object",
 749                             "properties":{
 750                                 "vnf_id": id_schema,
 751                                 "graph": graph_schema,
 752                                 "vnf_name": name_schema,
 753                                 #"cloud-config": cloud_config_schema, #particular for a vnf
 754                                 #"datacenter": name_schema,
 755                                 "internal-connections": {
 756                                     "type": "object",
 757                                     "patternProperties": {
 758                                         ".": {
 759                                             "type": "object",
 760                                             "properties": {
 761                                                 "ip-profile": ip_profile_schema,
 762                                                 "elements": {
 763                                                     "type" : "array",
 764                                                     "items":{
 765                                                         "type":"object",
 766                                                         "properties":{
 767                                                             "VNFC": name_schema,
 768                                                             "local_iface_name": name_schema,
 769                                                             "ip_address": ip_schema
 770                                                         },
 771                                                         "required": ["VNFC", "local_iface_name"],
 772                                                     }
 773                                                 }
 774                                             }
 775                                         }
 776                                     }
 777                                 }
 778                             },
 779                         }
 780                     },
 781                     "minProperties": 1
 782                 },
 783                 "networks": {
 784                     "type":"object",
 785                     "patternProperties":{
 786                         ".": {
 787                             "type": "object",
 788                             "properties":{
 789                                 "interfaces":{
 790                                     "type":"array",
 791                                     "minLength":1,
 792                                     "items":{
 793                                         "type":"object",
 794                                         "properties":{
 795                                             "vnf": name_schema,
 796                                             "vnf_interface": name_schema,
 797                                             "ip_address": ip_schema
 798                                         },
 799                                         "required": ["vnf", "vnf_interface"],
 800                                     }
 801                                 },
 802                                 "type": {"type": "string", "enum":["e-line", "e-lan"]},
 803                                 "implementation": {"type": "string", "enum":["overlay", "underlay"]},
 804                                 "external" : {"type": "boolean"},
 805                                 "graph": graph_schema,
 806                                 "ip-profile": ip_profile_schema
 807                             },
 808                             "required": ["interfaces"]
 809                         },
 810                     }
 811                 },
 812
 813             },
 814             "required": ["vnfs", "networks","name"],
 815             "additionalProperties": False
 816         }
 817     },
 818     "required": ["scenario","schema_version"],
 819     "additionalProperties": False
 820 }
 821
 822 #scenario_new_schema = {
 823 #    "title":"new scenario information schema",
 824 #    "$schema": "http://json-schema.org/draft-04/schema#",
 825 #    #"oneOf": [nsd_schema_v01, nsd_schema_v02]
 826 #    "oneOf": [nsd_schema_v01]
 827 #}
 828
 829 scenario_edit_schema = {
 830     "title":"edit scenario information schema",
 831     "$schema": "http://json-schema.org/draft-04/schema#",
 832     "type":"object",
 833     "properties":{
 834         "name":name_schema,
 835         "description": description_schema,
 836         "topology":{
 837             "type":"object",
 838             "properties":{
 839                 "nodes": {
 840                     "type":"object",
 841                     "patternProperties":{
 842                         "^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$": {
 843                             "type":"object",
 844                             "properties":{
 845                                 "graph":{
 846                                     "type": "object",
 847                                     "properties":{
 848                                         "x": integer0_schema,
 849                                         "y": integer0_schema,
 850                                         "ifaces":{ "type": "object"}
 851                                     }
 852                                 },
 853                                 "description": description_schema,
 854                                 "name": name_schema
 855                             }
 856                         }
 857                     }
 858                 }
 859             },
 860             "required": ["nodes"],
 861             "additionalProperties": False
 862         }
 863     },
 864     "additionalProperties": False
 865 }
 866
 867 scenario_action_schema = {
 868     "title":"scenario action information schema",
 869     "$schema": "http://json-schema.org/draft-04/schema#",
 870     "type":"object",
 871     "properties":{
 872         "start":{
 873             "type": "object",
 874             "properties": {
 875                 "instance_name":name_schema,
 876                 "description":description_schema,
 877                 "datacenter": {"type": "string"}
 878             },
 879             "required": ["instance_name"]
 880         },
 881         "deploy":{
 882             "type": "object",
 883             "properties": {
 884                 "instance_name":name_schema,
 885                 "description":description_schema,
 886                 "datacenter": {"type": "string"}
 887             },
 888             "required": ["instance_name"]
 889         },
 890         "reserve":{
 891             "type": "object",
 892             "properties": {
 893                 "instance_name":name_schema,
 894                 "description":description_schema,
 895                 "datacenter": {"type": "string"}
 896             },
 897             "required": ["instance_name"]
 898         },
 899         "verify":{
 900             "type": "object",
 901             "properties": {
 902                 "instance_name":name_schema,
 903                 "description":description_schema,
 904                 "datacenter": {"type": "string"}
 905             },
 906             "required": ["instance_name"]
 907         }
 908     },
 909     "minProperties": 1,
 910     "maxProperties": 1,
 911     "additionalProperties": False
 912 }
 913
 914 instance_scenario_create_schema_v01 = {
 915     "title":"instance scenario create information schema v0.1",
 916     "$schema": "http://json-schema.org/draft-04/schema#",
 917     "type":"object",
 918     "properties":{
 919         "schema_version": {"type": "string", "enum": ["0.1"]},
 920         "instance":{
 921             "type":"object",
 922             "properties":{
 923                 "name":name_schema,
 924                 "description":description_schema,
 925                 "datacenter": name_schema,
 926                 "scenario" : name_schema, #can be an UUID or name
 927                 "action":{"enum": ["deploy","reserve","verify" ]},
 928                 "connect_mgmt_interfaces": {"oneOf": [{"type":"boolean"}, {"type":"object"}]},# can be true or a dict with datacenter: net_name
 929                 "cloud-config": cloud_config_schema, #common to all vnfs in the instance scenario
 930                 "vnfs":{             #mapping from scenario to datacenter
 931                     "type": "object",
 932                     "patternProperties":{
 933                         ".": {
 934                             "type": "object",
 935                             "properties":{
 936                                 "name": name_schema, #override vnf name
 937                                 "datacenter": name_schema,
 938                                 #"metadata": {"type": "object"},
 939                                 #"user_data": {"type": "string"}
 940                                 #"cloud-config": cloud_config_schema, #particular for a vnf
 941                                 "external-connections": {
 942                                     "type": "object",
 943                                     "patternProperties": {
 944                                         ".": {
 945                                             "type": "object",
 946                                             "properties": {
 947                                                 "vim-network-name": name_schema,
 948                                                 "ip_address": ip_schema
 949                                             }
 950                                         }
 951                                     }
 952                                 },
 953                                 "internal-connections": {
 954                                     "type": "object",
 955                                     "patternProperties": {
 956                                         ".": {
 957                                             "type": "object",
 958                                             "properties": {
 959                                                 "ip-profile": ip_profile_schema,
 960                                                 "elements": {
 961                                                     "type" : "array",
 962                                                     "items":{
 963                                                         "type":"object",
 964                                                         "properties":{
 965                                                             "VNFC": name_schema,
 966                                                             "local_iface_name": name_schema,
 967                                                             "ip_address": ip_schema
 968                                                         },
 969                                                         "required": ["VNFC", "local_iface_name"],
 970                                                     }
 971                                                 }
 972                                             }
 973                                         }
 974                                     }
 975                                 }
 976                             }
 977                         }
 978                     },
 979                 },
 980                 "networks":{             #mapping from scenario to datacenter
 981                     "type": "object",
 982                     "patternProperties":{
 983                         ".": {
 984                             "type": "object",
 985                             "properties":{
 986                                 "interfaces":{
 987                                     "type":"array",
 988                                     "minLength":1,
 989                                     "items":{
 990                                         "type":"object",
 991                                         "properties":{
 992                                             "ip_address": ip_schema,
 993                                             "datacenter": name_schema,
 994                                             "vim-network-name": name_schema
 995                                         },
 996                                         "patternProperties":{
 997                                             ".": {"type": "string"}
 998                                         }
 999                                     }
1000                                 },
1001                                 "ip-profile": ip_profile_schema,
1002                                 #if the network connects VNFs deployed at different sites, you must specify one entry per site that this network connect to
1003                                 "sites": {
1004                                     "type":"array",
1005                                     "minLength":1,
1006                                     "items":{
1007                                         "type":"object",
1008                                         "properties":{
1009                                             # By default for an scenario 'external' network openmano looks for an existing VIM network to map this external scenario network,
1010                                             # for other networks openamno creates at VIM
1011                                             # Use netmap-create to force to create an external scenario network
1012                                             "netmap-create": {"oneOf":[name_schema,{"type": "null"}]}, #datacenter network to use. Null if must be created as an internal net
1013                                             #netmap-use:   Indicates an existing VIM network that must be used for this scenario network.
1014                                             #Can use both the VIM network name (if it is not ambiguous) or the VIM net UUID
1015                                             #If both 'netmap-create' and 'netmap-use'are supplied, netmap-use precedes, but if fails openmano follows the netmap-create
1016                                             #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)
1017                                             "netmap-use": name_schema, #
1018                                             "vim-network-name": name_schema, #override network name
1019                                             #"ip-profile": ip_profile_schema,
1020                                             "datacenter": name_schema,
1021                                         }
1022                                     }
1023                                 },
1024
1025
1026
1027                             }
1028                         }
1029                     },
1030                 },
1031             },
1032             "additionalProperties": False,
1033             "required": ["name"]
1034         },
1035     },
1036     "required": ["instance"],
1037     "additionalProperties": False
1038 }
1039
1040 instance_scenario_action_schema = {
1041     "title":"instance scenario action information schema",
1042     "$schema": "http://json-schema.org/draft-04/schema#",
1043     "type":"object",
1044     "properties":{
1045         "start":{"type": "null"},
1046         "pause":{"type": "null"},
1047         "resume":{"type": "null"},
1048         "shutoff":{"type": "null"},
1049         "shutdown":{"type": "null"},
1050         "forceOff":{"type": "null"},
1051         "rebuild":{"type": "null"},
1052         "reboot":{
1053             "type": ["object","null"],
1054         },
1055         "console": {"type": ["string", "null"], "enum": ["novnc", "xvpvnc", "rdp-html5", "spice-html5", None]},
1056         "vnfs":{"type": "array", "items":{"type":"string"}},
1057         "vms":{"type": "array", "items":{"type":"string"}}
1058     },
1059     "minProperties": 1,
1060     #"maxProperties": 1,
1061     "additionalProperties": False
1062 }