osm_ro/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         "auto_push_VNF_to_VIMs": {"type":"boolean"},
  84         "vnf_repository": path_schema,
  85         "db_host": nameshort_schema,
  86         "db_user": nameshort_schema,
  87         "db_passwd": {"type":"string"},
  88         "db_name": nameshort_schema,
  89         "db_ovim_host": nameshort_schema,
  90         "db_ovim_user": nameshort_schema,
  91         "db_ovim_passwd": {"type":"string"},
  92         "db_ovim_name": nameshort_schema,
  93         # Next fields will disappear once the MANO API includes appropriate primitives
  94         "vim_url": http_schema,
  95         "vim_url_admin": http_schema,
  96         "vim_name": nameshort_schema,
  97         "vim_tenant_name": nameshort_schema,
  98         "mano_tenant_name": nameshort_schema,
  99         "mano_tenant_id": id_schema,
 100         "http_console_proxy": {"type":"boolean"},
 101         "http_console_host": nameshort_schema,
 102         "http_console_ports": {
 103             "type": "array",
 104             "items": {"OneOf" : [
 105                 port_schema,
 106                 {"type":"object", "properties":{"from": port_schema, "to": port_schema}, "required": ["from","to"]}
 107             ]}
 108         },
 109         "log_level": log_level_schema,
 110         "log_socket_level": log_level_schema,
 111         "log_level_db": log_level_schema,
 112         "log_level_vim": log_level_schema,
 113         "log_level_nfvo": log_level_schema,
 114         "log_level_http": log_level_schema,
 115         "log_level_console": log_level_schema,
 116         "log_level_ovim": log_level_schema,
 117         "log_file_db": path_schema,
 118         "log_file_vim": path_schema,
 119         "log_file_nfvo": path_schema,
 120         "log_file_http": path_schema,
 121         "log_file_console": path_schema,
 122         "log_file_ovim": path_schema,
 123         "log_socket_host": nameshort_schema,
 124         "log_socket_port": port_schema,
 125         "log_file": path_schema,
 126     },
 127     "required": ['db_user', 'db_passwd', 'db_name'],
 128     "additionalProperties": False
 129 }
 130
 131 tenant_schema = {
 132     "title":"tenant information schema",
 133     "$schema": "http://json-schema.org/draft-04/schema#",
 134     "type":"object",
 135     "properties":{
 136         "tenant":{
 137             "type":"object",
 138             "properties":{
 139                 "name": nameshort_schema,
 140                 "description": description_schema,
 141             },
 142             "required": ["name"],
 143             "additionalProperties": True
 144         }
 145     },
 146     "required": ["tenant"],
 147     "additionalProperties": False
 148 }
 149
 150 tenant_edit_schema = {
 151     "title":"tenant edit information schema",
 152     "$schema": "http://json-schema.org/draft-04/schema#",
 153     "type":"object",
 154     "properties":{
 155         "tenant":{
 156             "type":"object",
 157             "properties":{
 158                 "name": name_schema,
 159                 "description": description_schema,
 160             },
 161             "additionalProperties": False
 162         }
 163     },
 164     "required": ["tenant"],
 165     "additionalProperties": False
 166 }
 167
 168 datacenter_schema_properties={
 169     "name": name_schema,
 170     "description": description_schema,
 171     "type": nameshort_schema, #currently "openvim" or "openstack", can be enlarged with plugins
 172     "vim_url": description_schema,
 173     "vim_url_admin": description_schema,
 174     "config": { "type":"object" }
 175 }
 176
 177 datacenter_schema = {
 178     "title":"datacenter information schema",
 179     "$schema": "http://json-schema.org/draft-04/schema#",
 180     "type":"object",
 181     "properties":{
 182         "datacenter":{
 183             "type":"object",
 184             "properties":datacenter_schema_properties,
 185             "required": ["name", "vim_url"],
 186             "additionalProperties": True
 187         }
 188     },
 189     "required": ["datacenter"],
 190     "additionalProperties": False
 191 }
 192
 193
 194 datacenter_edit_schema = {
 195     "title":"datacenter edit nformation schema",
 196     "$schema": "http://json-schema.org/draft-04/schema#",
 197     "type":"object",
 198     "properties":{
 199         "datacenter":{
 200             "type":"object",
 201             "properties":datacenter_schema_properties,
 202             "additionalProperties": False
 203         }
 204     },
 205     "required": ["datacenter"],
 206     "additionalProperties": False
 207 }
 208
 209
 210 netmap_new_schema = {
 211     "title":"netmap new information schema",
 212     "$schema": "http://json-schema.org/draft-04/schema#",
 213     "type":"object",
 214     "properties":{
 215         "netmap":{   #delete from datacenter
 216             "type":"object",
 217             "properties":{
 218                 "name": name_schema,  #name or uuid of net to change
 219                 "vim_id": id_schema,
 220                 "vim_name": name_schema
 221             },
 222             "minProperties": 1,
 223             "additionalProperties": False
 224         },
 225     },
 226     "required": ["netmap"],
 227     "additionalProperties": False
 228 }
 229
 230 netmap_edit_schema = {
 231     "title":"netmap edit information schema",
 232     "$schema": "http://json-schema.org/draft-04/schema#",
 233     "type":"object",
 234     "properties":{
 235         "netmap":{   #delete from datacenter
 236             "type":"object",
 237             "properties":{
 238                 "name": name_schema,  #name or uuid of net to change
 239             },
 240             "minProperties": 1,
 241             "additionalProperties": False
 242         },
 243     },
 244     "required": ["netmap"],
 245     "additionalProperties": False
 246 }
 247
 248 datacenter_action_schema = {
 249     "title":"datacenter action information schema",
 250     "$schema": "http://json-schema.org/draft-04/schema#",
 251     "type":"object",
 252     "properties":{
 253         "net-update":{"type":"null",},
 254         "net-edit":{
 255             "type":"object",
 256             "properties":{
 257                 "net": name_schema,  #name or uuid of net to change
 258                 "name": name_schema,
 259                 "description": description_schema,
 260                 "shared": {"type": "boolean"}
 261             },
 262             "minProperties": 1,
 263             "additionalProperties": False
 264         },
 265         "net-delete":{
 266             "type":"object",
 267             "properties":{
 268                 "net": name_schema,  #name or uuid of net to change
 269             },
 270             "required": ["net"],
 271             "additionalProperties": False
 272         },
 273     },
 274     "minProperties": 1,
 275     "maxProperties": 1,
 276     "additionalProperties": False
 277 }
 278
 279
 280 datacenter_associate_schema={
 281     "title":"datacenter associate information schema",
 282     "$schema": "http://json-schema.org/draft-04/schema#",
 283     "type":"object",
 284     "properties":{
 285         "datacenter":{
 286             "type":"object",
 287             "properties":{
 288                 "vim_tenant": name_schema,
 289                 "vim_tenant_name": name_schema,
 290                 "vim_username": nameshort_schema,
 291                 "vim_password": nameshort_schema,
 292                 "config": {"type": "object"}
 293             },
 294 #            "required": ["vim_tenant"],
 295             "additionalProperties": True
 296         }
 297     },
 298     "required": ["datacenter"],
 299     "additionalProperties": False
 300 }
 301
 302 dhcp_schema = {
 303     "title":"DHCP schema",
 304     "$schema": "http://json-schema.org/draft-04/schema#",
 305     "type":"object",
 306     "properties":{
 307         "enabled": {"type": "boolean"},
 308         "start-address": ip_schema,
 309         "count": integer1_schema
 310     },
 311     "required": ["enabled", "start-address", "count"],
 312 }
 313
 314 ip_profile_schema = {
 315     "title":"IP profile schema",
 316     "$schema": "http://json-schema.org/draft-04/schema#",
 317     "type":"object",
 318     "properties":{
 319         "ip-version": {"type": "string", "enum": ["IPv4","IPv6"]},
 320         "subnet-address": ip_prefix_schema,
 321         "gateway-address": ip_schema,
 322         "dns-address": {"oneOf": [ip_schema,     # for backward compatibility
 323                                   {"type": "array", "items": ip_schema}]},
 324         "dhcp": dhcp_schema
 325     },
 326 }
 327
 328 key_pair_schema = {
 329     "title": "Key-pair schema for cloud-init configuration schema",
 330     "$schema": "http://json-schema.org/draft-04/schema#",
 331     "type":"object",
 332     "properties":{
 333         "name": name_schema,
 334         "key": {"type":"string"}
 335     },
 336     "required": ["key"],
 337     "additionalProperties": False
 338 }
 339
 340 cloud_config_user_schema = {
 341     "title": "User schema for cloud-init configuration schema",
 342     "$schema": "http://json-schema.org/draft-04/schema#",
 343     "type":"object",
 344     "properties":{
 345         "name": nameshort_schema,
 346         "user-info": {"type":"string"},
 347         #"key-pairs": {"type" : "array", "items": key_pair_schema}
 348         "key-pairs": {"type" : "array", "items": {"type":"string"}}
 349     },
 350     "required": ["name"],
 351     "additionalProperties": False
 352 }
 353
 354 cloud_config_schema = {
 355     "title": "Cloud-init configuration schema",
 356     "$schema": "http://json-schema.org/draft-04/schema#",
 357     "type":"object",
 358     "properties":{
 359         #"key-pairs": {"type" : "array", "items": key_pair_schema},
 360         "key-pairs": {"type" : "array", "items": {"type":"string"}},
 361         "users": {"type" : "array", "items": cloud_config_user_schema}
 362     },
 363     "additionalProperties": False
 364 }
 365
 366 internal_connection_element_schema = {
 367     "type":"object",
 368     "properties":{
 369         "VNFC": name_schema,
 370         "local_iface_name": name_schema
 371     }
 372 }
 373
 374 internal_connection_element_schema_v02 = {
 375     "type":"object",
 376     "properties":{
 377         "VNFC": name_schema,
 378         "local_iface_name": name_schema,
 379         "ip_address": ip_schema
 380     }
 381 }
 382
 383 internal_connection_schema = {
 384     "type":"object",
 385     "properties":{
 386         "name": name_schema,
 387         "description":description_schema,
 388         "type":{"type":"string", "enum":["bridge","data","ptp"]},
 389         "elements": {"type" : "array", "items": internal_connection_element_schema, "minItems":2}
 390     },
 391     "required": ["name", "type", "elements"],
 392     "additionalProperties": False
 393 }
 394
 395 internal_connection_schema_v02 = {
 396     "type":"object",
 397     "properties":{
 398         "name": name_schema,
 399         "description":description_schema,
 400         "type": {"type": "string", "enum":["e-line", "e-lan"]},
 401         "implementation": {"type": "string", "enum":["overlay", "underlay"]},
 402         "ip-profile": ip_profile_schema,
 403         "elements": {"type" : "array", "items": internal_connection_element_schema_v02, "minItems":2}
 404     },
 405     "required": ["name", "type", "implementation", "elements"],
 406     "additionalProperties": False
 407 }
 408
 409 external_connection_schema = {
 410     "type":"object",
 411     "properties":{
 412         "name": name_schema,
 413         "type":{"type":"string", "enum":["mgmt","bridge","data"]},
 414         "VNFC": name_schema,
 415         "local_iface_name": name_schema ,
 416         "description":description_schema
 417     },
 418     "required": ["name", "type", "VNFC", "local_iface_name"],
 419     "additionalProperties": False
 420 }
 421
 422 #Not yet used
 423 external_connection_schema_v02 = {
 424     "type":"object",
 425     "properties":{
 426         "name": name_schema,
 427         "mgmt": {"type":"boolean"},
 428         "type": {"type": "string", "enum":["e-line", "e-lan"]},
 429         "implementation": {"type": "string", "enum":["overlay", "underlay"]},
 430         "VNFC": name_schema,
 431         "local_iface_name": name_schema ,
 432         "description":description_schema
 433     },
 434     "required": ["name", "type", "VNFC", "local_iface_name"],
 435     "additionalProperties": False
 436 }
 437
 438 interfaces_schema={
 439     "type":"array",
 440     "items":{
 441         "type":"object",
 442         "properties":{
 443             "name":name_schema,
 444             "dedicated":{"type":"string","enum":["yes","no","yes:sriov"]},
 445             "bandwidth":bandwidth_schema,
 446             "vpci":pci_schema,
 447             "mac_address": mac_schema
 448         },
 449         "additionalProperties": False,
 450         "required": ["name","dedicated", "bandwidth"]
 451     }
 452 }
 453
 454 bridge_interfaces_schema={
 455     "type":"array",
 456     "items":{
 457         "type":"object",
 458         "properties":{
 459             "name": name_schema,
 460             "bandwidth":bandwidth_schema,
 461             "vpci":pci_schema,
 462             "mac_address": mac_schema,
 463             "model": {"type":"string", "enum":["virtio","e1000","ne2k_pci","pcnet","rtl8139"]},
 464             "port-security": {"type" : "boolean"},
 465             "floating-ip": {"type" : "boolean"}
 466         },
 467         "additionalProperties": False,
 468         "required": ["name"]
 469     }
 470 }
 471
 472 devices_schema={
 473     "type":"array",
 474     "items":{
 475         "type":"object",
 476         "properties":{
 477             "type":{"type":"string", "enum":["disk","cdrom","xml"] },
 478             "image": path_schema,
 479             "image name": name_schema,
 480             "image checksum": checksum_schema,
 481             "image metadata": metadata_schema,
 482             "size": size_schema,
 483             "vpci":pci_schema,
 484             "xml":xml_text_schema,
 485         },
 486         "additionalProperties": False,
 487         "required": ["type"]
 488     }
 489 }
 490
 491
 492 numa_schema = {
 493     "type": "object",
 494     "properties": {
 495         "memory":integer1_schema,
 496         "cores":integer1_schema,
 497         "paired-threads":integer1_schema,
 498         "threads":integer1_schema,
 499         "cores-id":{"type":"array","items":integer0_schema},
 500         "paired-threads-id":{"type":"array","items":{"type":"array","minItems":2,"maxItems":2,"items":integer0_schema}},
 501         "threads-id":{"type":"array","items":integer0_schema},
 502         "interfaces":interfaces_schema
 503     },
 504     "additionalProperties": False,
 505     #"required": ["memory"]
 506 }
 507
 508 config_files_schema = {
 509     "title": "Config files for cloud init schema",
 510     "$schema": "http://json-schema.org/draft-04/schema#",
 511     "type": "object",
 512     "properties": {
 513         "dest": path_schema,
 514         "encoding": {"type": "string", "enum": ["b64", "base64", "gz", "gz+b64", "gz+base64", "gzip+b64", "gzip+base64"]},  #by default text
 515         "content": {"type": "string"},
 516         "permissions": {"type": "string"}, # tiypically octal notation '0644'
 517         "owner": {"type": "string"},  # format:   owner:group
 518
 519     },
 520     "additionalProperties": False,
 521     "required": ["dest", "content"],
 522 }
 523
 524 boot_data_vdu_schema  = {
 525     "title": "Boot data (Cloud-init) configuration schema",
 526     "$schema": "http://json-schema.org/draft-04/schema#",
 527     "type": "object",
 528     "properties":{
 529         "key-pairs": {"type" : "array", "items": {"type":"string"}},
 530         "users": {"type" : "array", "items": cloud_config_user_schema},
 531         "user-data": {"type" : "string"},  # scrip to run
 532         "config-files": {"type": "array", "items": config_files_schema},
 533         # NOTE: “user-data” are mutually exclusive with users and config-files because user/files are injected using user-data
 534         "boot-data-drive": {"type": "boolean"},
 535     },
 536     "additionalProperties": False,
 537 }
 538
 539 vnfc_schema = {
 540     "type":"object",
 541     "properties":{
 542         "name": name_schema,
 543         "description": description_schema,
 544         "image name": name_schema,
 545         "availability_zone": name_schema,
 546         "VNFC image": {"oneOf": [path_schema, http_schema]},
 547         "image checksum": checksum_schema,
 548         "image metadata": metadata_schema,
 549         #"cloud-config": cloud_config_schema, #common for all vnfs in the scenario
 550         "processor": {
 551             "type":"object",
 552             "properties":{
 553                 "model":description_schema,
 554                 "features":{"type":"array","items":nameshort_schema}
 555             },
 556             "required": ["model"],
 557             "additionalProperties": False
 558         },
 559         "hypervisor": {
 560             "type":"object",
 561             "properties":{
 562                 "type":nameshort_schema,
 563                 "version":description_schema
 564             },
 565         },
 566         "ram":integer0_schema,
 567         "vcpus":integer0_schema,
 568         "disk": integer1_schema,
 569         "numas": {
 570             "type": "array",
 571             "items": numa_schema
 572         },
 573         "bridge-ifaces": bridge_interfaces_schema,
 574         "devices": devices_schema,
 575         "boot-data" : boot_data_vdu_schema
 576
 577     },
 578     "required": ["name"],
 579     "oneOf": [
 580         {"required": ["VNFC image"]},
 581         {"required": ["image name"]}
 582     ],
 583     "additionalProperties": False
 584 }
 585
 586 vnfd_schema_v01 = {
 587     "title":"vnfd information schema v0.1",
 588     "$schema": "http://json-schema.org/draft-04/schema#",
 589     "type":"object",
 590     "properties":{
 591         "vnf":{
 592             "type":"object",
 593             "properties":{
 594                 "name": name_schema,
 595                 "description": description_schema,
 596
 597                 "class": nameshort_schema,
 598                 "public": {"type" : "boolean"},
 599                 "physical": {"type" : "boolean"},
 600                 "tenant_id": id_schema, #only valid for admin
 601                 "external-connections": {"type" : "array", "items": external_connection_schema, "minItems":1},
 602                 "internal-connections": {"type" : "array", "items": internal_connection_schema, "minItems":1},
 603                 "VNFC":{"type" : "array", "items": vnfc_schema, "minItems":1}
 604             },
 605             "required": ["name","external-connections"],
 606             "additionalProperties": True
 607         }
 608     },
 609     "required": ["vnf"],
 610     "additionalProperties": False
 611 }
 612
 613 #VNFD schema for OSM R1
 614 vnfd_schema_v02 = {
 615     "title":"vnfd information schema v0.2",
 616     "$schema": "http://json-schema.org/draft-04/schema#",
 617     "type":"object",
 618     "properties":{
 619         "schema_version": {"type": "string", "enum": ["0.2"]},
 620         "vnf":{
 621             "type":"object",
 622             "properties":{
 623                 "name": name_schema,
 624                 "description": description_schema,
 625                 "class": nameshort_schema,
 626                 "public": {"type" : "boolean"},
 627                 "physical": {"type" : "boolean"},
 628                 "tenant_id": id_schema, #only valid for admin
 629                 "external-connections": {"type" : "array", "items": external_connection_schema, "minItems":1},
 630                 "internal-connections": {"type" : "array", "items": internal_connection_schema_v02, "minItems":1},
 631                 # "cloud-config": cloud_config_schema, #common for all vnfcs
 632                 "VNFC":{"type" : "array", "items": vnfc_schema, "minItems":1}
 633             },
 634             "required": ["name"],
 635             "additionalProperties": True
 636         }
 637     },
 638     "required": ["vnf", "schema_version"],
 639     "additionalProperties": False
 640 }
 641
 642 #vnfd_schema = vnfd_schema_v01
 643 #{
 644 #    "title":"vnfd information schema v0.2",
 645 #    "$schema": "http://json-schema.org/draft-04/schema#",
 646 #    "oneOf": [vnfd_schema_v01, vnfd_schema_v02]
 647 #}
 648
 649 graph_schema = {
 650     "title":"graphical scenario descriptor information schema",
 651     "$schema": "http://json-schema.org/draft-04/schema#",
 652     "type":"object",
 653     "properties":{
 654         "x":      integer0_schema,
 655         "y":      integer0_schema,
 656         "ifaces": {
 657             "type":"object",
 658             "properties":{
 659                 "left": {"type":"array"},
 660                 "right": {"type":"array"},
 661                 "bottom": {"type":"array"},
 662             }
 663         }
 664     },
 665     "required": ["x","y"]
 666 }
 667
 668 nsd_schema_v01 = {
 669     "title":"network scenario descriptor information schema v0.1",
 670     "$schema": "http://json-schema.org/draft-04/schema#",
 671     "type":"object",
 672     "properties":{
 673         "name":name_schema,
 674         "description": description_schema,
 675         "tenant_id": id_schema, #only valid for admin
 676         "public": {"type": "boolean"},
 677         "topology":{
 678             "type":"object",
 679             "properties":{
 680                 "nodes": {
 681                     "type":"object",
 682                     "patternProperties":{
 683                         ".": {
 684                             "type": "object",
 685                             "properties":{
 686                                 "type":{"type":"string", "enum":["VNF", "other_network", "network", "external_network"]},
 687                                 "vnf_id": id_schema,
 688                                 "graph": graph_schema,
 689                             },
 690                             "patternProperties":{
 691                                 "^(VNF )?model$": {"type": "string"}
 692                             },
 693                             "required": ["type"]
 694                         }
 695                     }
 696                 },
 697                 "connections": {
 698                     "type":"object",
 699                     "patternProperties":{
 700                         ".": {
 701                             "type": "object",
 702                             "properties":{
 703                                 "nodes":{"oneOf":[{"type":"object", "minProperties":2}, {"type":"array", "minLength":1}]},
 704                                 "type": {"type": "string", "enum":["link", "external_network", "dataplane_net", "bridge_net"]},
 705                                 "graph": graph_schema
 706                             },
 707                             "required": ["nodes"]
 708                         },
 709                     }
 710                 }
 711             },
 712             "required": ["nodes"],
 713             "additionalProperties": False
 714         }
 715     },
 716     "required": ["name","topology"],
 717     "additionalProperties": False
 718 }
 719
 720 nsd_schema_v02 = {
 721     "title":"network scenario descriptor information schema v0.2",
 722     "$schema": "http://json-schema.org/draft-04/schema#",
 723     "type":"object",
 724     "properties":{
 725         "schema_version": schema_version_2,
 726         "scenario":{
 727             "type":"object",
 728             "properties":{
 729                 "name": name_schema,
 730                 "description": description_schema,
 731                 "tenant_id": id_schema, #only valid for admin
 732                 "public": {"type": "boolean"},
 733                 "vnfs": {
 734                     "type":"object",
 735                     "patternProperties":{
 736                         ".": {
 737                             "type": "object",
 738                             "properties":{
 739                                 "vnf_id": id_schema,
 740                                 "graph": graph_schema,
 741                                 "vnf_name": name_schema,
 742                             },
 743                         }
 744                     },
 745                     "minProperties": 1
 746                 },
 747                 "networks": {
 748                     "type":"object",
 749                     "patternProperties":{
 750                         ".": {
 751                             "type": "object",
 752                             "properties":{
 753                                 "interfaces":{"type":"array", "minLength":1},
 754                                 "type": {"type": "string", "enum":["dataplane", "bridge"]},
 755                                 "external" : {"type": "boolean"},
 756                                 "graph": graph_schema
 757                             },
 758                             "required": ["interfaces"]
 759                         },
 760                     }
 761                 },
 762
 763             },
 764             "required": ["vnfs", "name"],
 765             "additionalProperties": False
 766         }
 767     },
 768     "required": ["scenario","schema_version"],
 769     "additionalProperties": False
 770 }
 771
 772 #NSD schema for OSM R1
 773 nsd_schema_v03 = {
 774     "title":"network scenario descriptor information schema v0.3",
 775     "$schema": "http://json-schema.org/draft-04/schema#",
 776     "type":"object",
 777     "properties":{
 778         "schema_version": {"type": "string", "enum": ["0.3"]},
 779         "scenario":{
 780             "type":"object",
 781             "properties":{
 782                 "name": name_schema,
 783                 "description": description_schema,
 784                 "tenant_id": id_schema, #only valid for admin
 785                 "public": {"type": "boolean"},
 786                 "cloud-config": cloud_config_schema, #common for all vnfs in the scenario
 787                 #"datacenter": name_schema,
 788                 "vnfs": {
 789                     "type":"object",
 790                     "patternProperties":{
 791                         ".": {
 792                             "type": "object",
 793                             "properties":{
 794                                 "vnf_id": id_schema,
 795                                 "graph": graph_schema,
 796                                 "vnf_name": name_schema,
 797                                 #"cloud-config": cloud_config_schema, #particular for a vnf
 798                                 #"datacenter": name_schema,
 799                                 "internal-connections": {
 800                                     "type": "object",
 801                                     "patternProperties": {
 802                                         ".": {
 803                                             "type": "object",
 804                                             "properties": {
 805                                                 "ip-profile": ip_profile_schema,
 806                                                 "elements": {
 807                                                     "type" : "array",
 808                                                     "items":{
 809                                                         "type":"object",
 810                                                         "properties":{
 811                                                             "VNFC": name_schema,
 812                                                             "local_iface_name": name_schema,
 813                                                             "ip_address": ip_schema
 814                                                         },
 815                                                         "required": ["VNFC", "local_iface_name"],
 816                                                     }
 817                                                 }
 818                                             }
 819                                         }
 820                                     }
 821                                 }
 822                             },
 823                         }
 824                     },
 825                     "minProperties": 1
 826                 },
 827                 "networks": {
 828                     "type":"object",
 829                     "patternProperties":{
 830                         ".": {
 831                             "type": "object",
 832                             "properties":{
 833                                 "interfaces":{
 834                                     "type":"array",
 835                                     "minLength":1,
 836                                     "items":{
 837                                         "type":"object",
 838                                         "properties":{
 839                                             "vnf": name_schema,
 840                                             "vnf_interface": name_schema,
 841                                             "ip_address": ip_schema
 842                                         },
 843                                         "required": ["vnf", "vnf_interface"],
 844                                     }
 845                                 },
 846                                 "type": {"type": "string", "enum":["e-line", "e-lan"]},
 847                                 "implementation": {"type": "string", "enum":["overlay", "underlay"]},
 848                                 "external" : {"type": "boolean"},
 849                                 "graph": graph_schema,
 850                                 "ip-profile": ip_profile_schema
 851                             },
 852                             "required": ["interfaces"]
 853                         },
 854                     }
 855                 },
 856
 857             },
 858             "required": ["vnfs", "networks","name"],
 859             "additionalProperties": False
 860         }
 861     },
 862     "required": ["scenario","schema_version"],
 863     "additionalProperties": False
 864 }
 865
 866 #scenario_new_schema = {
 867 #    "title":"new scenario information schema",
 868 #    "$schema": "http://json-schema.org/draft-04/schema#",
 869 #    #"oneOf": [nsd_schema_v01, nsd_schema_v02]
 870 #    "oneOf": [nsd_schema_v01]
 871 #}
 872
 873 scenario_edit_schema = {
 874     "title":"edit scenario information schema",
 875     "$schema": "http://json-schema.org/draft-04/schema#",
 876     "type":"object",
 877     "properties":{
 878         "name":name_schema,
 879         "description": description_schema,
 880         "topology":{
 881             "type":"object",
 882             "properties":{
 883                 "nodes": {
 884                     "type":"object",
 885                     "patternProperties":{
 886                         "^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$": {
 887                             "type":"object",
 888                             "properties":{
 889                                 "graph":{
 890                                     "type": "object",
 891                                     "properties":{
 892                                         "x": integer0_schema,
 893                                         "y": integer0_schema,
 894                                         "ifaces":{ "type": "object"}
 895                                     }
 896                                 },
 897                                 "description": description_schema,
 898                                 "name": name_schema
 899                             }
 900                         }
 901                     }
 902                 }
 903             },
 904             "required": ["nodes"],
 905             "additionalProperties": False
 906         }
 907     },
 908     "additionalProperties": False
 909 }
 910
 911 scenario_action_schema = {
 912     "title":"scenario action information schema",
 913     "$schema": "http://json-schema.org/draft-04/schema#",
 914     "type":"object",
 915     "properties":{
 916         "start":{
 917             "type": "object",
 918             "properties": {
 919                 "instance_name":name_schema,
 920                 "description":description_schema,
 921                 "datacenter": {"type": "string"}
 922             },
 923             "required": ["instance_name"]
 924         },
 925         "deploy":{
 926             "type": "object",
 927             "properties": {
 928                 "instance_name":name_schema,
 929                 "description":description_schema,
 930                 "datacenter": {"type": "string"}
 931             },
 932             "required": ["instance_name"]
 933         },
 934         "reserve":{
 935             "type": "object",
 936             "properties": {
 937                 "instance_name":name_schema,
 938                 "description":description_schema,
 939                 "datacenter": {"type": "string"}
 940             },
 941             "required": ["instance_name"]
 942         },
 943         "verify":{
 944             "type": "object",
 945             "properties": {
 946                 "instance_name":name_schema,
 947                 "description":description_schema,
 948                 "datacenter": {"type": "string"}
 949             },
 950             "required": ["instance_name"]
 951         }
 952     },
 953     "minProperties": 1,
 954     "maxProperties": 1,
 955     "additionalProperties": False
 956 }
 957
 958 instance_scenario_create_schema_v01 = {
 959     "title":"instance scenario create information schema v0.1",
 960     "$schema": "http://json-schema.org/draft-04/schema#",
 961     "type":"object",
 962     "properties":{
 963         "schema_version": {"type": "string", "enum": ["0.1"]},
 964         "instance":{
 965             "type":"object",
 966             "properties":{
 967                 "name":name_schema,
 968                 "description":description_schema,
 969                 "datacenter": name_schema,
 970                 "scenario" : name_schema, #can be an UUID or name
 971                 "action":{"enum": ["deploy","reserve","verify" ]},
 972                 "connect_mgmt_interfaces": {"oneOf": [{"type":"boolean"}, {"type":"object"}]},# can be true or a dict with datacenter: net_name
 973                 "cloud-config": cloud_config_schema, #common to all vnfs in the instance scenario
 974                 "vnfs":{             #mapping from scenario to datacenter
 975                     "type": "object",
 976                     "patternProperties":{
 977                         ".": {
 978                             "type": "object",
 979                             "properties":{
 980                                 "name": name_schema, #override vnf name
 981                                 "datacenter": name_schema,
 982                                 #"metadata": {"type": "object"},
 983                                 #"user_data": {"type": "string"}
 984                                 #"cloud-config": cloud_config_schema, #particular for a vnf
 985                                 "external-connections": {
 986                                     "type": "object",
 987                                     "patternProperties": {
 988                                         ".": {
 989                                             "type": "object",
 990                                             "properties": {
 991                                                 "vim-network-name": name_schema,
 992                                                 "ip_address": ip_schema
 993                                             }
 994                                         }
 995                                     }
 996                                 },
 997                                 "internal-connections": {
 998                                     "type": "object",
 999                                     "patternProperties": {
1000                                         ".": {
1001                                             "type": "object",
1002                                             "properties": {
1003                                                 "ip-profile": ip_profile_schema,
1004                                                 "elements": {
1005                                                     "type" : "array",
1006                                                     "items":{
1007                                                         "type":"object",
1008                                                         "properties":{
1009                                                             "VNFC": name_schema,
1010                                                             "local_iface_name": name_schema,
1011                                                             "ip_address": ip_schema
1012                                                         },
1013                                                         "required": ["VNFC", "local_iface_name"],
1014                                                     }
1015                                                 }
1016                                             }
1017                                         }
1018                                     }
1019                                 }
1020                             }
1021                         }
1022                     },
1023                 },
1024                 "networks":{             #mapping from scenario to datacenter
1025                     "type": "object",
1026                     "patternProperties":{
1027                         ".": {
1028                             "type": "object",
1029                             "properties":{
1030                                 "interfaces":{
1031                                     "type":"array",
1032                                     "minLength":1,
1033                                     "items":{
1034                                         "type":"object",
1035                                         "properties":{
1036                                             "ip_address": ip_schema,
1037                                             "datacenter": name_schema,
1038                                             "vim-network-name": name_schema
1039                                         },
1040                                         "patternProperties":{
1041                                             ".": {"type": "string"}
1042                                         }
1043                                     }
1044                                 },
1045                                 "ip-profile": ip_profile_schema,
1046                                 #if the network connects VNFs deployed at different sites, you must specify one entry per site that this network connect to
1047                                 "sites": {
1048                                     "type":"array",
1049                                     "minLength":1,
1050                                     "items":{
1051                                         "type":"object",
1052                                         "properties":{
1053                                             # By default for an scenario 'external' network openmano looks for an existing VIM network to map this external scenario network,
1054                                             # for other networks openamno creates at VIM
1055                                             # Use netmap-create to force to create an external scenario network
1056                                             "netmap-create": {"oneOf":[name_schema,{"type": "null"}]}, #datacenter network to use. Null if must be created as an internal net
1057                                             #netmap-use:   Indicates an existing VIM network that must be used for this scenario network.
1058                                             #Can use both the VIM network name (if it is not ambiguous) or the VIM net UUID
1059                                             #If both 'netmap-create' and 'netmap-use'are supplied, netmap-use precedes, but if fails openmano follows the netmap-create
1060                                             #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)
1061                                             "netmap-use": name_schema, #
1062                                             "vim-network-name": name_schema, #override network name
1063                                             #"ip-profile": ip_profile_schema,
1064                                             "datacenter": name_schema,
1065                                         }
1066                                     }
1067                                 },
1068
1069
1070
1071                             }
1072                         }
1073                     },
1074                 },
1075             },
1076             "additionalProperties": False,
1077             "required": ["name"]
1078         },
1079     },
1080     "required": ["instance"],
1081     "additionalProperties": False
1082 }
1083
1084 instance_scenario_action_schema = {
1085     "title":"instance scenario action information schema",
1086     "$schema": "http://json-schema.org/draft-04/schema#",
1087     "type":"object",
1088     "properties":{
1089         "start":{"type": "null"},
1090         "pause":{"type": "null"},
1091         "resume":{"type": "null"},
1092         "shutoff":{"type": "null"},
1093         "shutdown":{"type": "null"},
1094         "forceOff":{"type": "null"},
1095         "rebuild":{"type": "null"},
1096         "reboot":{
1097             "type": ["object","null"],
1098         },
1099         "console": {"type": ["string", "null"], "enum": ["novnc", "xvpvnc", "rdp-html5", "spice-html5", None]},
1100         "vnfs":{"type": "array", "items":{"type":"string"}},
1101         "vms":{"type": "array", "items":{"type":"string"}}
1102     },
1103     "minProperties": 1,
1104     #"maxProperties": 1,
1105     "additionalProperties": False
1106 }
1107
1108 sdn_controller_properties={
1109     "name": name_schema,
1110     "dpid": {"type":"string", "pattern":"^[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){7}$"},
1111     "ip": ip_schema,
1112     "port": port_schema,
1113     "type": {"type": "string", "enum": ["opendaylight","floodlight","onos"]},
1114     "version": {"type" : "string", "minLength":1, "maxLength":12},
1115     "user": nameshort_schema,
1116     "password": passwd_schema
1117 }
1118 sdn_controller_schema = {
1119     "title":"sdn controller information schema",
1120     "$schema": "http://json-schema.org/draft-04/schema#",
1121     "type":"object",
1122     "properties":{
1123         "sdn_controller":{
1124             "type":"object",
1125             "properties":sdn_controller_properties,
1126             "required": ["name", "port", 'ip', 'dpid', 'type'],
1127             "additionalProperties": False
1128         }
1129     },
1130     "required": ["sdn_controller"],
1131     "additionalProperties": False
1132 }
1133
1134 sdn_controller_edit_schema = {
1135     "title":"sdn controller update information schema",
1136     "$schema": "http://json-schema.org/draft-04/schema#",
1137     "type":"object",
1138     "properties":{
1139         "sdn_controller":{
1140             "type":"object",
1141             "properties":sdn_controller_properties,
1142             "additionalProperties": False
1143         }
1144     },
1145     "required": ["sdn_controller"],
1146     "additionalProperties": False
1147 }
1148
1149 sdn_port_mapping_schema  = {
1150     "$schema": "http://json-schema.org/draft-04/schema#",
1151     "title":"sdn port mapping information schema",
1152     "type": "object",
1153     "properties": {
1154         "sdn_port_mapping": {
1155             "type": "array",
1156             "items": {
1157                 "type": "object",
1158                 "properties": {
1159                     "compute_node": nameshort_schema,
1160                     "ports": {
1161                         "type": "array",
1162                         "items": {
1163                             "type": "object",
1164                             "properties": {
1165                                 "pci": pci_schema,
1166                                 "switch_port": nameshort_schema,
1167                                 "switch_mac": mac_schema
1168                             },
1169                             "required": ["pci"]
1170                         }
1171                     }
1172                 },
1173                 "required": ["compute_node", "ports"]
1174             }
1175         }
1176     },
1177     "required": ["sdn_port_mapping"]
1178 }
1179
1180 sdn_external_port_schema = {
1181     "$schema": "http://json-schema.org/draft-04/schema#",
1182     "title":"External port ingformation",
1183     "type": "object",
1184     "properties": {
1185         "port": {"type" : "string", "minLength":1, "maxLength":60},
1186         "vlan": vlan_schema,
1187         "mac": mac_schema
1188     },
1189     "required": ["port"]
1190 }