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", "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
,
83 "network_vlan_range_start": vlan_schema
,
84 "network_vlan_range_end": vlan_schema
,
87 "patternProperties": {
90 "items": integer0_schema
,
100 "host" : name_schema
,
101 "port" : port_schema
,
102 "provider" : {"type": "string", "enum": ["isc-dhcp-server"]},
103 "user" : nameshort_schema
,
104 "password" : {"type": "string"},
105 "key" : {"type": "string"},
108 "items": nameshort_schema
,
112 "items": name_schema
,
115 "required": ['host', 'provider', 'user']
117 "log_level": log_level_schema
,
118 "log_level_db": log_level_schema
,
119 "log_level_of": log_level_schema
,
120 "network_type": {"type": "string", "enum": ["ovs", "bridge"]},
121 "ovs_controller_file_path": path_schema
,
122 "ovs_controller_user": nameshort_schema
,
124 "ovs_controller_ip": nameshort_schema
126 "patternProperties": {
127 "of_*" : {"type": ["string", "integer", "boolean"]}
129 "required": ['db_host', 'db_user', 'db_passwd', 'db_name'],
130 "additionalProperties": False
138 "architecture": {"type":"string"},
139 "use_incremental": yes_no_schema
,
141 "os_distro": {"type":"string"},
142 "os_type": {"type":"string"},
143 "os_version": {"type":"string"},
144 "bus": {"type":"string"},
145 "topology": {"type":"string", "enum": ["oneSocket"]}
149 tenant_new_schema
= {
150 "title":"tenant creation information schema",
151 "$schema": "http://json-schema.org/draft-04/schema#",
158 "name": nameshort_schema
,
159 "description":description_schema
,
160 "enabled":{"type" : "boolean"}
165 "required": ["tenant"],
166 "additionalProperties": False
169 tenant_edit_schema
= {
170 "title":"tenant edition information schema",
171 "$schema": "http://json-schema.org/draft-04/schema#",
178 "name":nameshort_schema
,
179 "description":description_schema
,
180 "enabled":{"type" : "boolean"}
182 "additionalProperties": False,
185 "required": ["tenant"],
186 "additionalProperties": False
195 "dedicated":{"type":"string","enum":["yes","no","yes:sriov"]},
196 "bandwidth":bandwidth_schema
,
199 "mac_address":mac_schema
201 "additionalProperties": False,
202 "required": ["dedicated", "bandwidth"]
209 "processor_ranking":integer0_schema
,
215 "type":{"type":"string", "enum":["usb","disk","cdrom","xml"]},
217 "imageRef":id_schema
,
218 "xml":xml_text_schema
,
219 "dev":nameshort_schema
221 "additionalProperties": False,
230 "memory":integer1_schema
,
231 "cores":integer1_schema
,
232 "paired-threads":integer1_schema
,
233 "threads":integer1_schema
,
234 "cores-id":{"type":"array","items":integer0_schema
},
235 "paired-threads-id":{"type":"array","items":{"type":"array","minItems":2,"maxItems":2,"items":integer0_schema
}},
236 "threads-id":{"type":"array","items":integer0_schema
},
237 "interfaces":interfaces_schema
239 "additionalProperties": False,
241 #"required": ["memory"]
245 #"additionalProperties": False,
246 #"required": ["processor_ranking"]
250 "title":"hosts manual insertion information schema",
253 "ip_name":nameshort_schema
,
255 "description":description_schema
,
256 "user":nameshort_schema
,
257 "password":nameshort_schema
,
258 "features":description_schema
,
259 "ranking":integer0_schema
,
265 "type":{"type":"string", "enum":["usb","disk"]},
268 "additionalProperties": False,
278 "admin_state_up":{"type":"boolean"},
279 "hugepages":integer0_schema
,
286 "core_id":integer0_schema
,
287 "thread_id":integer0_schema
,
288 "status": {"type":"string", "enum":["noteligible"]}
290 "additionalProperties": False,
291 "required": ["core_id","thread_id"]
300 "source_name":nameshort_schema
,
302 "Mbps":integer0_schema
,
310 "source_name":{"oneOf":[integer0_schema
, nameshort_schema
]},
312 "vlan":integer0_schema
,
315 "additionalProperties": False,
316 "required": ["source_name","mac","pci"]
319 "switch_port": nameshort_schema
,
320 "switch_dpid": nameshort_schema
,
322 "additionalProperties": False,
323 "required": ["source_name","mac","Mbps","pci"]
326 "numa_socket":integer0_schema
,
327 "memory":integer1_schema
329 "additionalProperties": False,
330 "required": ["cores","numa_socket"]
334 "additionalProperties": False,
335 "required": ["ranking", "numas","ip_name","user"]
339 "title":"hosts creation information schema",
340 "$schema": "http://json-schema.org/draft-04/schema#",
346 "ip_name":nameshort_schema
,
348 "description":description_schema
,
349 "user":nameshort_schema
,
350 "password":nameshort_schema
,
351 "admin_state_up":{"type":"boolean"},
357 "numa_socket": integer0_schema
,
358 "admin_state_up":{"type":"boolean"},
364 "source_name": nameshort_schema
,
365 "switch_dpid": nameshort_schema
,
366 "switch_port": nameshort_schema
,
368 "required": ["source_name"],
372 "required": ["numa_socket"],
373 "additionalProperties": False,
378 "additionalProperties": False
381 "required": ["host"],
383 "additionalProperties": False
387 "title":"hosts creation information schema",
388 "$schema": "http://json-schema.org/draft-04/schema#",
395 "ip_name":nameshort_schema
,
397 "description":description_schema
,
398 "user":nameshort_schema
,
399 "password":nameshort_schema
,
400 "admin_state_up":{"type":"boolean"},
402 "required": ["name","ip_name","user"]
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
,
602 "enable_dhcp": {"type":"boolean"},
603 "dhcp_first_ip": ip_schema
,
604 "dhcp_last_ip": ip_schema
,
605 "bind_net":name_schema
, #can be name, or uuid
606 "bind_type":{"oneOf":[{"type":"null"},{"type":"string", "pattern":"^vlan:[0-9]{1,4}$"}]}
611 "required": ["network"],
612 "additionalProperties": False
615 network_update_schema
= {
616 "title":"network update information schema",
617 "$schema": "http://json-schema.org/draft-04/schema#",
624 "type":{"type":"string", "enum":["bridge_man","bridge_data","data", "ptp"]},
625 "shared":{"type":"boolean"},
626 "tenant_id":id_schema
,
627 "admin_state_up":{"type":"boolean"},
628 "provider:vlan":vlan_schema
,
629 "provider:physical":net_bind_schema
,
631 "enable_dhcp": {"type":"boolean"},
632 # "dhcp_first_ip": ip_schema,
633 # "dhcp_last_ip": ip_schema,
634 "bind_net":name_schema
, #can be name, or uuid
635 "bind_type":{"oneOf":[{"type":"null"},{"type":"string", "pattern":"^vlan:[0-9]{1,4}$"}]}
638 "additionalProperties": False
641 "required": ["network"],
642 "additionalProperties": False
647 "title":"port creation information schema",
648 "$schema": "http://json-schema.org/draft-04/schema#",
655 "name":nameshort_schema
,
656 "network_id":{"oneOf":[{"type": "null"}, id_schema
]},
657 "tenant_id":id_schema
,
658 "mac_address": {"oneOf":[{"type": "null"}, mac_schema
] },
659 "admin_state_up":{"type":"boolean"},
660 "bandwidth":bandwidth_schema
,
661 "binding:switch_port":nameshort_schema
,
662 "binding:vlan": {"oneOf":[{"type": "null"}, vlan_schema
]}
667 "required": ["port"],
668 "additionalProperties": False
671 port_update_schema
= {
672 "title":"port update information schema",
673 "$schema": "http://json-schema.org/draft-04/schema#",
679 "name":nameshort_schema
,
680 "network_id":{"anyOf":[{"type":"null"}, id_schema
] }
683 "additionalProperties": False
686 "required": ["port"],
687 "additionalProperties": False
691 "title":"localinfo information schema",
692 "$schema": "http://json-schema.org/draft-04/schema#",
695 "files":{ "type": "object"},
696 "inc_files":{ "type": "object"},
697 "server_files":{ "type": "object"}
699 "required": ["files"]
703 "title":"host information schema",
704 "$schema": "http://json-schema.org/draft-04/schema#",
709 "patternProperties":{
710 ".":{ "type": "string"}
715 "required": ["iface_names"]
718 openflow_controller_schema
= {
719 "title": "network creation information schema",
720 "$schema": "http://json-schema.org/draft-04/schema#",
727 "dpid": nameshort_schema
,
728 "ip": nameshort_schema
,
730 "type": nameshort_schema
,
731 "version": nametiny_schema
,
732 "user": nameshort_schema
,
733 "password": nameshort_schema
735 "required": ["dpid", "type", "ip", "port", "name"]
739 "additionalProperties": False
742 of_port_new_schema
= {
743 "title": "OF port mapping",
747 "region": nameshort_schema
,
748 "compute_node": nameshort_schema
,
750 "switch_dpid": nameshort_schema
,
751 "switch_port": nameshort_schema
,
752 "switch_mac": mac_schema
754 "required": ["region", "compute_node", "pci", "switch_dpid"]
757 of_port_map_new_schema
= {
758 "title": "OF port mapping",
759 "$schema": "http://json-schema.org/draft-04/schema#",
762 "of_port_mapings": {"type": "array", "items": of_port_new_schema
, "minLenght":1},
764 "required": ["of_port_mapings"],
765 "additionalProperties": False