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"]}
303 "additionalProperties": False,
304 "required": ["core_id", "thread_id"]
313 "source_name": nameshort_schema
,
315 "Mbps": integer0_schema
,
323 "source_name": {"oneOf": [integer0_schema
, nameshort_schema
]},
325 "vlan": integer0_schema
, # ignored, just for backward compatibility
328 "additionalProperties": False,
329 "required": ["source_name", "mac", "pci"]
332 "switch_port": nameshort_schema
,
333 "switch_dpid": nameshort_schema
,
334 "switch_mac": mac_schema
,
336 "additionalProperties": False,
337 "required": ["source_name", "mac", "Mbps", "pci"]
341 "additionalProperties": False,
342 "required": ["cores", "numa_socket"]
346 "additionalProperties": False,
347 "required": ["name", "ip_name"]
351 "title":"hosts creation information schema",
352 "$schema": "http://json-schema.org/draft-04/schema#",
358 "ip_name":nameshort_schema
,
360 "description":description_schema
,
361 "user":nameshort_schema
,
362 "password":nameshort_schema
,
363 "admin_state_up":{"type":"boolean"},
369 "numa_socket": integer0_schema
,
370 "admin_state_up":{"type":"boolean"},
376 "source_name": nameshort_schema
,
377 "switch_dpid": nameshort_schema
,
378 "switch_port": nameshort_schema
,
380 "required": ["source_name"],
384 "required": ["numa_socket"],
385 "additionalProperties": False,
390 "additionalProperties": False
393 "required": ["host"],
395 "additionalProperties": False
399 "title":"hosts creation information schema",
400 "$schema": "http://json-schema.org/draft-04/schema#",
403 "host": host_data_schema
,
404 "host-data":host_data_schema
406 "required": ["host"],
409 "additionalProperties": False
413 flavor_new_schema
= {
414 "title":"flavor creation information schema",
415 "$schema": "http://json-schema.org/draft-04/schema#",
423 "description":description_schema
,
424 "ram":integer0_schema
,
425 "vcpus":integer0_schema
,
426 "extended": extended_schema
,
427 "public": yes_no_schema
432 "required": ["flavor"],
433 "additionalProperties": False
435 flavor_update_schema
= {
436 "title":"flavor update information schema",
437 "$schema": "http://json-schema.org/draft-04/schema#",
444 "description":description_schema
,
445 "ram":integer0_schema
,
446 "vcpus":integer0_schema
,
447 "extended": extended_schema
,
448 "public": yes_no_schema
451 "additionalProperties": False
454 "required": ["flavor"],
455 "additionalProperties": False
459 "title":"image creation information schema",
460 "$schema": "http://json-schema.org/draft-04/schema#",
467 "path": {"oneOf": [path_schema
, http_schema
]},
468 "description":description_schema
,
470 "metadata":metadata_schema
,
471 "public": yes_no_schema
473 "required": ["name","path"]
476 "required": ["image"],
477 "additionalProperties": False
480 image_update_schema
= {
481 "title":"image update information schema",
482 "$schema": "http://json-schema.org/draft-04/schema#",
488 "path":{"oneOf": [path_schema
, http_schema
]},
489 "description":description_schema
,
491 "metadata":metadata_schema
,
492 "public": yes_no_schema
495 "additionalProperties": False
498 "required": ["image"],
499 "additionalProperties": False
508 "bandwidth":bandwidth_schema
,
511 "mac_address": mac_schema
,
512 "model": {"type":"string", "enum":["virtio","e1000","ne2k_pci","pcnet","rtl8139"]},
513 "type": {"type":"string", "enum":["virtual","PF","VF","VFnotShared"]}
515 "additionalProperties": False,
520 server_new_schema
= {
521 "title":"server creation information schema",
522 "$schema": "http://json-schema.org/draft-04/schema#",
530 "description":description_schema
,
531 "start":{"type":"string", "enum":["yes","no","paused"]},
533 "flavorRef":id_schema
,
534 "imageRef":id_schema
,
535 "extended": extended_schema
,
536 "networks":networks_schema
538 "required": ["name","flavorRef","imageRef"]
541 "required": ["server"],
542 "additionalProperties": False
545 server_action_schema
= {
546 "title":"server action information schema",
547 "$schema": "http://json-schema.org/draft-04/schema#",
550 "start":{"oneOf":[{"type": "null"}, {"type":"string", "enum":["rebuild","null"] }]},
551 "pause":{"type": "null"},
552 "resume":{"type": "null"},
553 "shutoff":{"type": "null"},
554 "shutdown":{"type": "null"},
555 "forceOff":{"type": "null"},
556 "terminate":{"type": "null"},
561 "description":description_schema
,
563 "metadata":metadata_schema
,
564 "imageRef": id_schema
,
565 "disk": {"oneOf":[{"type": "null"}, {"type":"string"}] },
569 "rebuild":{"type": ["object","null"]},
571 "type": ["object","null"],
573 # "type":{"type":"string", "enum":["SOFT"] }
575 # "minProperties": 1,
576 # "maxProperties": 1,
577 # "additionalProperties": False
582 "additionalProperties": False
585 network_new_schema
= {
586 "title": "network creation information schema",
587 "$schema": "http://json-schema.org/draft-04/schema#",
595 "type": {"type":"string", "enum": ["bridge_man", "bridge_data", "data", "ptp"]},
596 "shared": {"type": "boolean"},
597 "tenant_id": id_schema
,
598 "admin_state_up": {"type": "boolean"},
599 "provider:vlan": vlan_schema
,
600 "provider:physical": net_bind_schema
,
601 "region": nameshort_schema
,
603 "enable_dhcp": {"type": "boolean"},
604 "dhcp_first_ip": ip_schema
,
605 "dhcp_last_ip": ip_schema
,
606 "dns": {"type": "array", "items": [ip_schema
]},
607 "links": {"type": "array", "items": {"type": "object", "properties": {
609 "iface": name_schema
,
610 "vlan": vlan_schema
},
611 "required": ["iface"],
612 "additionalProperties": False
616 "routes": {"type": "object", "properties": {"default": ip_schema
}, "patternProperties": {
617 "^([0-9]{1,3}.){3}[0-9]{1,3}/[0-9]{1,2}$": ip_schema
,
619 "additionalProperties": False
622 "bind_net": name_schema
, # can be name, or uuid
623 "bind_type": {"oneOf": [{"type": "null"}, {"type": "string", "pattern": "^vlan:[0-9]{1,4}$"}]}
628 "required": ["network"],
629 "additionalProperties": False
632 network_update_schema
= {
633 "title":"network update information schema",
634 "$schema": "http://json-schema.org/draft-04/schema#",
641 "type":{"type":"string", "enum":["bridge_man","bridge_data","data", "ptp"]},
642 "shared":{"type":"boolean"},
643 "tenant_id":id_schema
,
644 "admin_state_up":{"type":"boolean"},
645 "provider:vlan":vlan_schema
,
646 "provider:physical":net_bind_schema
,
648 "enable_dhcp": {"type":"boolean"},
649 # "dhcp_first_ip": ip_schema,
650 # "dhcp_last_ip": ip_schema,
651 "bind_net":name_schema
, #can be name, or uuid
652 "bind_type":{"oneOf":[{"type":"null"},{"type":"string", "pattern":"^vlan:[0-9]{1,4}$"}]}
655 "additionalProperties": False
658 "required": ["network"],
659 "additionalProperties": False
664 "title":"port creation information schema",
665 "$schema": "http://json-schema.org/draft-04/schema#",
672 "name":nameshort_schema
,
673 "network_id":{"oneOf":[{"type": "null"}, id_schema
]},
674 "tenant_id":id_schema
,
675 "mac_address": {"oneOf":[{"type": "null"}, mac_schema
] },
676 "admin_state_up":{"type":"boolean"},
677 "bandwidth":bandwidth_schema
,
678 "binding:switch_port":nameshort_schema
,
679 "binding:vlan": {"oneOf":[{"type": "null"}, vlan_schema
]}
684 "required": ["port"],
685 "additionalProperties": False
688 port_update_schema
= {
689 "title":"port update information schema",
690 "$schema": "http://json-schema.org/draft-04/schema#",
696 "name":nameshort_schema
,
697 "network_id":{"anyOf":[{"type":"null"}, id_schema
] }
700 "additionalProperties": False
703 "required": ["port"],
704 "additionalProperties": False
708 "title":"localinfo information schema",
709 "$schema": "http://json-schema.org/draft-04/schema#",
712 "files":{ "type": "object"},
713 "inc_files":{ "type": "object"},
714 "server_files":{ "type": "object"}
716 "required": ["files"]
720 "title":"host information schema",
721 "$schema": "http://json-schema.org/draft-04/schema#",
726 "patternProperties":{
727 ".":{ "type": "string"}
732 "required": ["iface_names"]
735 openflow_controller_schema
= {
736 "title": "network creation information schema",
737 "$schema": "http://json-schema.org/draft-04/schema#",
744 "dpid": nameshort_schema
,
745 "ip": nameshort_schema
,
747 "type": nameshort_schema
,
748 "version": nametiny_schema
,
749 "user": nameshort_schema
,
750 "password": nameshort_schema
752 "required": ["dpid", "type", "ip", "port", "name"]
756 "additionalProperties": False
759 of_port_new_schema
= {
760 "title": "OF port mapping",
764 "region": nameshort_schema
,
765 "compute_node": nameshort_schema
,
767 "switch_dpid": nameshort_schema
,
768 "switch_port": nameshort_schema
,
769 "switch_mac": mac_schema
771 "required": ["region", "compute_node", "pci", "switch_dpid"]
774 of_port_map_new_schema
= {
775 "title": "OF port mapping",
776 "$schema": "http://json-schema.org/draft-04/schema#",
779 "of_port_mapings": {"type": "array", "items": of_port_new_schema
, "minLenght":1},
781 "required": ["of_port_mapings"],
782 "additionalProperties": False