1 # -*- coding: utf-8 -*-
4 # Copyright 2015 Telefónica Investigación y Desarrollo, S.A.U.
5 # This file is part of openvim
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
24 ''' Definition of dictionaries schemas used by validating input
25 These dictionaries are validated using jsonschema library
27 __author__
="Alfonso Tierno"
28 __date__
="$10-jul-2014 12:07:15$"
31 # SCHEMAS to validate input data
34 path_schema
= {"type": "string", "maxLength": 255, "pattern": "^(\.){0,2}(/[^/\"':{}\(\)]+)+$"}
35 http_schema
={"type":"string", "pattern":"^https?://[^'\"=]+$"}
36 port_schema
={"type":"integer","minimum":1,"maximun":65534}
37 ip_schema
={"type":"string","pattern":"^([0-9]{1,3}.){3}[0-9]{1,3}$"}
38 cidr_schema
={"type":"string","pattern":"^([0-9]{1,3}.){3}[0-9]{1,3}/[0-9]{1,2}$"}
39 name_schema
={"type" : "string", "minLength":1, "maxLength":255, "pattern" : "^[^,;()'\"]+$"}
40 nameshort_schema
={"type" : "string", "minLength":1, "maxLength":64, "pattern" : "^[^,;()'\"]+$"}
41 nametiny_schema
={"type" : "string", "minLength":1, "maxLength":12, "pattern" : "^[^,;()'\"]+$"}
42 xml_text_schema
={"type" : "string", "minLength":1, "maxLength":1000, "pattern" : "^[^']+$"}
43 description_schema
={"type" : ["string","null"], "maxLength":255, "pattern" : "^[^'\"]+$"}
44 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}$"
45 id_schema
= {"type" : "string", "pattern": "^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$"}
46 pci_schema
={"type":"string", "pattern":"^[0-9a-fA-F]{4}(:[0-9a-fA-F]{2}){2}\.[0-9a-fA-F]$"}
47 bandwidth_schema
={"type":"string", "pattern" : "^[0-9]+ *([MG]bps)?$"}
48 integer0_schema
={"type":"integer","minimum":0}
49 integer1_schema
={"type":"integer","minimum":1}
50 vlan_schema
={"type":"integer","minimum":1,"maximun":4095}
51 vlan1000_schema
={"type":"integer","minimum":1000,"maximun":4095}
52 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
53 net_bind_schema
={"oneOf":[{"type":"null"},{"type":"string", "pattern":"^(default|((bridge|macvtap):[0-9a-zA-Z\.\-]{1,50})|openflow:[/0-9a-zA-Z\.\-]{1,50}(:vlan)?)$"}]}
54 yes_no_schema
={"type":"string", "enum":["yes", "no"]}
55 log_level_schema
={"type":"string", "enum":["DEBUG", "INFO", "WARNING","ERROR","CRITICAL"]}
58 "title": "main configuration information schema",
59 "$schema": "http://json-schema.org/draft-04/schema#",
62 "http_port": port_schema
,
63 "http_admin_port": port_schema
,
64 "http_host": nameshort_schema
,
65 "http_url_prefix": path_schema
, # it does not work yet; it's supposed to be the base path to be used by bottle, but it must be explicitly declared
66 "db_host": nameshort_schema
,
67 "db_user": nameshort_schema
,
68 "db_passwd": {"type": "string"},
69 "db_name": nameshort_schema
,
70 "of_controller_ip": ip_schema
,
71 "of_controller_port": port_schema
,
72 "of_controller_dpid": nameshort_schema
,
73 "of_controller_nets_with_same_vlan": {"type" : "boolean"},
74 "of_controller": nameshort_schema
, #{"type":"string", "enum":["floodlight", "opendaylight"]},
75 "of_controller_module": {"type":"string"},
76 "of_user": nameshort_schema
,
77 "of_password": nameshort_schema
,
78 "test_mode": {"type": "boolean"}, # leave for backward compatibility
79 "mode": {"type":"string", "enum":["normal", "host only", "OF only", "development", "test"] },
80 "development_bridge": {"type":"string"},
81 "tenant_id": {"type" : "string"},
82 "image_path": path_schema
, # leave for backward compatibility
83 "host_image_path": path_schema
,
84 "host_ssh_keyfile": path_schema
,
85 "network_vlan_range_start": vlan_schema
,
86 "network_vlan_range_end": vlan_schema
,
89 "patternProperties": {
92 "items": integer0_schema
,
104 "provider": {"type": "string", "enum": ["isc-dhcp-server"]},
105 "user": nameshort_schema
,
106 "password": {"type": "string"},
107 "key": path_schema
, # for backward compatibility, use keyfile instead
108 "keyfile": path_schema
,
111 "items": nameshort_schema
,
115 "items": name_schema
,
118 "required": ['host', 'provider', 'user']
120 "log_level": log_level_schema
,
121 "log_level_db": log_level_schema
,
122 "log_level_of": log_level_schema
,
123 "network_type": {"type": "string", "enum": ["ovs", "bridge"]},
124 "ovs_controller_file_path": path_schema
,
125 "ovs_controller_ip": nameshort_schema
,
126 "ovs_controller_user": nameshort_schema
,
127 "ovs_controller_password": {"type": "string"},
128 "ovs_controller_keyfile": path_schema
,
130 "patternProperties": {
131 "of_*" : {"type": ["string", "integer", "boolean"]}
133 "required": ['db_host', 'db_user', 'db_passwd', 'db_name'],
134 "additionalProperties": False
142 "architecture": {"type":"string"},
143 "use_incremental": yes_no_schema
,
145 "os_distro": {"type":"string"},
146 "os_type": {"type":"string"},
147 "os_version": {"type":"string"},
148 "bus": {"type":"string"},
149 "topology": {"type":"string", "enum": ["oneSocket", "oneSocket:hyperthreading"]}
153 tenant_new_schema
= {
154 "title":"tenant creation information schema",
155 "$schema": "http://json-schema.org/draft-04/schema#",
162 "name": nameshort_schema
,
163 "description":description_schema
,
164 "enabled":{"type" : "boolean"}
169 "required": ["tenant"],
170 "additionalProperties": False
173 tenant_edit_schema
= {
174 "title":"tenant edition information schema",
175 "$schema": "http://json-schema.org/draft-04/schema#",
182 "name":nameshort_schema
,
183 "description":description_schema
,
184 "enabled":{"type" : "boolean"}
186 "additionalProperties": False,
189 "required": ["tenant"],
190 "additionalProperties": False
199 "dedicated":{"type":"string","enum":["yes","no","yes:sriov"]},
200 "bandwidth":bandwidth_schema
,
203 "mac_address":mac_schema
205 "additionalProperties": False,
206 "required": ["dedicated", "bandwidth"]
213 "processor_ranking":integer0_schema
,
219 "type":{"type":"string", "enum":["usb","disk","cdrom","xml"]},
221 "imageRef":id_schema
,
222 "xml":xml_text_schema
,
223 "dev":nameshort_schema
,
224 "size":integer1_schema
,
226 "additionalProperties": False,
235 "memory":integer1_schema
,
236 "cores":integer1_schema
,
237 "paired-threads":integer1_schema
,
238 "threads":integer1_schema
,
239 "cores-id":{"type":"array","items":integer0_schema
},
240 "paired-threads-id":{"type":"array","items":{"type":"array","minItems":2,"maxItems":2,"items":integer0_schema
}},
241 "threads-id":{"type":"array","items":integer0_schema
},
242 "interfaces":interfaces_schema
244 "additionalProperties": False,
246 #"required": ["memory"]
250 #"additionalProperties": False,
251 #"required": ["processor_ranking"]
255 "title":"hosts manual insertion information schema",
259 "admin_state_up": {"type": "boolean"},
260 "created_at": {"type": "string"}, # ignored, just for compatibility with host-list
261 "ip_name": nameshort_schema
,
263 "description": description_schema
,
264 "user": nameshort_schema
,
265 "password": nameshort_schema
,
266 "keyfile": path_schema
,
267 "features": description_schema
,
268 "ranking": integer0_schema
,
269 "autodiscover": {"type": "boolean"}, # try to discover host parameters instead of providing in this schema
275 "type": {"type": "string", "enum": ["usb", "disk"]},
278 "additionalProperties": False,
288 "admin_state_up": {"type": "boolean"},
289 "hugepages": integer0_schema
,
290 "hugepages_consumed": integer0_schema
, # ignored, just for compatibility with host-list
291 "numa_socket": integer0_schema
,
292 "memory": integer1_schema
,
299 "core_id": integer0_schema
,
300 "thread_id": integer0_schema
,
301 "status": {"type": "string", "enum": ["noteligible"]},
302 "instance_id": {"type": "string"}, # ignored, just for compatibility with host-list
303 "v_thread_id": {"type": "integer"} # ignored, just for compatibility with host-list
305 "additionalProperties": False,
306 "required": ["core_id", "thread_id"]
315 "source_name": nameshort_schema
,
317 "Mbps": integer0_schema
,
325 "source_name": {"oneOf": [integer0_schema
, nameshort_schema
]},
327 "vlan": integer0_schema
, # ignored, just for backward compatibility
330 "additionalProperties": False,
331 "required": ["source_name", "mac", "pci"]
334 "switch_port": nameshort_schema
,
335 "switch_dpid": nameshort_schema
,
336 "switch_mac": mac_schema
,
338 "additionalProperties": False,
339 "required": ["source_name", "mac", "Mbps", "pci"]
343 "additionalProperties": False,
344 "required": ["cores", "numa_socket"]
348 "additionalProperties": False,
349 "required": ["name", "user", "ip_name"]
353 "title":"hosts creation information schema",
354 "$schema": "http://json-schema.org/draft-04/schema#",
360 "ip_name":nameshort_schema
,
362 "description":description_schema
,
363 "user":nameshort_schema
,
364 "password":nameshort_schema
,
365 "admin_state_up":{"type":"boolean"},
371 "numa_socket": integer0_schema
,
372 "admin_state_up":{"type":"boolean"},
378 "source_name": nameshort_schema
,
379 "switch_dpid": nameshort_schema
,
380 "switch_port": nameshort_schema
,
382 "required": ["source_name"],
386 "required": ["numa_socket"],
387 "additionalProperties": False,
392 "additionalProperties": False
395 "required": ["host"],
397 "additionalProperties": False
401 "title":"hosts creation information schema",
402 "$schema": "http://json-schema.org/draft-04/schema#",
405 "host": host_data_schema
,
406 "host-data":host_data_schema
408 "required": ["host"],
411 "additionalProperties": False
415 flavor_new_schema
= {
416 "title":"flavor creation information schema",
417 "$schema": "http://json-schema.org/draft-04/schema#",
425 "description":description_schema
,
426 "ram":integer0_schema
,
427 "vcpus":integer0_schema
,
428 "extended": extended_schema
,
429 "public": yes_no_schema
434 "required": ["flavor"],
435 "additionalProperties": False
437 flavor_update_schema
= {
438 "title":"flavor update information schema",
439 "$schema": "http://json-schema.org/draft-04/schema#",
446 "description":description_schema
,
447 "ram":integer0_schema
,
448 "vcpus":integer0_schema
,
449 "extended": extended_schema
,
450 "public": yes_no_schema
453 "additionalProperties": False
456 "required": ["flavor"],
457 "additionalProperties": False
461 "title":"image creation information schema",
462 "$schema": "http://json-schema.org/draft-04/schema#",
469 "path": {"oneOf": [path_schema
, http_schema
]},
470 "description":description_schema
,
472 "metadata":metadata_schema
,
473 "public": yes_no_schema
475 "required": ["name","path"]
478 "required": ["image"],
479 "additionalProperties": False
482 image_update_schema
= {
483 "title":"image update information schema",
484 "$schema": "http://json-schema.org/draft-04/schema#",
490 "path":{"oneOf": [path_schema
, http_schema
]},
491 "description":description_schema
,
493 "metadata":metadata_schema
,
494 "public": yes_no_schema
497 "additionalProperties": False
500 "required": ["image"],
501 "additionalProperties": False
510 "bandwidth":bandwidth_schema
,
513 "mac_address": mac_schema
,
514 "model": {"type":"string", "enum":["virtio","e1000","ne2k_pci","pcnet","rtl8139"]},
515 "type": {"type":"string", "enum":["virtual","PF","VF","VFnotShared"]}
517 "additionalProperties": False,
522 server_new_schema
= {
523 "title":"server creation information schema",
524 "$schema": "http://json-schema.org/draft-04/schema#",
532 "description":description_schema
,
533 "start":{"type":"string", "enum":["yes","no","paused"]},
535 "flavorRef":id_schema
,
536 "imageRef":id_schema
,
537 "extended": extended_schema
,
538 "networks":networks_schema
540 "required": ["name","flavorRef","imageRef"]
543 "required": ["server"],
544 "additionalProperties": False
547 server_action_schema
= {
548 "title":"server action information schema",
549 "$schema": "http://json-schema.org/draft-04/schema#",
552 "start":{"oneOf":[{"type": "null"}, {"type":"string", "enum":["rebuild","null"] }]},
553 "pause":{"type": "null"},
554 "resume":{"type": "null"},
555 "shutoff":{"type": "null"},
556 "shutdown":{"type": "null"},
557 "forceOff":{"type": "null"},
558 "terminate":{"type": "null"},
563 "description":description_schema
,
565 "metadata":metadata_schema
,
566 "imageRef": id_schema
,
567 "disk": {"oneOf":[{"type": "null"}, {"type":"string"}] },
571 "rebuild":{"type": ["object","null"]},
573 "type": ["object","null"],
575 # "type":{"type":"string", "enum":["SOFT"] }
577 # "minProperties": 1,
578 # "maxProperties": 1,
579 # "additionalProperties": False
584 "additionalProperties": False
587 network_new_schema
= {
588 "title": "network creation information schema",
589 "$schema": "http://json-schema.org/draft-04/schema#",
597 "type": {"type":"string", "enum": ["bridge_man", "bridge_data", "data", "ptp"]},
598 "shared": {"type": "boolean"},
599 "tenant_id": id_schema
,
600 "admin_state_up": {"type": "boolean"},
601 "provider:vlan": vlan_schema
,
602 "provider:physical": net_bind_schema
,
603 "region": nameshort_schema
,
605 "enable_dhcp": {"type": "boolean"},
606 "dhcp_first_ip": ip_schema
,
607 "dhcp_last_ip": ip_schema
,
608 "dns": {"type": "array", "items": [ip_schema
]},
609 "links": {"type": "array", "items": {"type": "object", "properties": {
611 "iface": name_schema
,
612 "vlan": vlan_schema
},
613 "required": ["iface"],
614 "additionalProperties": False
618 "routes": {"type": "object", "properties": {"default": ip_schema
}, "patternProperties": {
619 "^([0-9]{1,3}.){3}[0-9]{1,3}/[0-9]{1,2}$": ip_schema
,
621 "additionalProperties": False
624 "bind_net": name_schema
, # can be name, or uuid
625 "bind_type": {"oneOf": [{"type": "null"}, {"type": "string", "pattern": "^vlan:[0-9]{1,4}$"}]}
630 "required": ["network"],
631 "additionalProperties": False
634 network_update_schema
= {
635 "title":"network update information schema",
636 "$schema": "http://json-schema.org/draft-04/schema#",
643 "type":{"type":"string", "enum":["bridge_man","bridge_data","data", "ptp"]},
644 "shared":{"type":"boolean"},
645 "tenant_id":id_schema
,
646 "admin_state_up":{"type":"boolean"},
647 "provider:vlan":vlan_schema
,
648 "provider:physical":net_bind_schema
,
650 "enable_dhcp": {"type":"boolean"},
651 # "dhcp_first_ip": ip_schema,
652 # "dhcp_last_ip": ip_schema,
653 "bind_net":name_schema
, #can be name, or uuid
654 "bind_type":{"oneOf":[{"type":"null"},{"type":"string", "pattern":"^vlan:[0-9]{1,4}$"}]}
657 "additionalProperties": False
660 "required": ["network"],
661 "additionalProperties": False
666 "title":"port creation information schema",
667 "$schema": "http://json-schema.org/draft-04/schema#",
674 "name":nameshort_schema
,
675 "network_id":{"oneOf":[{"type": "null"}, id_schema
]},
676 "tenant_id":id_schema
,
677 "mac_address": {"oneOf":[{"type": "null"}, mac_schema
] },
678 "admin_state_up":{"type":"boolean"},
679 "bandwidth":bandwidth_schema
,
680 "binding:switch_port":nameshort_schema
,
681 "binding:vlan": {"oneOf":[{"type": "null"}, vlan_schema
]}
686 "required": ["port"],
687 "additionalProperties": False
690 port_update_schema
= {
691 "title":"port update information schema",
692 "$schema": "http://json-schema.org/draft-04/schema#",
698 "name":nameshort_schema
,
699 "network_id":{"anyOf":[{"type":"null"}, id_schema
] }
702 "additionalProperties": False
705 "required": ["port"],
706 "additionalProperties": False
710 "title":"localinfo information schema",
711 "$schema": "http://json-schema.org/draft-04/schema#",
714 "files":{ "type": "object"},
715 "inc_files":{ "type": "object"},
716 "server_files":{ "type": "object"}
718 "required": ["files"]
722 "title":"host information schema",
723 "$schema": "http://json-schema.org/draft-04/schema#",
728 "patternProperties":{
729 ".":{ "type": "string"}
734 "required": ["iface_names"]
737 openflow_controller_schema
= {
738 "title": "network creation information schema",
739 "$schema": "http://json-schema.org/draft-04/schema#",
746 "dpid": nameshort_schema
,
747 "ip": nameshort_schema
,
749 "type": nameshort_schema
,
750 "version": nametiny_schema
,
751 "user": nameshort_schema
,
752 "password": nameshort_schema
754 "required": ["dpid", "type", "ip", "port", "name"]
758 "additionalProperties": False
761 of_port_new_schema
= {
762 "title": "OF port mapping",
766 "region": nameshort_schema
,
767 "compute_node": nameshort_schema
,
769 "switch_dpid": nameshort_schema
,
770 "switch_port": nameshort_schema
,
771 "switch_mac": mac_schema
773 "required": ["region", "compute_node", "pci", "switch_dpid"]
776 of_port_map_new_schema
= {
777 "title": "OF port mapping",
778 "$schema": "http://json-schema.org/draft-04/schema#",
781 "of_port_mapings": {"type": "array", "items": of_port_new_schema
, "minLenght":1},
783 "required": ["of_port_mapings"],
784 "additionalProperties": False