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
168 tenant_edit_schema
= {
169 "title":"tenant edition information schema",
170 "$schema": "http://json-schema.org/draft-04/schema#",
177 "name":nameshort_schema
,
178 "description":description_schema
,
179 "enabled":{"type" : "boolean"}
181 "additionalProperties": False,
184 "required": ["tenant"],
185 "additionalProperties": False
194 "dedicated":{"type":"string","enum":["yes","no","yes:sriov"]},
195 "bandwidth":bandwidth_schema
,
198 "mac_address":mac_schema
200 "additionalProperties": False,
201 "required": ["dedicated", "bandwidth"]
208 "processor_ranking":integer0_schema
,
214 "type":{"type":"string", "enum":["usb","disk","cdrom","xml"]},
216 "imageRef":id_schema
,
217 "xml":xml_text_schema
,
218 "dev":nameshort_schema
220 "additionalProperties": False,
229 "memory":integer1_schema
,
230 "cores":integer1_schema
,
231 "paired-threads":integer1_schema
,
232 "threads":integer1_schema
,
233 "cores-id":{"type":"array","items":integer0_schema
},
234 "paired-threads-id":{"type":"array","items":{"type":"array","minItems":2,"maxItems":2,"items":integer0_schema
}},
235 "threads-id":{"type":"array","items":integer0_schema
},
236 "interfaces":interfaces_schema
238 "additionalProperties": False,
240 #"required": ["memory"]
244 #"additionalProperties": False,
245 #"required": ["processor_ranking"]
249 "title":"hosts manual insertion information schema",
252 "ip_name":nameshort_schema
,
254 "description":description_schema
,
255 "user":nameshort_schema
,
256 "password":nameshort_schema
,
257 "features":description_schema
,
258 "ranking":integer0_schema
,
264 "type":{"type":"string", "enum":["usb","disk"]},
267 "additionalProperties": False,
277 "admin_state_up":{"type":"boolean"},
278 "hugepages":integer0_schema
,
285 "core_id":integer0_schema
,
286 "thread_id":integer0_schema
,
287 "status": {"type":"string", "enum":["noteligible"]}
289 "additionalProperties": False,
290 "required": ["core_id","thread_id"]
299 "source_name":nameshort_schema
,
301 "Mbps":integer0_schema
,
309 "source_name":{"oneOf":[integer0_schema
, nameshort_schema
]},
311 "vlan":integer0_schema
,
314 "additionalProperties": False,
315 "required": ["source_name","mac","pci"]
318 "switch_port": nameshort_schema
,
319 "switch_dpid": nameshort_schema
,
321 "additionalProperties": False,
322 "required": ["source_name","mac","Mbps","pci"]
325 "numa_socket":integer0_schema
,
326 "memory":integer1_schema
328 "additionalProperties": False,
329 "required": ["cores","numa_socket"]
333 "additionalProperties": False,
334 "required": ["ranking", "numas","ip_name","user"]
338 "title":"hosts creation information schema",
339 "$schema": "http://json-schema.org/draft-04/schema#",
345 "ip_name":nameshort_schema
,
347 "description":description_schema
,
348 "user":nameshort_schema
,
349 "password":nameshort_schema
,
350 "admin_state_up":{"type":"boolean"},
356 "numa_socket": integer0_schema
,
357 "admin_state_up":{"type":"boolean"},
363 "source_name": nameshort_schema
,
364 "switch_dpid": nameshort_schema
,
365 "switch_port": nameshort_schema
,
367 "required": ["source_name"],
371 "required": ["numa_socket"],
372 "additionalProperties": False,
377 "additionalProperties": False
380 "required": ["host"],
382 "additionalProperties": False
386 "title":"hosts creation information schema",
387 "$schema": "http://json-schema.org/draft-04/schema#",
394 "ip_name":nameshort_schema
,
396 "description":description_schema
,
397 "user":nameshort_schema
,
398 "password":nameshort_schema
,
399 "admin_state_up":{"type":"boolean"},
401 "required": ["name","ip_name","user"]
403 "host-data":host_data_schema
405 "required": ["host"],
408 "additionalProperties": False
412 flavor_new_schema
= {
413 "title":"flavor creation information schema",
414 "$schema": "http://json-schema.org/draft-04/schema#",
422 "description":description_schema
,
423 "ram":integer0_schema
,
424 "vcpus":integer0_schema
,
425 "extended": extended_schema
,
426 "public": yes_no_schema
431 "required": ["flavor"],
432 "additionalProperties": False
434 flavor_update_schema
= {
435 "title":"flavor update information schema",
436 "$schema": "http://json-schema.org/draft-04/schema#",
443 "description":description_schema
,
444 "ram":integer0_schema
,
445 "vcpus":integer0_schema
,
446 "extended": extended_schema
,
447 "public": yes_no_schema
450 "additionalProperties": False
453 "required": ["flavor"],
454 "additionalProperties": False
458 "title":"image creation information schema",
459 "$schema": "http://json-schema.org/draft-04/schema#",
466 "path": {"oneOf": [path_schema
, http_schema
]},
467 "description":description_schema
,
469 "metadata":metadata_schema
,
470 "public": yes_no_schema
472 "required": ["name","path"]
475 "required": ["image"],
476 "additionalProperties": False
479 image_update_schema
= {
480 "title":"image update information schema",
481 "$schema": "http://json-schema.org/draft-04/schema#",
487 "path":{"oneOf": [path_schema
, http_schema
]},
488 "description":description_schema
,
490 "metadata":metadata_schema
,
491 "public": yes_no_schema
494 "additionalProperties": False
497 "required": ["image"],
498 "additionalProperties": False
507 "bandwidth":bandwidth_schema
,
510 "mac_address": mac_schema
,
511 "model": {"type":"string", "enum":["virtio","e1000","ne2k_pci","pcnet","rtl8139"]},
512 "type": {"type":"string", "enum":["virtual","PF","VF","VFnotShared"]}
514 "additionalProperties": False,
519 server_new_schema
= {
520 "title":"server creation information schema",
521 "$schema": "http://json-schema.org/draft-04/schema#",
529 "description":description_schema
,
530 "start":{"type":"string", "enum":["yes","no","paused"]},
532 "flavorRef":id_schema
,
533 "imageRef":id_schema
,
534 "extended": extended_schema
,
535 "networks":networks_schema
537 "required": ["name","flavorRef","imageRef"]
540 "required": ["server"],
541 "additionalProperties": False
544 server_action_schema
= {
545 "title":"server action information schema",
546 "$schema": "http://json-schema.org/draft-04/schema#",
549 "start":{"oneOf":[{"type": "null"}, {"type":"string", "enum":["rebuild","null"] }]},
550 "pause":{"type": "null"},
551 "resume":{"type": "null"},
552 "shutoff":{"type": "null"},
553 "shutdown":{"type": "null"},
554 "forceOff":{"type": "null"},
555 "terminate":{"type": "null"},
560 "description":description_schema
,
562 "metadata":metadata_schema
,
563 "imageRef": id_schema
,
564 "disk": {"oneOf":[{"type": "null"}, {"type":"string"}] },
568 "rebuild":{"type": ["object","null"]},
570 "type": ["object","null"],
572 # "type":{"type":"string", "enum":["SOFT"] }
574 # "minProperties": 1,
575 # "maxProperties": 1,
576 # "additionalProperties": False
581 "additionalProperties": False
584 network_new_schema
= {
585 "title":"network creation information schema",
586 "$schema": "http://json-schema.org/draft-04/schema#",
594 "type":{"type":"string", "enum":["bridge_man","bridge_data","data", "ptp"]},
595 "shared":{"type":"boolean"},
596 "tenant_id":id_schema
,
597 "admin_state_up":{"type":"boolean"},
598 "provider:vlan":vlan_schema
,
599 "provider:physical":net_bind_schema
,
601 "enable_dhcp": {"type":"boolean"},
602 "dhcp_first_ip": ip_schema
,
603 "dhcp_last_ip": ip_schema
,
604 "bind_net":name_schema
, #can be name, or uuid
605 "bind_type":{"oneOf":[{"type":"null"},{"type":"string", "pattern":"^vlan:[0-9]{1,4}$"}]}
610 "required": ["network"],
611 "additionalProperties": False
614 network_update_schema
= {
615 "title":"network update information schema",
616 "$schema": "http://json-schema.org/draft-04/schema#",
623 "type":{"type":"string", "enum":["bridge_man","bridge_data","data", "ptp"]},
624 "shared":{"type":"boolean"},
625 "tenant_id":id_schema
,
626 "admin_state_up":{"type":"boolean"},
627 "provider:vlan":vlan_schema
,
628 "provider:physical":net_bind_schema
,
630 "enable_dhcp": {"type":"boolean"},
631 # "dhcp_first_ip": ip_schema,
632 # "dhcp_last_ip": ip_schema,
633 "bind_net":name_schema
, #can be name, or uuid
634 "bind_type":{"oneOf":[{"type":"null"},{"type":"string", "pattern":"^vlan:[0-9]{1,4}$"}]}
637 "additionalProperties": False
640 "required": ["network"],
641 "additionalProperties": False
646 "title":"port creation information schema",
647 "$schema": "http://json-schema.org/draft-04/schema#",
654 "name":nameshort_schema
,
655 "network_id":{"oneOf":[{"type": "null"}, id_schema
]},
656 "tenant_id":id_schema
,
657 "mac_address": {"oneOf":[{"type": "null"}, mac_schema
] },
658 "admin_state_up":{"type":"boolean"},
659 "bandwidth":bandwidth_schema
,
660 "binding:switch_port":nameshort_schema
,
661 "binding:vlan": {"oneOf":[{"type": "null"}, vlan_schema
]}
666 "required": ["port"],
667 "additionalProperties": False
670 port_update_schema
= {
671 "title":"port update information schema",
672 "$schema": "http://json-schema.org/draft-04/schema#",
678 "name":nameshort_schema
,
679 "network_id":{"anyOf":[{"type":"null"}, id_schema
] }
682 "additionalProperties": False
685 "required": ["port"],
686 "additionalProperties": False
690 "title":"localinfo information schema",
691 "$schema": "http://json-schema.org/draft-04/schema#",
694 "files":{ "type": "object"},
695 "inc_files":{ "type": "object"},
696 "server_files":{ "type": "object"}
698 "required": ["files"]
702 "title":"host information schema",
703 "$schema": "http://json-schema.org/draft-04/schema#",
708 "patternProperties":{
709 ".":{ "type": "string"}
714 "required": ["iface_names"]
717 openflow_controller_schema
= {
718 "title": "network creation information schema",
719 "$schema": "http://json-schema.org/draft-04/schema#",
726 "dpid": nameshort_schema
,
727 "ip": nameshort_schema
,
729 "type": nameshort_schema
,
730 "version": nametiny_schema
,
731 "user": nameshort_schema
,
732 "password": nameshort_schema
734 "required": ["dpid", "type", "ip", "port", "name"]
738 "additionalProperties": False