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