Feature 10904: Make all deployment methods optional for K8s cluster
[osm/NBI.git] / osm_nbi / validation.py
1 # -*- coding: utf-8 -*-
2
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
6 #
7 # http://www.apache.org/licenses/LICENSE-2.0
8 #
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
12 # implied.
13 # See the License for the specific language governing permissions and
14 # limitations under the License.
15
16 from jsonschema import validate as js_v, exceptions as js_e
17 from http import HTTPStatus
18 from copy import deepcopy
19 from uuid import UUID # To test for valid UUID
20
21 __author__ = "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
22 __version__ = "0.1"
23 version_date = "Mar 2018"
24
25 """
26 Validator of input data using JSON schemas for those items that not contains an OSM yang information model
27 """
28
29 # Basis schemas
30 patern_name = "^[ -~]+$"
31 shortname_schema = {
32 "type": "string",
33 "minLength": 1,
34 "maxLength": 60,
35 "pattern": "^[^,;()\\.\\$'\"]+$",
36 }
37 passwd_schema = {"type": "string", "minLength": 1, "maxLength": 60}
38 name_schema = {
39 "type": "string",
40 "minLength": 1,
41 "maxLength": 255,
42 "pattern": "^[^,;()'\"]+$",
43 }
44 string_schema = {"type": "string", "minLength": 1, "maxLength": 255}
45 xml_text_schema = {
46 "type": "string",
47 "minLength": 1,
48 "maxLength": 1000,
49 "pattern": "^[^']+$",
50 }
51 description_schema = {
52 "type": ["string", "null"],
53 "maxLength": 255,
54 "pattern": "^[^'\"]+$",
55 }
56 long_description_schema = {
57 "type": ["string", "null"],
58 "maxLength": 3000,
59 "pattern": "^[^'\"]+$",
60 }
61 id_schema_fake = {"type": "string", "minLength": 2, "maxLength": 36}
62 bool_schema = {"type": "boolean"}
63 null_schema = {"type": "null"}
64 # "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}$"
65 id_schema = {
66 "type": "string",
67 "pattern": "^[a-fA-F0-9]{8}(-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}$",
68 }
69 time_schema = {
70 "type": "string",
71 "pattern": "^[0-9]{4}-[0-1][0-9]-[0-3][0-9]T[0-2][0-9]([0-5]:){2}",
72 }
73 pci_schema = {
74 "type": "string",
75 "pattern": "^[0-9a-fA-F]{4}(:[0-9a-fA-F]{2}){2}\\.[0-9a-fA-F]$",
76 }
77 # allows [] for wildcards. For that reason huge length limit is set
78 pci_extended_schema = {"type": "string", "pattern": "^[0-9a-fA-F.:-\\[\\]]{12,40}$"}
79 http_schema = {"type": "string", "pattern": "^(https?|http)://[^'\"=]+$"}
80 bandwidth_schema = {"type": "string", "pattern": "^[0-9]+ *([MG]bps)?$"}
81 memory_schema = {"type": "string", "pattern": "^[0-9]+ *([MG]i?[Bb])?$"}
82 integer0_schema = {"type": "integer", "minimum": 0}
83 integer1_schema = {"type": "integer", "minimum": 1}
84 path_schema = {"type": "string", "pattern": "^(\\.){0,2}(/[^/\"':{}\\(\\)]+)+$"}
85 vlan_schema = {"type": "integer", "minimum": 1, "maximum": 4095}
86 vlan1000_schema = {"type": "integer", "minimum": 1000, "maximum": 4095}
87 mac_schema = {
88 "type": "string",
89 "pattern": "^[0-9a-fA-F][02468aceACE](:[0-9a-fA-F]{2}){5}$",
90 } # must be unicast: LSB bit of MSB byte ==0
91 dpid_Schema = {"type": "string", "pattern": "^[0-9a-fA-F]{2}(:[0-9a-fA-F]{2}){7}$"}
92 # mac_schema={"type":"string", "pattern":"^([0-9a-fA-F]{2}:){5}[0-9a-fA-F]{2}$"}
93 ip_schema = {
94 "type": "string",
95 "pattern": "^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$",
96 }
97 ipv6_schema = {
98 "type": "string",
99 "pattern": "(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))",
100 }
101 ip_prefix_schema = {
102 "type": "string",
103 "pattern": "^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}"
104 "(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)/(30|[12]?[0-9])$",
105 }
106 port_schema = {"type": "integer", "minimum": 1, "maximum": 65534}
107 object_schema = {"type": "object"}
108 schema_version_2 = {"type": "integer", "minimum": 2, "maximum": 2}
109 # schema_version_string={"type":"string","enum": ["0.1", "2", "0.2", "3", "0.3"]}
110 log_level_schema = {
111 "type": "string",
112 "enum": ["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"],
113 }
114 checksum_schema = {"type": "string", "pattern": "^[0-9a-fA-F]{32}$"}
115 size_schema = {"type": "integer", "minimum": 1, "maximum": 100}
116 array_edition_schema = {
117 "type": "object",
118 "patternProperties": {"^\\$": {}},
119 "additionalProperties": False,
120 "minProperties": 1,
121 }
122 nameshort_list_schema = {
123 "type": "array",
124 "minItems": 1,
125 "items": shortname_schema,
126 }
127
128 description_list_schema = {
129 "type": "array",
130 "minItems": 1,
131 "items": description_schema,
132 }
133
134 ns_instantiate_vdu = {
135 "title": "ns action instantiate input schema for vdu",
136 "$schema": "http://json-schema.org/draft-04/schema#",
137 "type": "object",
138 "properties": {
139 "id": name_schema,
140 "volume": {
141 "type": "array",
142 "minItems": 1,
143 "items": {
144 "type": "object",
145 "properties": {
146 "name": name_schema,
147 "vim-volume-id": name_schema,
148 },
149 "required": ["name", "vim-volume-id"],
150 "additionalProperties": False,
151 },
152 },
153 "interface": {
154 "type": "array",
155 "minItems": 1,
156 "items": {
157 "type": "object",
158 "properties": {
159 "name": name_schema,
160 "ip-address": ip_schema,
161 "mac-address": mac_schema,
162 "floating-ip-required": bool_schema,
163 },
164 "required": ["name"],
165 "additionalProperties": False,
166 },
167 },
168 },
169 "required": ["id"],
170 "additionalProperties": False,
171 }
172
173 ip_profile_dns_schema = {
174 "type": "array",
175 "minItems": 1,
176 "items": {
177 "type": "object",
178 "properties": {
179 "address": ip_schema,
180 },
181 "required": ["address"],
182 "additionalProperties": False,
183 },
184 }
185
186 ip_profile_dhcp_schema = {
187 "type": "object",
188 "properties": {
189 "enabled": {"type": "boolean"},
190 "count": integer1_schema,
191 "start-address": ip_schema,
192 },
193 "additionalProperties": False,
194 }
195
196 ip_profile_schema = {
197 "title": "ip profile validation schema",
198 "$schema": "http://json-schema.org/draft-04/schema#",
199 "type": "object",
200 "properties": {
201 "ip-version": {"enum": ["ipv4", "ipv6"]},
202 "subnet-address": ip_prefix_schema,
203 "gateway-address": ip_schema,
204 "dns-server": ip_profile_dns_schema,
205 "dhcp-params": ip_profile_dhcp_schema,
206 },
207 }
208
209 ip_profile_update_schema = {
210 "title": "ip profile validation schema",
211 "$schema": "http://json-schema.org/draft-04/schema#",
212 "type": "object",
213 "properties": {
214 "ip-version": {"enum": ["ipv4", "ipv6"]},
215 "subnet-address": {"oneOf": [null_schema, ip_prefix_schema]},
216 "gateway-address": {"oneOf": [null_schema, ip_schema]},
217 "dns-server": {"oneOf": [null_schema, ip_profile_dns_schema]},
218 "dhcp-params": {"oneOf": [null_schema, ip_profile_dhcp_schema]},
219 },
220 "additionalProperties": False,
221 }
222
223 provider_network_schema = {
224 "title": "provider network validation schema",
225 "$schema": "http://json-schema.org/draft-04/schema#",
226 "type": "object",
227 "properties": {
228 "physical-network": name_schema,
229 "segmentation-id": name_schema,
230 "sdn-ports": { # external ports to append to the SDN-assist network
231 "type": "array",
232 "items": {
233 "type": "object",
234 "properties": {
235 "switch_id": shortname_schema,
236 "switch_port": shortname_schema,
237 "mac_address": mac_schema,
238 "vlan": vlan_schema,
239 },
240 "additionalProperties": True,
241 },
242 },
243 "network-type": shortname_schema,
244 },
245 "additionalProperties": True,
246 }
247
248 ns_instantiate_internal_vld = {
249 "title": "ns action instantiate input schema for vdu",
250 "$schema": "http://json-schema.org/draft-04/schema#",
251 "type": "object",
252 "properties": {
253 "name": name_schema,
254 "vim-network-name": name_schema,
255 "vim-network-id": name_schema,
256 "ip-profile": ip_profile_update_schema,
257 "provider-network": provider_network_schema,
258 "internal-connection-point": {
259 "type": "array",
260 "minItems": 1,
261 "items": {
262 "type": "object",
263 "properties": {
264 "id-ref": name_schema,
265 "ip-address": ip_schema,
266 # "mac-address": mac_schema,
267 },
268 "required": ["id-ref"],
269 "minProperties": 2,
270 "additionalProperties": False,
271 },
272 },
273 },
274 "required": ["name"],
275 "minProperties": 2,
276 "additionalProperties": False,
277 }
278
279 additional_params_for_vnf = {
280 "type": "array",
281 "items": {
282 "type": "object",
283 "properties": {
284 "member-vnf-index": name_schema,
285 "additionalParams": object_schema,
286 "k8s-namespace": name_schema,
287 "config-units": integer1_schema, # number of configuration units of this vnf, by default 1
288 "additionalParamsForVdu": {
289 "type": "array",
290 "items": {
291 "type": "object",
292 "properties": {
293 "vdu_id": name_schema,
294 "additionalParams": object_schema,
295 "config-units": integer1_schema, # number of configuration units of this vdu, by default 1
296 },
297 "required": ["vdu_id"],
298 "minProperties": 2,
299 "additionalProperties": False,
300 },
301 },
302 "additionalParamsForKdu": {
303 "type": "array",
304 "items": {
305 "type": "object",
306 "properties": {
307 "kdu_name": name_schema,
308 "additionalParams": object_schema,
309 "kdu_model": name_schema,
310 "k8s-namespace": name_schema,
311 "config-units": integer1_schema, # number of configuration units of this knf, by default 1
312 "kdu-deployment-name": name_schema,
313 },
314 "required": ["kdu_name"],
315 "minProperties": 2,
316 "additionalProperties": False,
317 },
318 },
319 },
320 "required": ["member-vnf-index"],
321 "minProperties": 2,
322 "additionalProperties": False,
323 },
324 }
325
326 ns_instantiate = {
327 "title": "ns action instantiate input schema",
328 "$schema": "http://json-schema.org/draft-04/schema#",
329 "type": "object",
330 "properties": {
331 "lcmOperationType": string_schema,
332 "nsInstanceId": id_schema,
333 "netsliceInstanceId": id_schema,
334 "nsName": name_schema,
335 "nsDescription": {"oneOf": [description_schema, null_schema]},
336 "nsdId": id_schema,
337 "vimAccountId": id_schema,
338 "wimAccountId": {"oneOf": [id_schema, bool_schema, null_schema]},
339 "placement-engine": string_schema,
340 "placement-constraints": object_schema,
341 "additionalParamsForNs": object_schema,
342 "additionalParamsForVnf": additional_params_for_vnf,
343 "config-units": integer1_schema, # number of configuration units of this ns, by default 1
344 "k8s-namespace": name_schema,
345 "ssh_keys": {"type": "array", "items": {"type": "string"}},
346 "timeout_ns_deploy": integer1_schema,
347 "nsr_id": id_schema,
348 "vduImage": name_schema,
349 "vnf": {
350 "type": "array",
351 "minItems": 1,
352 "items": {
353 "type": "object",
354 "properties": {
355 "member-vnf-index": name_schema,
356 "vimAccountId": id_schema,
357 "vdu": {
358 "type": "array",
359 "minItems": 1,
360 "items": ns_instantiate_vdu,
361 },
362 "internal-vld": {
363 "type": "array",
364 "minItems": 1,
365 "items": ns_instantiate_internal_vld,
366 },
367 },
368 "required": ["member-vnf-index"],
369 "minProperties": 2,
370 "additionalProperties": False,
371 },
372 },
373 "vld": {
374 "type": "array",
375 "minItems": 1,
376 "items": {
377 "type": "object",
378 "properties": {
379 "name": string_schema,
380 "vim-network-name": {"oneOf": [string_schema, object_schema]},
381 "vim-network-id": {"oneOf": [string_schema, object_schema]},
382 "ns-net": object_schema,
383 "wimAccountId": {"oneOf": [id_schema, bool_schema, null_schema]},
384 "ip-profile": object_schema,
385 "provider-network": provider_network_schema,
386 "vnfd-connection-point-ref": {
387 "type": "array",
388 "minItems": 1,
389 "items": {
390 "type": "object",
391 "properties": {
392 "member-vnf-index-ref": name_schema,
393 "vnfd-connection-point-ref": name_schema,
394 "ip-address": ip_schema,
395 # "mac-address": mac_schema,
396 },
397 "required": [
398 "member-vnf-index-ref",
399 "vnfd-connection-point-ref",
400 ],
401 "minProperties": 3,
402 "additionalProperties": False,
403 },
404 },
405 },
406 "required": ["name"],
407 "additionalProperties": False,
408 },
409 },
410 },
411 "required": ["nsName", "nsdId", "vimAccountId"],
412 "additionalProperties": False,
413 }
414
415 ns_terminate = {
416 "title": "ns terminate input schema",
417 "$schema": "http://json-schema.org/draft-04/schema#",
418 "type": "object",
419 "properties": {
420 "lcmOperationType": string_schema,
421 "nsInstanceId": id_schema,
422 "autoremove": bool_schema,
423 "timeout_ns_terminate": integer1_schema,
424 "skip_terminate_primitives": bool_schema,
425 "netsliceInstanceId": id_schema,
426 },
427 "additionalProperties": False,
428 }
429
430 ns_action = { # TODO for the moment it is only contemplated the vnfd primitive execution
431 "title": "ns action input schema",
432 "$schema": "http://json-schema.org/draft-04/schema#",
433 "type": "object",
434 "properties": {
435 "lcmOperationType": string_schema,
436 "nsInstanceId": id_schema,
437 "member_vnf_index": name_schema,
438 "vnf_member_index": name_schema, # TODO for backward compatibility. To remove in future
439 "vdu_id": name_schema,
440 "vdu_count_index": integer0_schema,
441 "kdu_name": name_schema,
442 "primitive": name_schema,
443 "timeout_ns_action": integer1_schema,
444 "primitive_params": {"type": "object"},
445 },
446 "required": ["primitive", "primitive_params"], # TODO add member_vnf_index
447 "additionalProperties": False,
448 }
449 ns_scale = { # TODO for the moment it is only VDU-scaling
450 "title": "ns scale input schema",
451 "$schema": "http://json-schema.org/draft-04/schema#",
452 "type": "object",
453 "properties": {
454 "lcmOperationType": string_schema,
455 "nsInstanceId": id_schema,
456 "scaleType": {"enum": ["SCALE_VNF"]},
457 "timeout_ns_scale": integer1_schema,
458 "scaleVnfData": {
459 "type": "object",
460 "properties": {
461 "vnfInstanceId": name_schema,
462 "scaleVnfType": {"enum": ["SCALE_OUT", "SCALE_IN"]},
463 "scaleByStepData": {
464 "type": "object",
465 "properties": {
466 "scaling-group-descriptor": name_schema,
467 "member-vnf-index": name_schema,
468 "scaling-policy": name_schema,
469 },
470 "required": ["scaling-group-descriptor", "member-vnf-index"],
471 "additionalProperties": False,
472 },
473 },
474 "required": ["scaleVnfType", "scaleByStepData"], # vnfInstanceId
475 "additionalProperties": False,
476 },
477 "scaleTime": time_schema,
478 },
479 "required": ["scaleType", "scaleVnfData"],
480 "additionalProperties": False,
481 }
482
483
484 schema_version = {"type": "string", "enum": ["1.0"]}
485 schema_type = {"type": "string"}
486 vim_type = shortname_schema # {"enum": ["openstack", "openvim", "vmware", "opennebula", "aws", "azure", "fos"]}
487
488 vim_account_edit_schema = {
489 "title": "vim_account edit input schema",
490 "$schema": "http://json-schema.org/draft-04/schema#",
491 "type": "object",
492 "properties": {
493 "name": name_schema,
494 "description": description_schema,
495 "vim": name_schema,
496 "datacenter": name_schema,
497 "vim_type": vim_type,
498 "vim_url": description_schema,
499 # "vim_url_admin": description_schema,
500 # "vim_tenant": name_schema,
501 "vim_tenant_name": name_schema,
502 "vim_user": string_schema,
503 "vim_password": passwd_schema,
504 "vca": id_schema,
505 "config": {"type": "object"},
506 },
507 "additionalProperties": False,
508 }
509
510 vim_account_new_schema = {
511 "title": "vim_account creation input schema",
512 "$schema": "http://json-schema.org/draft-04/schema#",
513 "type": "object",
514 "properties": {
515 "schema_version": schema_version,
516 "schema_type": schema_type,
517 "name": name_schema,
518 "description": description_schema,
519 "vim": name_schema,
520 "datacenter": name_schema,
521 "vim_type": vim_type,
522 "vim_url": description_schema,
523 # "vim_url_admin": description_schema,
524 # "vim_tenant": name_schema,
525 "vim_tenant_name": name_schema,
526 "vim_user": string_schema,
527 "vim_password": passwd_schema,
528 "vca": id_schema,
529 "config": {"type": "object"},
530 },
531 "required": [
532 "name",
533 "vim_url",
534 "vim_type",
535 "vim_user",
536 "vim_password",
537 "vim_tenant_name",
538 ],
539 "additionalProperties": False,
540 }
541
542 wim_type = shortname_schema # {"enum": ["ietfl2vpn", "onos", "odl", "dynpac", "fake"]}
543
544 wim_account_edit_schema = {
545 "title": "wim_account edit input schema",
546 "$schema": "http://json-schema.org/draft-04/schema#",
547 "type": "object",
548 "properties": {
549 "name": name_schema,
550 "description": description_schema,
551 "wim": name_schema,
552 "wim_type": wim_type,
553 "wim_url": description_schema,
554 "user": string_schema,
555 "password": passwd_schema,
556 "config": {"type": "object"},
557 },
558 "additionalProperties": False,
559 }
560
561 wim_account_new_schema = {
562 "title": "wim_account creation input schema",
563 "$schema": "http://json-schema.org/draft-04/schema#",
564 "type": "object",
565 "properties": {
566 "schema_version": schema_version,
567 "schema_type": schema_type,
568 "name": name_schema,
569 "description": description_schema,
570 "wim": name_schema,
571 "wim_type": wim_type,
572 "wim_url": description_schema,
573 "user": string_schema,
574 "password": passwd_schema,
575 "config": {
576 "type": "object",
577 "patternProperties": {".": {"not": {"type": "null"}}},
578 },
579 },
580 "required": ["name", "wim_url", "wim_type"],
581 "additionalProperties": False,
582 }
583
584 sdn_properties = {
585 "name": name_schema,
586 "type": {"type": "string"},
587 "url": {"type": "string"},
588 "user": string_schema,
589 "password": passwd_schema,
590 "config": {"type": "object"},
591 "description": description_schema,
592 # The folowing are deprecated. Maintanied for backward compatibility
593 "dpid": dpid_Schema,
594 "ip": ip_schema,
595 "port": port_schema,
596 "version": {"type": "string", "minLength": 1, "maxLength": 12},
597 }
598 sdn_new_schema = {
599 "title": "sdn controller information schema",
600 "$schema": "http://json-schema.org/draft-04/schema#",
601 "type": "object",
602 "properties": sdn_properties,
603 "required": ["name", "type"],
604 "additionalProperties": False,
605 }
606 sdn_edit_schema = {
607 "title": "sdn controller update information schema",
608 "$schema": "http://json-schema.org/draft-04/schema#",
609 "type": "object",
610 "properties": sdn_properties,
611 # "required": ["name", "port", 'ip', 'dpid', 'type'],
612 "additionalProperties": False,
613 }
614 sdn_port_mapping_schema = {
615 "$schema": "http://json-schema.org/draft-04/schema#",
616 "title": "sdn port mapping information schema",
617 "type": "array",
618 "items": {
619 "type": "object",
620 "properties": {
621 "compute_node": shortname_schema,
622 "ports": {
623 "type": "array",
624 "items": {
625 "type": "object",
626 "properties": {
627 "pci": pci_extended_schema,
628 "switch_port": shortname_schema,
629 "switch_mac": mac_schema,
630 },
631 "required": ["pci"],
632 },
633 },
634 },
635 "required": ["compute_node", "ports"],
636 },
637 }
638 sdn_external_port_schema = {
639 "$schema": "http://json-schema.org/draft-04/schema#",
640 "title": "External port information",
641 "type": "object",
642 "properties": {
643 "port": {"type": "string", "minLength": 1, "maxLength": 60},
644 "vlan": vlan_schema,
645 "mac": mac_schema,
646 },
647 "required": ["port"],
648 }
649
650 # K8s Clusters
651 k8scluster_nets_schema = {
652 "title": "k8scluster nets input schema",
653 "$schema": "http://json-schema.org/draft-04/schema#",
654 "type": "object",
655 "patternProperties": {".": {"oneOf": [name_schema, null_schema]}},
656 "minProperties": 1,
657 "additionalProperties": False,
658 }
659 k8scluster_new_schema = {
660 "title": "k8scluster creation input schema",
661 "$schema": "http://json-schema.org/draft-04/schema#",
662 "type": "object",
663 "properties": {
664 "schema_version": schema_version,
665 "schema_type": schema_type,
666 "name": name_schema,
667 "description": description_schema,
668 "credentials": object_schema,
669 "vim_account": id_schema,
670 "vca_id": id_schema,
671 "k8s_version": string_schema,
672 "nets": k8scluster_nets_schema,
673 "namespace": name_schema,
674 "cni": nameshort_list_schema,
675 },
676 "required": ["name", "credentials", "vim_account", "k8s_version", "nets"],
677 "additionalProperties": False,
678 }
679 k8scluster_edit_schema = {
680 "title": "vim_account edit input schema",
681 "$schema": "http://json-schema.org/draft-04/schema#",
682 "type": "object",
683 "properties": {
684 "name": name_schema,
685 "description": description_schema,
686 "credentials": object_schema,
687 "vim_account": id_schema,
688 "vca_id": id_schema,
689 "k8s_version": string_schema,
690 "nets": k8scluster_nets_schema,
691 "namespace": name_schema,
692 "cni": nameshort_list_schema,
693 },
694 "additionalProperties": False,
695 }
696
697 # VCA
698 vca_new_schema = {
699 "title": "vca creation input schema",
700 "$schema": "http://json-schema.org/draft-04/schema#",
701 "type": "object",
702 "properties": {
703 "schema_version": schema_version,
704 "schema_type": schema_type,
705 "name": name_schema,
706 "description": description_schema,
707 "endpoints": description_list_schema,
708 "user": string_schema,
709 "secret": passwd_schema,
710 "cacert": long_description_schema,
711 "lxd-cloud": shortname_schema,
712 "lxd-credentials": shortname_schema,
713 "k8s-cloud": shortname_schema,
714 "k8s-credentials": shortname_schema,
715 "model-config": object_schema,
716 },
717 "required": [
718 "name",
719 "endpoints",
720 "user",
721 "secret",
722 "cacert",
723 "lxd-cloud",
724 "lxd-credentials",
725 "k8s-cloud",
726 "k8s-credentials",
727 ],
728 "additionalProperties": False,
729 }
730 vca_edit_schema = {
731 "title": "vca creation input schema",
732 "$schema": "http://json-schema.org/draft-04/schema#",
733 "type": "object",
734 "properties": {
735 "name": name_schema,
736 "description": description_schema,
737 "endpoints": description_list_schema,
738 "port": integer1_schema,
739 "user": string_schema,
740 "secret": passwd_schema,
741 "cacert": long_description_schema,
742 "lxd-cloud": shortname_schema,
743 "lxd-credentials": shortname_schema,
744 "k8s-cloud": shortname_schema,
745 "k8s-credentials": shortname_schema,
746 "model-config": object_schema,
747 },
748 "additionalProperties": False,
749 }
750
751 # K8s Repos
752 k8srepo_types = {"enum": ["helm-chart", "juju-bundle"]}
753 k8srepo_properties = {
754 "name": name_schema,
755 "description": description_schema,
756 "type": k8srepo_types,
757 "url": description_schema,
758 }
759 k8srepo_new_schema = {
760 "title": "k8scluster creation input schema",
761 "$schema": "http://json-schema.org/draft-04/schema#",
762 "type": "object",
763 "properties": k8srepo_properties,
764 "required": ["name", "type", "url"],
765 "additionalProperties": False,
766 }
767 k8srepo_edit_schema = {
768 "title": "vim_account edit input schema",
769 "$schema": "http://json-schema.org/draft-04/schema#",
770 "type": "object",
771 "properties": k8srepo_properties,
772 "additionalProperties": False,
773 }
774
775 # OSM Repos
776 osmrepo_types = {"enum": ["osm"]}
777 osmrepo_properties = {
778 "name": name_schema,
779 "description": description_schema,
780 "type": osmrepo_types,
781 "url": description_schema
782 # "user": string_schema,
783 # "password": passwd_schema
784 }
785 osmrepo_new_schema = {
786 "title": "osm repo creation input schema",
787 "$schema": "http://json-schema.org/draft-04/schema#",
788 "type": "object",
789 "properties": osmrepo_properties,
790 "required": ["name", "type", "url"],
791 "additionalProperties": False,
792 }
793 osmrepo_edit_schema = {
794 "title": "osm repo edit input schema",
795 "$schema": "http://json-schema.org/draft-04/schema#",
796 "type": "object",
797 "properties": osmrepo_properties,
798 "additionalProperties": False,
799 }
800
801 # PDUs
802 pdu_interface = {
803 "type": "object",
804 "properties": {
805 "name": shortname_schema,
806 "mgmt": bool_schema,
807 "type": {"enum": ["overlay", "underlay"]},
808 "ip-address": {"oneOf": [ip_schema, ipv6_schema]},
809 # TODO, add user, password, ssh-key
810 "mac-address": mac_schema,
811 "vim-network-name": shortname_schema, # interface is connected to one vim network, or switch port
812 "vim-network-id": shortname_schema,
813 # # provide this in case SDN assist must deal with this interface
814 # "switch-dpid": dpid_Schema,
815 # "switch-port": shortname_schema,
816 # "switch-mac": shortname_schema,
817 # "switch-vlan": vlan_schema,
818 },
819 "required": ["name", "mgmt", "ip-address"],
820 "additionalProperties": False,
821 }
822 pdu_new_schema = {
823 "title": "pdu creation input schema",
824 "$schema": "http://json-schema.org/draft-04/schema#",
825 "type": "object",
826 "properties": {
827 "name": shortname_schema,
828 "type": shortname_schema,
829 "description": description_schema,
830 "shared": bool_schema,
831 "vims": nameshort_list_schema,
832 "vim_accounts": nameshort_list_schema,
833 "interfaces": {"type": "array", "items": pdu_interface, "minItems": 1},
834 },
835 "required": ["name", "type", "interfaces"],
836 "additionalProperties": False,
837 }
838 pdu_edit_schema = {
839 "title": "pdu edit input schema",
840 "$schema": "http://json-schema.org/draft-04/schema#",
841 "type": "object",
842 "properties": {
843 "name": shortname_schema,
844 "type": shortname_schema,
845 "description": description_schema,
846 "shared": bool_schema,
847 "vims": {"oneOf": [array_edition_schema, nameshort_list_schema]},
848 "vim_accounts": {"oneOf": [array_edition_schema, nameshort_list_schema]},
849 "interfaces": {
850 "oneOf": [
851 array_edition_schema,
852 {"type": "array", "items": pdu_interface, "minItems": 1},
853 ]
854 },
855 },
856 "additionalProperties": False,
857 "minProperties": 1,
858 }
859
860 # VNF PKG OPERATIONS
861 vnfpkgop_new_schema = {
862 "title": "VNF PKG operation creation input schema",
863 "$schema": "http://json-schema.org/draft-04/schema#",
864 "type": "object",
865 "properties": {
866 "lcmOperationType": string_schema,
867 "vnfPkgId": id_schema,
868 "kdu_name": name_schema,
869 "primitive": name_schema,
870 "primitive_params": {"type": "object"},
871 },
872 "required": [
873 "lcmOperationType",
874 "vnfPkgId",
875 "kdu_name",
876 "primitive",
877 "primitive_params",
878 ],
879 "additionalProperties": False,
880 }
881
882 # USERS
883 project_role_mappings = {
884 "title": "list pf projects/roles",
885 "$schema": "http://json-schema.org/draft-04/schema#",
886 "type": "array",
887 "items": {
888 "type": "object",
889 "properties": {"project": shortname_schema, "role": shortname_schema},
890 "required": ["project", "role"],
891 "additionalProperties": False,
892 },
893 "minItems": 1,
894 }
895 project_role_mappings_optional = {
896 "title": "list of projects/roles or projects only",
897 "$schema": "http://json-schema.org/draft-04/schema#",
898 "type": "array",
899 "items": {
900 "type": "object",
901 "properties": {"project": shortname_schema, "role": shortname_schema},
902 "required": ["project"],
903 "additionalProperties": False,
904 },
905 "minItems": 1,
906 }
907 user_new_schema = {
908 "$schema": "http://json-schema.org/draft-04/schema#",
909 "title": "New user schema",
910 "type": "object",
911 "properties": {
912 "username": string_schema,
913 "domain_name": shortname_schema,
914 "password": passwd_schema,
915 "projects": nameshort_list_schema,
916 "project_role_mappings": project_role_mappings,
917 },
918 "required": ["username", "password"],
919 "additionalProperties": False,
920 }
921 user_edit_schema = {
922 "$schema": "http://json-schema.org/draft-04/schema#",
923 "title": "User edit schema for administrators",
924 "type": "object",
925 "properties": {
926 "password": passwd_schema,
927 "username": string_schema, # To allow User Name modification
928 "projects": {"oneOf": [nameshort_list_schema, array_edition_schema]},
929 "project_role_mappings": project_role_mappings,
930 "add_project_role_mappings": project_role_mappings,
931 "remove_project_role_mappings": project_role_mappings_optional,
932 },
933 "minProperties": 1,
934 "additionalProperties": False,
935 }
936
937 # PROJECTS
938 topics_with_quota = [
939 "vnfds",
940 "nsds",
941 "slice_templates",
942 "pduds",
943 "ns_instances",
944 "slice_instances",
945 "vim_accounts",
946 "wim_accounts",
947 "sdn_controllers",
948 "k8sclusters",
949 "vca",
950 "k8srepos",
951 "osmrepos",
952 "ns_subscriptions",
953 ]
954 project_new_schema = {
955 "$schema": "http://json-schema.org/draft-04/schema#",
956 "title": "New project schema for administrators",
957 "type": "object",
958 "properties": {
959 "name": shortname_schema,
960 "admin": bool_schema,
961 "domain_name": shortname_schema,
962 "quotas": {
963 "type": "object",
964 "properties": {topic: integer0_schema for topic in topics_with_quota},
965 "additionalProperties": False,
966 },
967 },
968 "required": ["name"],
969 "additionalProperties": False,
970 }
971 project_edit_schema = {
972 "$schema": "http://json-schema.org/draft-04/schema#",
973 "title": "Project edit schema for administrators",
974 "type": "object",
975 "properties": {
976 "admin": bool_schema,
977 "name": shortname_schema, # To allow Project Name modification
978 "quotas": {
979 "type": "object",
980 "properties": {
981 topic: {"oneOf": [integer0_schema, null_schema]}
982 for topic in topics_with_quota
983 },
984 "additionalProperties": False,
985 },
986 },
987 "additionalProperties": False,
988 "minProperties": 1,
989 }
990
991 # ROLES
992 roles_new_schema = {
993 "$schema": "http://json-schema.org/draft-04/schema#",
994 "title": "New role schema for administrators",
995 "type": "object",
996 "properties": {
997 "name": shortname_schema,
998 "permissions": {
999 "type": "object",
1000 "patternProperties": {
1001 ".": bool_schema,
1002 },
1003 # "minProperties": 1,
1004 },
1005 },
1006 "required": ["name"],
1007 "additionalProperties": False,
1008 }
1009 roles_edit_schema = {
1010 "$schema": "http://json-schema.org/draft-04/schema#",
1011 "title": "Roles edit schema for administrators",
1012 "type": "object",
1013 "properties": {
1014 "name": shortname_schema,
1015 "permissions": {
1016 "type": "object",
1017 "patternProperties": {".": {"oneOf": [bool_schema, null_schema]}},
1018 # "minProperties": 1,
1019 },
1020 },
1021 "additionalProperties": False,
1022 "minProperties": 1,
1023 }
1024
1025 # GLOBAL SCHEMAS
1026
1027 nbi_new_input_schemas = {
1028 "users": user_new_schema,
1029 "projects": project_new_schema,
1030 "vim_accounts": vim_account_new_schema,
1031 "sdns": sdn_new_schema,
1032 "ns_instantiate": ns_instantiate,
1033 "ns_action": ns_action,
1034 "ns_scale": ns_scale,
1035 "pdus": pdu_new_schema,
1036 }
1037
1038 nbi_edit_input_schemas = {
1039 "users": user_edit_schema,
1040 "projects": project_edit_schema,
1041 "vim_accounts": vim_account_edit_schema,
1042 "sdns": sdn_edit_schema,
1043 "pdus": pdu_edit_schema,
1044 }
1045
1046 # NETSLICE SCHEMAS
1047 nsi_subnet_instantiate = deepcopy(ns_instantiate)
1048 nsi_subnet_instantiate["title"] = "netslice subnet instantiation params input schema"
1049 nsi_subnet_instantiate["properties"]["id"] = name_schema
1050 del nsi_subnet_instantiate["required"]
1051
1052 nsi_vld_instantiate = {
1053 "title": "netslice vld instantiation params input schema",
1054 "$schema": "http://json-schema.org/draft-04/schema#",
1055 "type": "object",
1056 "properties": {
1057 "name": string_schema,
1058 "vim-network-name": {"oneOf": [string_schema, object_schema]},
1059 "vim-network-id": {"oneOf": [string_schema, object_schema]},
1060 "ip-profile": object_schema,
1061 },
1062 "required": ["name"],
1063 "additionalProperties": False,
1064 }
1065
1066 nsi_instantiate = {
1067 "title": "netslice action instantiate input schema",
1068 "$schema": "http://json-schema.org/draft-04/schema#",
1069 "type": "object",
1070 "properties": {
1071 "lcmOperationType": string_schema,
1072 "netsliceInstanceId": id_schema,
1073 "nsiName": name_schema,
1074 "nsiDescription": {"oneOf": [description_schema, null_schema]},
1075 "nstId": string_schema,
1076 "vimAccountId": id_schema,
1077 "timeout_nsi_deploy": integer1_schema,
1078 "ssh_keys": {"type": "array", "items": {"type": "string"}},
1079 "nsi_id": id_schema,
1080 "additionalParamsForNsi": object_schema,
1081 "netslice-subnet": {
1082 "type": "array",
1083 "minItems": 1,
1084 "items": nsi_subnet_instantiate,
1085 },
1086 "netslice-vld": {"type": "array", "minItems": 1, "items": nsi_vld_instantiate},
1087 },
1088 "required": ["nsiName", "nstId", "vimAccountId"],
1089 "additionalProperties": False,
1090 }
1091
1092 nsi_action = {}
1093
1094 nsi_terminate = {}
1095
1096 nsinstancesubscriptionfilter_schema = {
1097 "title": "instance identifier schema",
1098 "$schema": "http://json-schema.org/draft-07/schema#",
1099 "type": "object",
1100 "properties": {
1101 "nsdIds": {"type": "array"},
1102 "vnfdIds": {"type": "array"},
1103 "pnfdIds": {"type": "array"},
1104 "nsInstanceIds": {"type": "array"},
1105 "nsInstanceNames": {"type": "array"},
1106 },
1107 }
1108
1109 nslcmsub_schema = {
1110 "title": "nslcmsubscription input schema",
1111 "$schema": "http://json-schema.org/draft-07/schema#",
1112 "type": "object",
1113 "properties": {
1114 "nsInstanceSubscriptionFilter": nsinstancesubscriptionfilter_schema,
1115 "notificationTypes": {
1116 "type": "array",
1117 "items": {
1118 "enum": [
1119 "NsLcmOperationOccurrenceNotification",
1120 "NsChangeNotification",
1121 "NsIdentifierCreationNotification",
1122 "NsIdentifierDeletionNotification",
1123 ]
1124 },
1125 },
1126 "operationTypes": {
1127 "type": "array",
1128 "items": {"enum": ["INSTANTIATE", "SCALE", "TERMINATE", "UPDATE", "HEAL"]},
1129 },
1130 "operationStates": {
1131 "type": "array",
1132 "items": {
1133 "enum": [
1134 "PROCESSING",
1135 "COMPLETED",
1136 "PARTIALLY_COMPLETED",
1137 "FAILED",
1138 "FAILED_TEMP",
1139 "ROLLING_BACK",
1140 "ROLLED_BACK",
1141 ]
1142 },
1143 },
1144 "nsComponentTypes": {"type": "array", "items": {"enum": ["VNF", "NS", "PNF"]}},
1145 "lcmOpNameImpactingNsComponent": {
1146 "type": "array",
1147 "items": {
1148 "enum": [
1149 "VNF_INSTANTIATE",
1150 "VNF_SCALE",
1151 "VNF_SCALE_TO_LEVEL",
1152 "VNF_CHANGE_FLAVOUR",
1153 "VNF_TERMINATE",
1154 "VNF_HEAL",
1155 "VNF_OPERATE",
1156 "VNF_CHANGE_EXT_CONN",
1157 "VNF_MODIFY_INFO",
1158 "NS_INSTANTIATE",
1159 "NS_SCALE",
1160 "NS_UPDATE",
1161 "NS_TERMINATE",
1162 "NS_HEAL",
1163 ]
1164 },
1165 },
1166 "lcmOpOccStatusImpactingNsComponent": {
1167 "type": "array",
1168 "items": {
1169 "enum": [
1170 "START",
1171 "COMPLETED",
1172 "PARTIALLY_COMPLETED",
1173 "FAILED",
1174 "ROLLED_BACK",
1175 ]
1176 },
1177 },
1178 },
1179 "allOf": [
1180 {
1181 "if": {
1182 "properties": {
1183 "notificationTypes": {
1184 "contains": {"const": "NsLcmOperationOccurrenceNotification"}
1185 }
1186 },
1187 },
1188 "then": {
1189 "anyOf": [
1190 {"required": ["operationTypes"]},
1191 {"required": ["operationStates"]},
1192 ]
1193 },
1194 },
1195 {
1196 "if": {
1197 "properties": {
1198 "notificationTypes": {"contains": {"const": "NsChangeNotification"}}
1199 },
1200 },
1201 "then": {
1202 "anyOf": [
1203 {"required": ["nsComponentTypes"]},
1204 {"required": ["lcmOpNameImpactingNsComponent"]},
1205 {"required": ["lcmOpOccStatusImpactingNsComponent"]},
1206 ]
1207 },
1208 },
1209 ],
1210 }
1211
1212 authentication_schema = {
1213 "title": "authentication schema for subscription",
1214 "$schema": "http://json-schema.org/draft-07/schema#",
1215 "type": "object",
1216 "properties": {
1217 "authType": {"enum": ["basic"]},
1218 "paramsBasic": {
1219 "type": "object",
1220 "properties": {
1221 "userName": string_schema,
1222 "password": passwd_schema,
1223 },
1224 },
1225 },
1226 }
1227
1228 subscription = {
1229 "title": "subscription input schema",
1230 "$schema": "http://json-schema.org/draft-07/schema#",
1231 "type": "object",
1232 "properties": {
1233 "filter": nslcmsub_schema,
1234 "CallbackUri": description_schema,
1235 "authentication": authentication_schema,
1236 },
1237 "required": ["CallbackUri"],
1238 }
1239
1240
1241 class ValidationError(Exception):
1242 def __init__(self, message, http_code=HTTPStatus.UNPROCESSABLE_ENTITY):
1243 self.http_code = http_code
1244 Exception.__init__(self, message)
1245
1246
1247 def validate_input(indata, schema_to_use):
1248 """
1249 Validates input data against json schema
1250 :param indata: user input data. Should be a dictionary
1251 :param schema_to_use: jsonschema to test
1252 :return: None if ok, raises ValidationError exception on error
1253 """
1254 try:
1255 if schema_to_use:
1256 js_v(indata, schema_to_use)
1257 return None
1258 except js_e.ValidationError as e:
1259 if e.path:
1260 error_pos = "at '" + ":".join(map(str, e.path)) + "'"
1261 else:
1262 error_pos = ""
1263 raise ValidationError("Format error {} '{}' ".format(error_pos, e.message))
1264 except js_e.SchemaError:
1265 raise ValidationError(
1266 "Bad json schema {}".format(schema_to_use),
1267 http_code=HTTPStatus.INTERNAL_SERVER_ERROR,
1268 )
1269
1270
1271 def is_valid_uuid(x):
1272 """
1273 Test for a valid UUID
1274 :param x: string to test
1275 :return: True if x is a valid uuid, False otherwise
1276 """
1277 try:
1278 if UUID(x):
1279 return True
1280 except (TypeError, ValueError, AttributeError):
1281 return False