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"]},
122 "patternProperties": {
123 "of_*" : {"type": ["string", "integer", "boolean"]}
125 "required": ['db_host', 'db_user', 'db_passwd', 'db_name',
126 'of_controller_ip', 'of_controller_port', 'of_controller_dpid', 'of_controller'],
127 "additionalProperties": False
135 "architecture": {"type":"string"},
136 "use_incremental": yes_no_schema
,
138 "os_distro": {"type":"string"},
139 "os_type": {"type":"string"},
140 "os_version": {"type":"string"},
141 "bus": {"type":"string"},
142 "topology": {"type":"string", "enum": ["oneSocket"]}
148 tenant_new_schema
= {
149 "title":"tenant creation information schema",
150 "$schema": "http://json-schema.org/draft-04/schema#",
157 "name": nameshort_schema
,
158 "description":description_schema
,
159 "enabled":{"type" : "boolean"}
164 "required": ["tenant"],
165 "additionalProperties": False
167 tenant_edit_schema
= {
168 "title":"tenant edition information schema",
169 "$schema": "http://json-schema.org/draft-04/schema#",
176 "name":nameshort_schema
,
177 "description":description_schema
,
178 "enabled":{"type" : "boolean"}
180 "additionalProperties": False,
183 "required": ["tenant"],
184 "additionalProperties": False
193 "dedicated":{"type":"string","enum":["yes","no","yes:sriov"]},
194 "bandwidth":bandwidth_schema
,
197 "mac_address":mac_schema
199 "additionalProperties": False,
200 "required": ["dedicated", "bandwidth"]
207 "processor_ranking":integer0_schema
,
213 "type":{"type":"string", "enum":["usb","disk","cdrom","xml"]},
215 "imageRef":id_schema
,
216 "xml":xml_text_schema
,
217 "dev":nameshort_schema
219 "additionalProperties": False,
228 "memory":integer1_schema
,
229 "cores":integer1_schema
,
230 "paired-threads":integer1_schema
,
231 "threads":integer1_schema
,
232 "cores-id":{"type":"array","items":integer0_schema
},
233 "paired-threads-id":{"type":"array","items":{"type":"array","minItems":2,"maxItems":2,"items":integer0_schema
}},
234 "threads-id":{"type":"array","items":integer0_schema
},
235 "interfaces":interfaces_schema
237 "additionalProperties": False,
239 #"required": ["memory"]
243 #"additionalProperties": False,
244 #"required": ["processor_ranking"]
248 "title":"hosts manual insertion information schema",
251 "ip_name":nameshort_schema
,
253 "description":description_schema
,
254 "user":nameshort_schema
,
255 "password":nameshort_schema
,
256 "features":description_schema
,
257 "ranking":integer0_schema
,
263 "type":{"type":"string", "enum":["usb","disk"]},
266 "additionalProperties": False,
276 "admin_state_up":{"type":"boolean"},
277 "hugepages":integer0_schema
,
284 "core_id":integer0_schema
,
285 "thread_id":integer0_schema
,
286 "status": {"type":"string", "enum":["noteligible"]}
288 "additionalProperties": False,
289 "required": ["core_id","thread_id"]
298 "source_name":nameshort_schema
,
300 "Mbps":integer0_schema
,
308 "source_name":{"oneOf":[integer0_schema
, nameshort_schema
]},
310 "vlan":integer0_schema
,
313 "additionalProperties": False,
314 "required": ["source_name","mac","pci"]
317 "switch_port": nameshort_schema
,
318 "switch_dpid": nameshort_schema
,
320 "additionalProperties": False,
321 "required": ["source_name","mac","Mbps","pci"]
324 "numa_socket":integer0_schema
,
325 "memory":integer1_schema
327 "additionalProperties": False,
328 "required": ["cores","numa_socket"]
332 "additionalProperties": False,
333 "required": ["ranking", "numas","ip_name","user"]
337 "title":"hosts creation information schema",
338 "$schema": "http://json-schema.org/draft-04/schema#",
344 "ip_name":nameshort_schema
,
346 "description":description_schema
,
347 "user":nameshort_schema
,
348 "password":nameshort_schema
,
349 "admin_state_up":{"type":"boolean"},
355 "numa_socket": integer0_schema
,
356 "admin_state_up":{"type":"boolean"},
362 "source_name": nameshort_schema
,
363 "switch_dpid": nameshort_schema
,
364 "switch_port": nameshort_schema
,
366 "required": ["source_name"],
370 "required": ["numa_socket"],
371 "additionalProperties": False,
376 "additionalProperties": False
379 "required": ["host"],
381 "additionalProperties": False
385 "title":"hosts creation information schema",
386 "$schema": "http://json-schema.org/draft-04/schema#",
393 "ip_name":nameshort_schema
,
395 "description":description_schema
,
396 "user":nameshort_schema
,
397 "password":nameshort_schema
,
398 "admin_state_up":{"type":"boolean"},
400 "required": ["name","ip_name","user"]
402 "host-data":host_data_schema
404 "required": ["host"],
407 "additionalProperties": False
411 flavor_new_schema
= {
412 "title":"flavor creation information schema",
413 "$schema": "http://json-schema.org/draft-04/schema#",
421 "description":description_schema
,
422 "ram":integer0_schema
,
423 "vcpus":integer0_schema
,
424 "extended": extended_schema
,
425 "public": yes_no_schema
430 "required": ["flavor"],
431 "additionalProperties": False
433 flavor_update_schema
= {
434 "title":"flavor update information schema",
435 "$schema": "http://json-schema.org/draft-04/schema#",
442 "description":description_schema
,
443 "ram":integer0_schema
,
444 "vcpus":integer0_schema
,
445 "extended": extended_schema
,
446 "public": yes_no_schema
449 "additionalProperties": False
452 "required": ["flavor"],
453 "additionalProperties": False
457 "title":"image creation information schema",
458 "$schema": "http://json-schema.org/draft-04/schema#",
465 "path": {"oneOf": [path_schema
, http_schema
]},
466 "description":description_schema
,
468 "metadata":metadata_schema
,
469 "public": yes_no_schema
471 "required": ["name","path"]
474 "required": ["image"],
475 "additionalProperties": False
478 image_update_schema
= {
479 "title":"image update information schema",
480 "$schema": "http://json-schema.org/draft-04/schema#",
486 "path":{"oneOf": [path_schema
, http_schema
]},
487 "description":description_schema
,
489 "metadata":metadata_schema
,
490 "public": yes_no_schema
493 "additionalProperties": False
496 "required": ["image"],
497 "additionalProperties": False
506 "bandwidth":bandwidth_schema
,
509 "mac_address": mac_schema
,
510 "model": {"type":"string", "enum":["virtio","e1000","ne2k_pci","pcnet","rtl8139"]},
511 "type": {"type":"string", "enum":["virtual","PF","VF","VFnotShared"]}
513 "additionalProperties": False,
518 server_new_schema
= {
519 "title":"server creation information schema",
520 "$schema": "http://json-schema.org/draft-04/schema#",
528 "description":description_schema
,
529 "start":{"type":"string", "enum":["yes","no","paused"]},
531 "flavorRef":id_schema
,
532 "imageRef":id_schema
,
533 "extended": extended_schema
,
534 "networks":networks_schema
536 "required": ["name","flavorRef","imageRef"]
539 "required": ["server"],
540 "additionalProperties": False
543 server_action_schema
= {
544 "title":"server action information schema",
545 "$schema": "http://json-schema.org/draft-04/schema#",
548 "start":{"oneOf":[{"type": "null"}, {"type":"string", "enum":["rebuild","null"] }]},
549 "pause":{"type": "null"},
550 "resume":{"type": "null"},
551 "shutoff":{"type": "null"},
552 "shutdown":{"type": "null"},
553 "forceOff":{"type": "null"},
554 "terminate":{"type": "null"},
559 "description":description_schema
,
561 "metadata":metadata_schema
,
562 "imageRef": id_schema
,
563 "disk": {"oneOf":[{"type": "null"}, {"type":"string"}] },
567 "rebuild":{"type": ["object","null"]},
569 "type": ["object","null"],
571 # "type":{"type":"string", "enum":["SOFT"] }
573 # "minProperties": 1,
574 # "maxProperties": 1,
575 # "additionalProperties": False
580 "additionalProperties": False
583 network_new_schema
= {
584 "title":"network creation information schema",
585 "$schema": "http://json-schema.org/draft-04/schema#",
593 "type":{"type":"string", "enum":["bridge_man","bridge_data","data", "ptp"]},
594 "shared":{"type":"boolean"},
595 "tenant_id":id_schema
,
596 "admin_state_up":{"type":"boolean"},
597 "provider:vlan":vlan_schema
,
598 "provider:physical":net_bind_schema
,
600 "enable_dhcp": {"type":"boolean"},
601 "dhcp_first_ip": ip_schema
,
602 "dhcp_last_ip": ip_schema
,
603 "bind_net":name_schema
, #can be name, or uuid
604 "bind_type":{"oneOf":[{"type":"null"},{"type":"string", "pattern":"^vlan:[0-9]{1,4}$"}]}
609 "required": ["network"],
610 "additionalProperties": False
612 network_update_schema
= {
613 "title":"network update information schema",
614 "$schema": "http://json-schema.org/draft-04/schema#",
621 "type":{"type":"string", "enum":["bridge_man","bridge_data","data", "ptp"]},
622 "shared":{"type":"boolean"},
623 "tenant_id":id_schema
,
624 "admin_state_up":{"type":"boolean"},
625 "provider:vlan":vlan_schema
,
626 "provider:physical":net_bind_schema
,
628 "enable_dhcp": {"type":"boolean"},
629 "dhcp_first_ip": ip_schema
,
630 "dhcp_last_ip": ip_schema
,
631 "bind_net":name_schema
, #can be name, or uuid
632 "bind_type":{"oneOf":[{"type":"null"},{"type":"string", "pattern":"^vlan:[0-9]{1,4}$"}]}
635 "additionalProperties": False
638 "required": ["network"],
639 "additionalProperties": False
644 "title":"port creation information schema",
645 "$schema": "http://json-schema.org/draft-04/schema#",
652 "name":nameshort_schema
,
653 "network_id":{"oneOf":[{"type": "null"}, id_schema
]},
654 "tenant_id":id_schema
,
655 "mac_address": {"oneOf":[{"type": "null"}, mac_schema
] },
656 "admin_state_up":{"type":"boolean"},
657 "bandwidth":bandwidth_schema
,
658 "binding:switch_port":nameshort_schema
,
659 "binding:vlan": {"oneOf":[{"type": "null"}, vlan_schema
]}
664 "required": ["port"],
665 "additionalProperties": False
668 port_update_schema
= {
669 "title":"port update information schema",
670 "$schema": "http://json-schema.org/draft-04/schema#",
676 "name":nameshort_schema
,
677 "network_id":{"anyOf":[{"type":"null"}, id_schema
] }
680 "additionalProperties": False
683 "required": ["port"],
684 "additionalProperties": False
688 "title":"localinfo information schema",
689 "$schema": "http://json-schema.org/draft-04/schema#",
692 "files":{ "type": "object"},
693 "inc_files":{ "type": "object"},
694 "server_files":{ "type": "object"}
696 "required": ["files"]
700 "title":"host information schema",
701 "$schema": "http://json-schema.org/draft-04/schema#",
706 "patternProperties":{
707 ".":{ "type": "string"}
712 "required": ["iface_names"]