1 # -*- coding: utf-8 -*-
4 # Copyright 2015 Telefonica Investigacion y Desarrollo, S.A.U.
5 # This file is part of openmano
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
12 # http://www.apache.org/licenses/LICENSE-2.0
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
20 # For those usages not covered by the Apache License, Version 2.0 please
21 # contact with: nfvlabs@tid.es
25 JSON schemas used by openmano httpserver.py module to parse the different files and messages sent through the API
27 __author__
="Alfonso Tierno, Gerardo Garcia, Pablo Montes"
28 __date__
="$09-oct-2014 09:09:48$"
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 # allows [] for wildcards. For that reason huge length limit is set
41 pci_extended_schema
= {"type": "string", "pattern": "^[0-9a-fA-F.:-\[\]]{12,40}$"}
43 http_schema
={"type":"string", "pattern":"^https?://[^'\"=]+$"}
44 bandwidth_schema
={"type":"string", "pattern" : "^[0-9]+ *([MG]bps)?$"}
45 memory_schema
={"type":"string", "pattern" : "^[0-9]+ *([MG]i?[Bb])?$"}
46 integer0_schema
={"type":"integer","minimum":0}
47 integer1_schema
={"type":"integer","minimum":1}
48 path_schema
={"type":"string", "pattern":"^(\.){0,2}(/[^/\"':{}\(\)]+)+$"}
49 vlan_schema
={"type":"integer","minimum":1,"maximum":4095}
50 vlan1000_schema
={"type":"integer","minimum":1000,"maximum":4095}
51 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
52 #mac_schema={"type":"string", "pattern":"^([0-9a-fA-F]{2}:){5}[0-9a-fA-F]{2}$"}
53 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]?)$"}
54 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])$"}
55 port_schema
={"type":"integer","minimum":1,"maximum":65534}
56 object_schema
={"type":"object"}
57 schema_version_2
={"type":"integer","minimum":2,"maximum":2}
58 #schema_version_string={"type":"string","enum": ["0.1", "2", "0.2", "3", "0.3"]}
59 log_level_schema
={"type":"string", "enum":["DEBUG", "INFO", "WARNING","ERROR","CRITICAL"]}
60 checksum_schema
={"type":"string", "pattern":"^[0-9a-fA-F]{32}$"}
61 size_schema
={"type":"integer","minimum":1,"maximum":100}
62 boolean_schema
= {"type": "boolean"}
63 null_schema
= {"type": "null"}
68 "architecture": {"type":"string"},
69 "use_incremental": {"type":"string","enum":["yes","no"]},
71 "os_distro": {"type":"string"},
72 "os_type": {"type":"string"},
73 "os_version": {"type":"string"},
74 "bus": {"type":"string"},
75 "topology": {"type":"string", "enum": ["oneSocket"]}
79 #Schema for the configuration file
81 "title":"configuration response information schema",
82 "$schema": "http://json-schema.org/draft-04/schema#",
85 "http_port": port_schema
,
86 "http_admin_port": port_schema
,
87 "http_host": nameshort_schema
,
88 "auto_push_VNF_to_VIMs": boolean_schema
,
89 "vnf_repository": path_schema
,
90 "db_host": nameshort_schema
,
91 "db_user": nameshort_schema
,
92 "db_passwd": {"type":"string"},
93 "db_name": nameshort_schema
,
94 "db_ovim_host": nameshort_schema
,
95 "db_ovim_user": nameshort_schema
,
96 "db_ovim_passwd": {"type":"string"},
97 "db_ovim_name": nameshort_schema
,
98 # Next fields will disappear once the MANO API includes appropriate primitives
99 "vim_url": http_schema
,
100 "vim_url_admin": http_schema
,
101 "vim_name": nameshort_schema
,
102 "vim_tenant_name": nameshort_schema
,
103 "mano_tenant_name": nameshort_schema
,
104 "mano_tenant_id": id_schema
,
105 "http_console_proxy": boolean_schema
,
106 "http_console_host": nameshort_schema
,
107 "http_console_ports": {
111 {"type": "object", "properties": {"from": port_schema
, "to": port_schema
}, "required": ["from", "to"]}
114 "log_level": log_level_schema
,
115 "log_socket_level": log_level_schema
,
116 "log_level_db": log_level_schema
,
117 "log_level_vim": log_level_schema
,
118 "log_level_wim": log_level_schema
,
119 "log_level_nfvo": log_level_schema
,
120 "log_level_http": log_level_schema
,
121 "log_level_console": log_level_schema
,
122 "log_level_ovim": log_level_schema
,
123 "log_file_db": path_schema
,
124 "log_file_vim": path_schema
,
125 "log_file_wim": path_schema
,
126 "log_file_nfvo": path_schema
,
127 "log_file_http": path_schema
,
128 "log_file_console": path_schema
,
129 "log_file_ovim": path_schema
,
130 "log_socket_host": nameshort_schema
,
131 "log_socket_port": port_schema
,
132 "log_file": path_schema
,
134 "required": ['db_user', 'db_passwd', 'db_name'],
135 "additionalProperties": False
139 "title":"tenant information schema",
140 "$schema": "http://json-schema.org/draft-04/schema#",
146 "name": nameshort_schema
,
147 "description": description_schema
,
149 "required": ["name"],
150 "additionalProperties": True
153 "required": ["tenant"],
154 "additionalProperties": False
157 tenant_edit_schema
= {
158 "title":"tenant edit information schema",
159 "$schema": "http://json-schema.org/draft-04/schema#",
166 "description": description_schema
,
168 "additionalProperties": False
171 "required": ["tenant"],
172 "additionalProperties": False
175 datacenter_schema_properties
={
177 "description": description_schema
,
178 "type": nameshort_schema
, #currently "openvim" or "openstack", can be enlarged with plugins
179 "vim_url": description_schema
,
180 "vim_url_admin": description_schema
,
181 "config": { "type":"object" }
184 datacenter_schema
= {
185 "title":"datacenter information schema",
186 "$schema": "http://json-schema.org/draft-04/schema#",
191 "properties":datacenter_schema_properties
,
192 "required": ["name", "vim_url"],
193 "additionalProperties": True
196 "required": ["datacenter"],
197 "additionalProperties": False
201 datacenter_edit_schema
= {
202 "title":"datacenter edit nformation schema",
203 "$schema": "http://json-schema.org/draft-04/schema#",
208 "properties":datacenter_schema_properties
,
209 "additionalProperties": False
212 "required": ["datacenter"],
213 "additionalProperties": False
217 netmap_new_schema
= {
218 "title":"netmap new information schema",
219 "$schema": "http://json-schema.org/draft-04/schema#",
222 "netmap":{ #delete from datacenter
225 "name": name_schema
, #name or uuid of net to change
227 "vim_name": name_schema
230 "additionalProperties": False
233 "required": ["netmap"],
234 "additionalProperties": False
237 netmap_edit_schema
= {
238 "title":"netmap edit information schema",
239 "$schema": "http://json-schema.org/draft-04/schema#",
242 "netmap":{ #delete from datacenter
245 "name": name_schema
, #name or uuid of net to change
248 "additionalProperties": False
251 "required": ["netmap"],
252 "additionalProperties": False
255 datacenter_action_schema
= {
256 "title":"datacenter action information schema",
257 "$schema": "http://json-schema.org/draft-04/schema#",
260 "check-connectivity": {"type": "null"},
261 "net-update": {"type": "null"},
265 "net": name_schema
, #name or uuid of net to change
267 "description": description_schema
,
268 "shared": boolean_schema
271 "additionalProperties": False
276 "net": name_schema
, #name or uuid of net to change
279 "additionalProperties": False
284 "additionalProperties": False
288 datacenter_associate_schema
={
289 "title":"datacenter associate information schema",
290 "$schema": "http://json-schema.org/draft-04/schema#",
298 "vim_tenant": name_schema
,
299 "vim_tenant_name": name_schema
,
300 "vim_username": nameshort_schema
,
301 "vim_password": nameshort_schema
,
302 "config": {"type": "object"}
304 # "required": ["vim_tenant"],
305 "additionalProperties": True
308 "required": ["datacenter"],
309 "additionalProperties": False
313 "title": "DHCP schema",
314 "$schema": "http://json-schema.org/draft-04/schema#",
317 "enabled": boolean_schema
,
318 "start-address": {"OneOf": [null_schema
, ip_schema
]},
319 "count": integer0_schema
321 # "required": ["start-address", "count"],
324 ip_profile_schema
= {
325 "title": "IP profile schema",
326 "$schema": "http://json-schema.org/draft-04/schema#",
329 "ip-version": {"type": "string", "enum": ["IPv4", "IPv6"]},
330 "subnet-address": ip_prefix_schema
,
331 "gateway-address": ip_schema
,
332 "dns-address": {"oneOf": [ip_schema
, # for backward compatibility
333 {"type": "array", "items": ip_schema
}]},
339 "title": "Key-pair schema for cloud-init configuration schema",
340 "$schema": "http://json-schema.org/draft-04/schema#",
344 "key": {"type":"string"}
347 "additionalProperties": False
350 cloud_config_user_schema
= {
351 "title": "User schema for cloud-init configuration schema",
352 "$schema": "http://json-schema.org/draft-04/schema#",
355 "name": nameshort_schema
,
356 "user-info": {"type":"string"},
357 #"key-pairs": {"type" : "array", "items": key_pair_schema}
358 "key-pairs": {"type" : "array", "items": {"type":"string"}}
360 "required": ["name"],
361 "additionalProperties": False
364 cloud_config_schema
= {
365 "title": "Cloud-init configuration schema",
366 "$schema": "http://json-schema.org/draft-04/schema#",
369 #"key-pairs": {"type" : "array", "items": key_pair_schema},
370 "key-pairs": {"type" : "array", "items": {"type":"string"}},
371 "users": {"type" : "array", "items": cloud_config_user_schema
}
373 "additionalProperties": False
376 internal_connection_element_schema
= {
380 "local_iface_name": name_schema
384 internal_connection_element_schema_v02
= {
388 "local_iface_name": name_schema
,
389 "ip_address": ip_schema
393 internal_connection_schema
= {
397 "description":description_schema
,
398 "type":{"type":"string", "enum":["bridge","data","ptp"]},
399 "elements": {"type" : "array", "items": internal_connection_element_schema
, "minItems":1}
401 "required": ["name", "type", "elements"],
402 "additionalProperties": False
405 internal_connection_schema_v02
= {
409 "description":description_schema
,
410 "type": {"type": "string", "enum":["e-line", "e-lan"]},
411 "implementation": {"type": "string", "enum":["overlay", "underlay"]},
412 "ip-profile": ip_profile_schema
,
413 "elements": {"type" : "array", "items": internal_connection_element_schema_v02
, "minItems":1}
415 "required": ["name", "type", "implementation", "elements"],
416 "additionalProperties": False
419 external_connection_schema
= {
423 "type":{"type":"string", "enum":["mgmt","bridge","data"]},
425 "local_iface_name": name_schema
,
426 "description":description_schema
428 "required": ["name", "type", "VNFC", "local_iface_name"],
429 "additionalProperties": False
433 external_connection_schema_v02
= {
437 "mgmt": boolean_schema
,
438 "type": {"type": "string", "enum":["e-line", "e-lan"]},
439 "implementation": {"type": "string", "enum":["overlay", "underlay"]},
441 "local_iface_name": name_schema
,
442 "description":description_schema
444 "required": ["name", "type", "VNFC", "local_iface_name"],
445 "additionalProperties": False
454 "dedicated":{"type":"string","enum":["yes","no","yes:sriov"]},
455 "bandwidth":bandwidth_schema
,
457 "mac_address": mac_schema
459 "additionalProperties": False,
460 "required": ["name","dedicated", "bandwidth"]
464 bridge_interfaces_schema
={
470 "bandwidth":bandwidth_schema
,
472 "mac_address": mac_schema
,
473 "model": {"type":"string", "enum":["virtio","e1000","ne2k_pci","pcnet","rtl8139", "paravirt"]},
474 "port-security": boolean_schema
,
475 "floating-ip": boolean_schema
,
477 "additionalProperties": False,
487 "type":{"type":"string", "enum":["disk","cdrom","xml"] },
488 "image": path_schema
,
489 "image name": name_schema
,
490 "image checksum": checksum_schema
,
491 "image metadata": metadata_schema
,
494 "xml":xml_text_schema
,
497 "additionalProperties": False,
506 "memory":integer1_schema
,
507 "cores":integer1_schema
,
508 "paired-threads":integer1_schema
,
509 "threads":integer1_schema
,
510 "cores-id":{"type":"array","items":integer0_schema
},
511 "paired-threads-id":{"type":"array","items":{"type":"array","minItems":2,"maxItems":2,"items":integer0_schema
}},
512 "threads-id":{"type":"array","items":integer0_schema
},
513 "interfaces":interfaces_schema
515 "additionalProperties": False,
516 #"required": ["memory"]
519 config_files_schema
= {
520 "title": "Config files for cloud init schema",
521 "$schema": "http://json-schema.org/draft-04/schema#",
525 "encoding": {"type": "string", "enum": ["b64", "base64", "gz", "gz+b64", "gz+base64", "gzip+b64", "gzip+base64"]}, #by default text
526 "content": {"type": "string"},
527 "permissions": {"type": "string"}, # tiypically octal notation '0644'
528 "owner": {"type": "string"}, # format: owner:group
531 "additionalProperties": False,
532 "required": ["dest", "content"],
535 boot_data_vdu_schema
= {
536 "title": "Boot data (Cloud-init) configuration schema",
537 "$schema": "http://json-schema.org/draft-04/schema#",
540 "key-pairs": {"type" : "array", "items": {"type":"string"}},
541 "users": {"type" : "array", "items": cloud_config_user_schema
},
542 "user-data": {"type" : "string"}, # scrip to run
543 "config-files": {"type": "array", "items": config_files_schema
},
544 # NOTE: “user-data” are mutually exclusive with users and config-files because user/files are injected using user-data
545 "boot-data-drive": boolean_schema
,
547 "additionalProperties": False,
554 "description": description_schema
,
555 "count": integer1_schema
,
556 "image name": name_schema
,
557 "availability_zone": name_schema
,
558 "VNFC image": {"oneOf": [path_schema
, http_schema
]},
559 "image checksum": checksum_schema
,
560 "image metadata": metadata_schema
,
561 #"cloud-config": cloud_config_schema, #common for all vnfs in the scenario
565 "model":description_schema
,
566 "features":{"type":"array","items":nameshort_schema
}
568 "required": ["model"],
569 "additionalProperties": False
574 "type":nameshort_schema
,
575 "version":description_schema
578 "ram":integer0_schema
,
579 "vcpus":integer0_schema
,
580 "disk": integer1_schema
,
585 "bridge-ifaces": bridge_interfaces_schema
,
586 "devices": devices_schema
,
587 "boot-data" : boot_data_vdu_schema
590 "required": ["name"],
592 {"required": ["VNFC image"]},
593 {"required": ["image name"]}
595 "additionalProperties": False
599 "title":"vnfd information schema v0.1",
600 "$schema": "http://json-schema.org/draft-04/schema#",
607 "description": description_schema
,
609 "class": nameshort_schema
,
610 "public": boolean_schema
,
611 "physical": boolean_schema
,
612 "default_user": name_schema
,
613 "tenant_id": id_schema
, #only valid for admin
614 "external-connections": {"type" : "array", "items": external_connection_schema
, "minItems":1},
615 "internal-connections": {"type" : "array", "items": internal_connection_schema
, "minItems":1},
616 "VNFC":{"type" : "array", "items": vnfc_schema
, "minItems":1}
618 "required": ["name","external-connections"],
619 "additionalProperties": True
623 "additionalProperties": False
626 #VNFD schema for OSM R1
628 "title":"vnfd information schema v0.2",
629 "$schema": "http://json-schema.org/draft-04/schema#",
632 "schema_version": {"type": "string", "enum": ["0.2"]},
637 "description": description_schema
,
638 "class": nameshort_schema
,
639 "public": boolean_schema
,
640 "physical": boolean_schema
,
641 "tenant_id": id_schema
, #only valid for admin
642 "external-connections": {"type" : "array", "items": external_connection_schema
, "minItems":1},
643 "internal-connections": {"type" : "array", "items": internal_connection_schema_v02
, "minItems":1},
644 # "cloud-config": cloud_config_schema, #common for all vnfcs
645 "VNFC":{"type" : "array", "items": vnfc_schema
, "minItems":1}
647 "required": ["name"],
648 "additionalProperties": True
651 "required": ["vnf", "schema_version"],
652 "additionalProperties": False
655 #vnfd_schema = vnfd_schema_v01
657 # "title":"vnfd information schema v0.2",
658 # "$schema": "http://json-schema.org/draft-04/schema#",
659 # "oneOf": [vnfd_schema_v01, vnfd_schema_v02]
663 "title":"graphical scenario descriptor information schema",
664 "$schema": "http://json-schema.org/draft-04/schema#",
667 "x": integer0_schema
,
668 "y": integer0_schema
,
672 "left": {"type":"array"},
673 "right": {"type":"array"},
674 "bottom": {"type":"array"},
678 "required": ["x","y"]
682 "title":"network scenario descriptor information schema v0.1",
683 "$schema": "http://json-schema.org/draft-04/schema#",
687 "description": description_schema
,
688 "tenant_id": id_schema
, #only valid for admin
689 "public": boolean_schema
,
695 "patternProperties":{
699 "type":{"type":"string", "enum":["VNF", "other_network", "network", "external_network"]},
701 "graph": graph_schema
,
703 "patternProperties":{
704 "^(VNF )?model$": {"type": "string"}
712 "patternProperties":{
716 "nodes":{"oneOf":[{"type":"object", "minProperties":2}, {"type":"array", "minLength":1}]},
717 "type": {"type": "string", "enum":["link", "external_network", "dataplane_net", "bridge_net"]},
718 "graph": graph_schema
720 "required": ["nodes"]
725 "required": ["nodes"],
726 "additionalProperties": False
729 "required": ["name","topology"],
730 "additionalProperties": False
734 "title":"network scenario descriptor information schema v0.2",
735 "$schema": "http://json-schema.org/draft-04/schema#",
738 "schema_version": schema_version_2
,
743 "description": description_schema
,
744 "tenant_id": id_schema
, #only valid for admin
745 "public": boolean_schema
,
748 "patternProperties":{
753 "graph": graph_schema
,
754 "vnf_name": name_schema
,
762 "patternProperties":{
766 "interfaces":{"type":"array", "minLength":1},
767 "type": {"type": "string", "enum":["dataplane", "bridge"]},
768 "external" : boolean_schema
,
769 "graph": graph_schema
771 "required": ["interfaces"]
777 "required": ["vnfs", "name"],
778 "additionalProperties": False
781 "required": ["scenario","schema_version"],
782 "additionalProperties": False
785 #NSD schema for OSM R1
787 "title":"network scenario descriptor information schema v0.3",
788 "$schema": "http://json-schema.org/draft-04/schema#",
791 "schema_version": {"type": "string", "enum": ["0.3"]},
796 "description": description_schema
,
797 "tenant_id": id_schema
, #only valid for admin
798 "public": boolean_schema
,
799 "cloud-config": cloud_config_schema
, #common for all vnfs in the scenario
800 #"datacenter": name_schema,
803 "patternProperties":{
808 "graph": graph_schema
,
809 "vnf_name": name_schema
,
810 #"cloud-config": cloud_config_schema, #particular for a vnf
811 #"datacenter": name_schema,
812 "internal-connections": {
814 "patternProperties": {
818 "ip-profile": ip_profile_schema
,
825 "local_iface_name": name_schema
,
826 "ip_address": ip_schema
,
828 "required": ["VNFC", "local_iface_name"],
842 "patternProperties":{
853 "vnf_interface": name_schema
,
854 "ip_address": ip_schema
856 "required": ["vnf", "vnf_interface"],
859 "type": {"type": "string", "enum":["e-line", "e-lan"]},
860 "implementation": {"type": "string", "enum":["overlay", "underlay"]},
861 "external" : boolean_schema
,
862 "graph": graph_schema
,
863 "ip-profile": ip_profile_schema
865 "required": ["interfaces"]
871 "required": ["vnfs", "networks","name"],
872 "additionalProperties": False
875 "required": ["scenario","schema_version"],
876 "additionalProperties": False
879 #scenario_new_schema = {
880 # "title":"new scenario information schema",
881 # "$schema": "http://json-schema.org/draft-04/schema#",
882 # #"oneOf": [nsd_schema_v01, nsd_schema_v02]
883 # "oneOf": [nsd_schema_v01]
886 scenario_edit_schema
= {
887 "title":"edit scenario information schema",
888 "$schema": "http://json-schema.org/draft-04/schema#",
892 "description": description_schema
,
898 "patternProperties":{
899 "^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$": {
905 "x": integer0_schema
,
906 "y": integer0_schema
,
907 "ifaces":{ "type": "object"}
910 "description": description_schema
,
917 "required": ["nodes"],
918 "additionalProperties": False
921 "additionalProperties": False
924 scenario_action_schema
= {
925 "title":"scenario action information schema",
926 "$schema": "http://json-schema.org/draft-04/schema#",
932 "instance_name":name_schema
,
933 "description":description_schema
,
934 "datacenter": {"type": "string"}
936 "required": ["instance_name"]
941 "instance_name":name_schema
,
942 "description":description_schema
,
943 "datacenter": {"type": "string"}
945 "required": ["instance_name"]
950 "instance_name":name_schema
,
951 "description":description_schema
,
952 "datacenter": {"type": "string"}
954 "required": ["instance_name"]
959 "instance_name":name_schema
,
960 "description":description_schema
,
961 "datacenter": {"type": "string"}
963 "required": ["instance_name"]
968 "additionalProperties": False
971 instance_scenario_object
= {
972 "title": "scenario object used to create an instance not based on any nsd",
973 "$schema": "http://json-schema.org/draft-04/schema#",
983 "external": boolean_schema
,
984 "type": {"enum": ["bridge", "ptp", "data"]}, # for overlay, underlay E-LINE, underlay E-LAN
986 "additionalProperties": False,
987 "required": ["name", "external", "type"]
991 "additionalProperties": False,
995 instance_scenario_create_schema_v01
= {
996 "title": "instance scenario create information schema v0.1",
997 "$schema": "http://json-schema.org/draft-04/schema#",
1000 "schema_version": {"type": "string", "enum": ["0.1"]},
1004 "mgmt_keys": {"type": "array", "items": {"type":"string"}},
1005 "vduImage": name_schema
,
1006 "name": name_schema
,
1007 "description":description_schema
,
1008 "datacenter": name_schema
,
1009 "wim_account": {"oneOf": [boolean_schema
, id_schema
, null_schema
]},
1010 "scenario" : {"oneOff": [name_schema
, instance_scenario_object
]}, # can be an UUID or name or a dict
1011 "action":{"enum": ["deploy","reserve","verify" ]},
1012 "connect_mgmt_interfaces": {"oneOf": [boolean_schema
, {"type":"object"}]},# can be true or a dict with datacenter: net_name
1013 "cloud-config": cloud_config_schema
, #common to all vnfs in the instance scenario
1014 "vnfs":{ #mapping from scenario to datacenter
1016 "patternProperties":{
1020 "name": name_schema
, #override vnf name
1021 "datacenter": name_schema
,
1022 #"metadata": {"type": "object"},
1023 #"user_data": {"type": "string"}
1024 #"cloud-config": cloud_config_schema, #particular for a vnf
1027 "patternProperties": {
1031 "name": name_schema
, # overrides vdu name schema
1032 "mgmt_keys": {"type": "array", "items": {"type": "string"}},
1033 "vduImage": name_schema
,
1036 "patternProperties": {
1038 "vim_id": name_schema
,
1044 "patternProperties": {
1046 "ip_address": ip_schema
,
1047 "mac_address": mac_schema
,
1048 "floating-ip": boolean_schema
,
1058 "patternProperties": {
1062 "vim-network-name": name_schema
,
1063 "vim-network-id": name_schema
,
1064 "ip-profile": ip_profile_schema
,
1065 "name": name_schema
,
1074 "networks":{ #mapping from scenario to datacenter
1076 "patternProperties":{
1086 "ip_address": ip_schema
,
1087 "datacenter": name_schema
,
1088 "vim-network-name": name_schema
,
1089 "vim-network-id": name_schema
1091 "patternProperties":{
1092 ".": {"type": "string"}
1096 "wim_account": {"oneOf": [boolean_schema
, id_schema
, null_schema
]},
1097 "ip-profile": ip_profile_schema
,
1101 "instance_scenario_id": id_schema
,
1102 # "member_vnf_index": name_schema, # if not null, network inside VNF
1103 "osm_id": name_schema
, # sce_network osm_id or name
1105 "additionalProperties": False,
1106 "required": ["instance_scenario_id", "osm_id"]
1108 #if the network connects VNFs deployed at different sites, you must specify one entry per site that this network connect to
1115 # By default for an scenario 'external' network openmano looks for an existing VIM network to map this external scenario network,
1116 # for other networks openamno creates at VIM
1117 # Use netmap-create to force to create an external scenario network
1118 "netmap-create": {"oneOf":[name_schema
,null_schema
]}, #datacenter network to use. Null if must be created as an internal net
1119 #netmap-use: Indicates an existing VIM network that must be used for this scenario network.
1120 #Can use both the VIM network name (if it is not ambiguous) or the VIM net UUID
1121 #If both 'netmap-create' and 'netmap-use'are supplied, netmap-use precedes, but if fails openmano follows the netmap-create
1122 #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)
1123 "netmap-use": name_schema
, #
1124 "vim-network-name": name_schema
, #override network name
1125 "vim-network-id": name_schema
,
1126 #"ip-profile": ip_profile_schema,
1127 "datacenter": name_schema
,
1136 "additionalProperties": False,
1137 "required": ["name"]
1140 "required": ["instance"],
1141 "additionalProperties": False
1144 instance_scenario_action_schema
= {
1145 "title": "instance scenario action information schema",
1146 "$schema": "http://json-schema.org/draft-04/schema#",
1149 "start": null_schema
,
1150 "pause": null_schema
,
1151 "resume": null_schema
,
1152 "shutoff": null_schema
,
1153 "shutdown": null_schema
,
1154 "forceOff": null_schema
,
1155 "rebuild": null_schema
,
1157 "type": ["object", "null"],
1159 "add_public_key": description_schema
,
1160 "user": nameshort_schema
,
1161 "console": {"type": ["string", "null"], "enum": ["novnc", "xvpvnc", "rdp-html5", "spice-html5", None]},
1167 "vdu-id": id_schema
,
1168 "osm_vdu_id": name_schema
,
1169 "member-vnf-index": name_schema
,
1170 "count": integer1_schema
,
1171 "type": {"enum": ["create", "delete"]}
1173 "additionalProperties": False,
1175 "required": ["type"]
1178 "vnfs": {"type": "array", "items": {"type": "string"}},
1179 "vms": {"type": "array", "items": {"type": "string"}}
1182 #"maxProperties": 1,
1183 "additionalProperties": False
1186 sdn_controller_properties
={
1187 "name": name_schema
,
1188 "dpid": {"type":"string", "pattern":"^[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){7}$"},
1190 "port": port_schema
,
1191 "type": {"type": "string", "enum": ["opendaylight","floodlight","onos"]},
1192 "version": {"type" : "string", "minLength":1, "maxLength":12},
1193 "user": nameshort_schema
,
1194 "password": passwd_schema
1196 sdn_controller_schema
= {
1197 "title":"sdn controller information schema",
1198 "$schema": "http://json-schema.org/draft-04/schema#",
1203 "properties":sdn_controller_properties
,
1204 "required": ["name", "port", 'ip', 'dpid', 'type'],
1205 "additionalProperties": False
1208 "required": ["sdn_controller"],
1209 "additionalProperties": False
1212 sdn_controller_edit_schema
= {
1213 "title":"sdn controller update information schema",
1214 "$schema": "http://json-schema.org/draft-04/schema#",
1219 "properties":sdn_controller_properties
,
1220 "additionalProperties": False
1223 "required": ["sdn_controller"],
1224 "additionalProperties": False
1227 sdn_port_mapping_schema
= {
1228 "$schema": "http://json-schema.org/draft-04/schema#",
1229 "title":"sdn port mapping information schema",
1232 "sdn_port_mapping": {
1237 "compute_node": nameshort_schema
,
1243 "pci": {"OneOf": [null_schema
, pci_extended_schema
]}, # pci_schema,
1244 "switch_port": nameshort_schema
,
1245 "switch_mac": mac_schema
1251 "required": ["compute_node", "ports"]
1255 "required": ["sdn_port_mapping"]
1258 sdn_external_port_schema
= {
1259 "$schema": "http://json-schema.org/draft-04/schema#",
1260 "title":"External port ingformation",
1263 "port": {"type" : "string", "minLength":1, "maxLength":60},
1264 "vlan": vlan_schema
,
1267 "required": ["port"]