25204c0fc71a2b98b5eb0d1abe3afb4fc3ae6771
[osm/RO.git] / NG-RO / osm_ng_ro / ns.py
1 # -*- coding: utf-8 -*-
2
3 ##
4 # Copyright 2020 Telefonica Investigacion y Desarrollo, S.A.U.
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
8 #
9 # http://www.apache.org/licenses/LICENSE-2.0
10 #
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
14 # implied.
15 # See the License for the specific language governing permissions and
16 # limitations under the License.
17 ##
18
19 # import yaml
20 import logging
21 from typing import Any, Dict
22 from traceback import format_exc as traceback_format_exc
23 from osm_ng_ro.ns_thread import NsWorker, NsWorkerException, deep_get
24 from osm_ng_ro.validation import validate_input, deploy_schema
25 from osm_common import (
26 dbmongo,
27 dbmemory,
28 fslocal,
29 fsmongo,
30 msglocal,
31 msgkafka,
32 version as common_version,
33 )
34 from osm_common.dbbase import DbException
35 from osm_common.fsbase import FsException
36 from osm_common.msgbase import MsgException
37 from http import HTTPStatus
38 from uuid import uuid4
39 from threading import Lock
40 from random import choice as random_choice
41 from time import time
42 from jinja2 import (
43 Environment,
44 TemplateError,
45 TemplateNotFound,
46 StrictUndefined,
47 UndefinedError,
48 )
49 from cryptography.hazmat.primitives import serialization as crypto_serialization
50 from cryptography.hazmat.primitives.asymmetric import rsa
51 from cryptography.hazmat.backends import default_backend as crypto_default_backend
52
53 __author__ = "Alfonso Tierno <alfonso.tiernosepulveda@telefonica.com>"
54 min_common_version = "0.1.16"
55
56
57 class NsException(Exception):
58 def __init__(self, message, http_code=HTTPStatus.BAD_REQUEST):
59 self.http_code = http_code
60 super(Exception, self).__init__(message)
61
62
63 def get_process_id():
64 """
65 Obtain a unique ID for this process. If running from inside docker, it will get docker ID. If not it
66 will provide a random one
67 :return: Obtained ID
68 """
69 # Try getting docker id. If fails, get pid
70 try:
71 with open("/proc/self/cgroup", "r") as f:
72 text_id_ = f.readline()
73 _, _, text_id = text_id_.rpartition("/")
74 text_id = text_id.replace("\n", "")[:12]
75
76 if text_id:
77 return text_id
78 except Exception:
79 pass
80
81 # Return a random id
82 return "".join(random_choice("0123456789abcdef") for _ in range(12))
83
84
85 def versiontuple(v):
86 """utility for compare dot separate versions. Fills with zeros to proper number comparison"""
87 filled = []
88
89 for point in v.split("."):
90 filled.append(point.zfill(8))
91
92 return tuple(filled)
93
94
95 class Ns(object):
96 def __init__(self):
97 self.db = None
98 self.fs = None
99 self.msg = None
100 self.config = None
101 # self.operations = None
102 self.logger = None
103 # ^ Getting logger inside method self.start because parent logger (ro) is not available yet.
104 # If done now it will not be linked to parent not getting its handler and level
105 self.map_topic = {}
106 self.write_lock = None
107 self.vims_assigned = {}
108 self.next_worker = 0
109 self.plugins = {}
110 self.workers = []
111
112 def init_db(self, target_version):
113 pass
114
115 def start(self, config):
116 """
117 Connect to database, filesystem storage, and messaging
118 :param config: two level dictionary with configuration. Top level should contain 'database', 'storage',
119 :param config: Configuration of db, storage, etc
120 :return: None
121 """
122 self.config = config
123 self.config["process_id"] = get_process_id() # used for HA identity
124 self.logger = logging.getLogger("ro.ns")
125
126 # check right version of common
127 if versiontuple(common_version) < versiontuple(min_common_version):
128 raise NsException(
129 "Not compatible osm/common version '{}'. Needed '{}' or higher".format(
130 common_version, min_common_version
131 )
132 )
133
134 try:
135 if not self.db:
136 if config["database"]["driver"] == "mongo":
137 self.db = dbmongo.DbMongo()
138 self.db.db_connect(config["database"])
139 elif config["database"]["driver"] == "memory":
140 self.db = dbmemory.DbMemory()
141 self.db.db_connect(config["database"])
142 else:
143 raise NsException(
144 "Invalid configuration param '{}' at '[database]':'driver'".format(
145 config["database"]["driver"]
146 )
147 )
148
149 if not self.fs:
150 if config["storage"]["driver"] == "local":
151 self.fs = fslocal.FsLocal()
152 self.fs.fs_connect(config["storage"])
153 elif config["storage"]["driver"] == "mongo":
154 self.fs = fsmongo.FsMongo()
155 self.fs.fs_connect(config["storage"])
156 elif config["storage"]["driver"] is None:
157 pass
158 else:
159 raise NsException(
160 "Invalid configuration param '{}' at '[storage]':'driver'".format(
161 config["storage"]["driver"]
162 )
163 )
164
165 if not self.msg:
166 if config["message"]["driver"] == "local":
167 self.msg = msglocal.MsgLocal()
168 self.msg.connect(config["message"])
169 elif config["message"]["driver"] == "kafka":
170 self.msg = msgkafka.MsgKafka()
171 self.msg.connect(config["message"])
172 else:
173 raise NsException(
174 "Invalid configuration param '{}' at '[message]':'driver'".format(
175 config["message"]["driver"]
176 )
177 )
178
179 # TODO load workers to deal with exising database tasks
180
181 self.write_lock = Lock()
182 except (DbException, FsException, MsgException) as e:
183 raise NsException(str(e), http_code=e.http_code)
184
185 def get_assigned_vims(self):
186 return list(self.vims_assigned.keys())
187
188 def stop(self):
189 try:
190 if self.db:
191 self.db.db_disconnect()
192
193 if self.fs:
194 self.fs.fs_disconnect()
195
196 if self.msg:
197 self.msg.disconnect()
198
199 self.write_lock = None
200 except (DbException, FsException, MsgException) as e:
201 raise NsException(str(e), http_code=e.http_code)
202
203 for worker in self.workers:
204 worker.insert_task(("terminate",))
205
206 def _create_worker(self):
207 """
208 Look for a worker thread in idle status. If not found it creates one unless the number of threads reach the
209 limit of 'server.ns_threads' configuration. If reached, it just assigns one existing thread
210 return the index of the assigned worker thread. Worker threads are storead at self.workers
211 """
212 # Look for a thread in idle status
213 worker_id = next(
214 (
215 i
216 for i in range(len(self.workers))
217 if self.workers[i] and self.workers[i].idle
218 ),
219 None,
220 )
221
222 if worker_id is not None:
223 # unset idle status to avoid race conditions
224 self.workers[worker_id].idle = False
225 else:
226 worker_id = len(self.workers)
227
228 if worker_id < self.config["global"]["server.ns_threads"]:
229 # create a new worker
230 self.workers.append(
231 NsWorker(worker_id, self.config, self.plugins, self.db)
232 )
233 self.workers[worker_id].start()
234 else:
235 # reached maximum number of threads, assign VIM to an existing one
236 worker_id = self.next_worker
237 self.next_worker = (self.next_worker + 1) % self.config["global"][
238 "server.ns_threads"
239 ]
240
241 return worker_id
242
243 def assign_vim(self, target_id):
244 with self.write_lock:
245 return self._assign_vim(target_id)
246
247 def _assign_vim(self, target_id):
248 if target_id not in self.vims_assigned:
249 worker_id = self.vims_assigned[target_id] = self._create_worker()
250 self.workers[worker_id].insert_task(("load_vim", target_id))
251
252 def reload_vim(self, target_id):
253 # send reload_vim to the thread working with this VIM and inform all that a VIM has been changed,
254 # this is because database VIM information is cached for threads working with SDN
255 with self.write_lock:
256 for worker in self.workers:
257 if worker and not worker.idle:
258 worker.insert_task(("reload_vim", target_id))
259
260 def unload_vim(self, target_id):
261 with self.write_lock:
262 return self._unload_vim(target_id)
263
264 def _unload_vim(self, target_id):
265 if target_id in self.vims_assigned:
266 worker_id = self.vims_assigned[target_id]
267 self.workers[worker_id].insert_task(("unload_vim", target_id))
268 del self.vims_assigned[target_id]
269
270 def check_vim(self, target_id):
271 with self.write_lock:
272 if target_id in self.vims_assigned:
273 worker_id = self.vims_assigned[target_id]
274 else:
275 worker_id = self._create_worker()
276
277 worker = self.workers[worker_id]
278 worker.insert_task(("check_vim", target_id))
279
280 def unload_unused_vims(self):
281 with self.write_lock:
282 vims_to_unload = []
283
284 for target_id in self.vims_assigned:
285 if not self.db.get_one(
286 "ro_tasks",
287 q_filter={
288 "target_id": target_id,
289 "tasks.status": ["SCHEDULED", "BUILD", "DONE", "FAILED"],
290 },
291 fail_on_empty=False,
292 ):
293 vims_to_unload.append(target_id)
294
295 for target_id in vims_to_unload:
296 self._unload_vim(target_id)
297
298 def _get_cloud_init(self, where):
299 """
300 Not used as cloud init content is provided in the http body. This method reads cloud init from a file
301 :param where: can be 'vnfr_id:file:file_name' or 'vnfr_id:vdu:vdu_idex'
302 :return:
303 """
304 vnfd_id, _, other = where.partition(":")
305 _type, _, name = other.partition(":")
306 vnfd = self.db.get_one("vnfds", {"_id": vnfd_id})
307
308 if _type == "file":
309 base_folder = vnfd["_admin"]["storage"]
310 cloud_init_file = "{}/{}/cloud_init/{}".format(
311 base_folder["folder"], base_folder["pkg-dir"], name
312 )
313
314 if not self.fs:
315 raise NsException(
316 "Cannot read file '{}'. Filesystem not loaded, change configuration at storage.driver".format(
317 cloud_init_file
318 )
319 )
320
321 with self.fs.file_open(cloud_init_file, "r") as ci_file:
322 cloud_init_content = ci_file.read()
323 elif _type == "vdu":
324 cloud_init_content = vnfd["vdu"][int(name)]["cloud-init"]
325 else:
326 raise NsException("Mismatch descriptor for cloud init: {}".format(where))
327
328 return cloud_init_content
329
330 def _parse_jinja2(self, cloud_init_content, params, context):
331 try:
332 env = Environment(undefined=StrictUndefined)
333 template = env.from_string(cloud_init_content)
334
335 return template.render(params or {})
336 except UndefinedError as e:
337 raise NsException(
338 "Variable '{}' defined at vnfd='{}' must be provided in the instantiation parameters"
339 "inside the 'additionalParamsForVnf' block".format(e, context)
340 )
341 except (TemplateError, TemplateNotFound) as e:
342 raise NsException(
343 "Error parsing Jinja2 to cloud-init content at vnfd='{}': {}".format(
344 context, e
345 )
346 )
347
348 def _create_db_ro_nsrs(self, nsr_id, now):
349 try:
350 key = rsa.generate_private_key(
351 backend=crypto_default_backend(), public_exponent=65537, key_size=2048
352 )
353 private_key = key.private_bytes(
354 crypto_serialization.Encoding.PEM,
355 crypto_serialization.PrivateFormat.PKCS8,
356 crypto_serialization.NoEncryption(),
357 )
358 public_key = key.public_key().public_bytes(
359 crypto_serialization.Encoding.OpenSSH,
360 crypto_serialization.PublicFormat.OpenSSH,
361 )
362 private_key = private_key.decode("utf8")
363 # Change first line because Paramiko needs a explicit start with 'BEGIN RSA PRIVATE KEY'
364 i = private_key.find("\n")
365 private_key = "-----BEGIN RSA PRIVATE KEY-----" + private_key[i:]
366 public_key = public_key.decode("utf8")
367 except Exception as e:
368 raise NsException("Cannot create ssh-keys: {}".format(e))
369
370 schema_version = "1.1"
371 private_key_encrypted = self.db.encrypt(
372 private_key, schema_version=schema_version, salt=nsr_id
373 )
374 db_content = {
375 "_id": nsr_id,
376 "_admin": {
377 "created": now,
378 "modified": now,
379 "schema_version": schema_version,
380 },
381 "public_key": public_key,
382 "private_key": private_key_encrypted,
383 "actions": [],
384 }
385 self.db.create("ro_nsrs", db_content)
386
387 return db_content
388
389 @staticmethod
390 def _create_task(
391 deployment_info: Dict[str, Any],
392 target_id: str,
393 item: str,
394 action: str,
395 target_record: str,
396 target_record_id: str,
397 extra_dict: Dict[str, Any] = None,
398 ) -> Dict[str, Any]:
399 """Function to create task dict from deployment information.
400
401 Args:
402 deployment_info (Dict[str, Any]): [description]
403 target_id (str): [description]
404 item (str): [description]
405 action (str): [description]
406 target_record (str): [description]
407 target_record_id (str): [description]
408 extra_dict (Dict[str, Any], optional): [description]. Defaults to None.
409
410 Returns:
411 Dict[str, Any]: [description]
412 """
413 task = {
414 "target_id": target_id, # it will be removed before pushing at database
415 "action_id": deployment_info.get("action_id"),
416 "nsr_id": deployment_info.get("nsr_id"),
417 "task_id": f"{deployment_info.get('action_id')}:{deployment_info.get('task_index')}",
418 "status": "SCHEDULED",
419 "action": action,
420 "item": item,
421 "target_record": target_record,
422 "target_record_id": target_record_id,
423 }
424
425 if extra_dict:
426 task.update(extra_dict) # params, find_params, depends_on
427
428 deployment_info["task_index"] = deployment_info.get("task_index", 0) + 1
429
430 return task
431
432 @staticmethod
433 def _create_ro_task(
434 target_id: str,
435 task: Dict[str, Any],
436 ) -> Dict[str, Any]:
437 """Function to create an RO task from task information.
438
439 Args:
440 target_id (str): [description]
441 task (Dict[str, Any]): [description]
442
443 Returns:
444 Dict[str, Any]: [description]
445 """
446 now = time()
447
448 _id = task.get("task_id")
449 db_ro_task = {
450 "_id": _id,
451 "locked_by": None,
452 "locked_at": 0.0,
453 "target_id": target_id,
454 "vim_info": {
455 "created": False,
456 "created_items": None,
457 "vim_id": None,
458 "vim_name": None,
459 "vim_status": None,
460 "vim_details": None,
461 "refresh_at": None,
462 },
463 "modified_at": now,
464 "created_at": now,
465 "to_check_at": now,
466 "tasks": [task],
467 }
468
469 return db_ro_task
470
471 @staticmethod
472 def _process_image_params(
473 target_image: Dict[str, Any],
474 vim_info: Dict[str, Any],
475 target_record_id: str,
476 ) -> Dict[str, Any]:
477 """Function to process VDU image parameters.
478
479 Args:
480 target_image (Dict[str, Any]): [description]
481 vim_info (Dict[str, Any]): [description]
482 target_record_id (str): [description]
483
484 Returns:
485 Dict[str, Any]: [description]
486 """
487 find_params = {}
488
489 if target_image.get("image"):
490 find_params["filter_dict"] = {"name": target_image.get("image")}
491
492 if target_image.get("vim_image_id"):
493 find_params["filter_dict"] = {"id": target_image.get("vim_image_id")}
494
495 if target_image.get("image_checksum"):
496 find_params["filter_dict"] = {
497 "checksum": target_image.get("image_checksum")
498 }
499
500 return {"find_params": find_params}
501
502 def deploy(self, session, indata, version, nsr_id, *args, **kwargs):
503 self.logger.debug("ns.deploy nsr_id={} indata={}".format(nsr_id, indata))
504 validate_input(indata, deploy_schema)
505 action_id = indata.get("action_id", str(uuid4()))
506 task_index = 0
507 # get current deployment
508 db_nsr_update = {} # update operation on nsrs
509 db_vnfrs_update = {}
510 db_vnfrs = {} # vnf's info indexed by _id
511 nb_ro_tasks = 0 # for logging
512 vdu2cloud_init = indata.get("cloud_init_content") or {}
513 step = ""
514 logging_text = "Task deploy nsr_id={} action_id={} ".format(nsr_id, action_id)
515 self.logger.debug(logging_text + "Enter")
516
517 try:
518 step = "Getting ns and vnfr record from db"
519 db_nsr = self.db.get_one("nsrs", {"_id": nsr_id})
520 db_new_tasks = []
521 tasks_by_target_record_id = {}
522 # read from db: vnf's of this ns
523 step = "Getting vnfrs from db"
524 db_vnfrs_list = self.db.get_list("vnfrs", {"nsr-id-ref": nsr_id})
525
526 if not db_vnfrs_list:
527 raise NsException("Cannot obtain associated VNF for ns")
528
529 for vnfr in db_vnfrs_list:
530 db_vnfrs[vnfr["_id"]] = vnfr
531 db_vnfrs_update[vnfr["_id"]] = {}
532
533 now = time()
534 db_ro_nsr = self.db.get_one("ro_nsrs", {"_id": nsr_id}, fail_on_empty=False)
535
536 if not db_ro_nsr:
537 db_ro_nsr = self._create_db_ro_nsrs(nsr_id, now)
538
539 ro_nsr_public_key = db_ro_nsr["public_key"]
540
541 # check that action_id is not in the list of actions. Suffixed with :index
542 if action_id in db_ro_nsr["actions"]:
543 index = 1
544
545 while True:
546 new_action_id = "{}:{}".format(action_id, index)
547
548 if new_action_id not in db_ro_nsr["actions"]:
549 action_id = new_action_id
550 self.logger.debug(
551 logging_text
552 + "Changing action_id in use to {}".format(action_id)
553 )
554 break
555
556 index += 1
557
558 def _process_flavor_params(target_flavor, vim_info, target_record_id):
559 def _get_resource_allocation_params(quota_descriptor):
560 """
561 read the quota_descriptor from vnfd and fetch the resource allocation properties from the
562 descriptor object
563 :param quota_descriptor: cpu/mem/vif/disk-io quota descriptor
564 :return: quota params for limit, reserve, shares from the descriptor object
565 """
566 quota = {}
567
568 if quota_descriptor.get("limit"):
569 quota["limit"] = int(quota_descriptor["limit"])
570
571 if quota_descriptor.get("reserve"):
572 quota["reserve"] = int(quota_descriptor["reserve"])
573
574 if quota_descriptor.get("shares"):
575 quota["shares"] = int(quota_descriptor["shares"])
576
577 return quota
578
579 flavor_data = {
580 "disk": int(target_flavor["storage-gb"]),
581 "ram": int(target_flavor["memory-mb"]),
582 "vcpus": int(target_flavor["vcpu-count"]),
583 }
584 numa = {}
585 extended = {}
586
587 if target_flavor.get("guest-epa"):
588 extended = {}
589 epa_vcpu_set = False
590
591 if target_flavor["guest-epa"].get("numa-node-policy"):
592 numa_node_policy = target_flavor["guest-epa"].get(
593 "numa-node-policy"
594 )
595
596 if numa_node_policy.get("node"):
597 numa_node = numa_node_policy["node"][0]
598
599 if numa_node.get("num-cores"):
600 numa["cores"] = numa_node["num-cores"]
601 epa_vcpu_set = True
602
603 if numa_node.get("paired-threads"):
604 if numa_node["paired-threads"].get(
605 "num-paired-threads"
606 ):
607 numa["paired-threads"] = int(
608 numa_node["paired-threads"][
609 "num-paired-threads"
610 ]
611 )
612 epa_vcpu_set = True
613
614 if len(
615 numa_node["paired-threads"].get("paired-thread-ids")
616 ):
617 numa["paired-threads-id"] = []
618
619 for pair in numa_node["paired-threads"][
620 "paired-thread-ids"
621 ]:
622 numa["paired-threads-id"].append(
623 (
624 str(pair["thread-a"]),
625 str(pair["thread-b"]),
626 )
627 )
628
629 if numa_node.get("num-threads"):
630 numa["threads"] = int(numa_node["num-threads"])
631 epa_vcpu_set = True
632
633 if numa_node.get("memory-mb"):
634 numa["memory"] = max(
635 int(numa_node["memory-mb"] / 1024), 1
636 )
637
638 if target_flavor["guest-epa"].get("mempage-size"):
639 extended["mempage-size"] = target_flavor["guest-epa"].get(
640 "mempage-size"
641 )
642
643 if (
644 target_flavor["guest-epa"].get("cpu-pinning-policy")
645 and not epa_vcpu_set
646 ):
647 if (
648 target_flavor["guest-epa"]["cpu-pinning-policy"]
649 == "DEDICATED"
650 ):
651 if (
652 target_flavor["guest-epa"].get(
653 "cpu-thread-pinning-policy"
654 )
655 and target_flavor["guest-epa"][
656 "cpu-thread-pinning-policy"
657 ]
658 != "PREFER"
659 ):
660 numa["cores"] = max(flavor_data["vcpus"], 1)
661 else:
662 numa["threads"] = max(flavor_data["vcpus"], 1)
663
664 epa_vcpu_set = True
665
666 if target_flavor["guest-epa"].get("cpu-quota") and not epa_vcpu_set:
667 cpuquota = _get_resource_allocation_params(
668 target_flavor["guest-epa"].get("cpu-quota")
669 )
670
671 if cpuquota:
672 extended["cpu-quota"] = cpuquota
673
674 if target_flavor["guest-epa"].get("mem-quota"):
675 vduquota = _get_resource_allocation_params(
676 target_flavor["guest-epa"].get("mem-quota")
677 )
678
679 if vduquota:
680 extended["mem-quota"] = vduquota
681
682 if target_flavor["guest-epa"].get("disk-io-quota"):
683 diskioquota = _get_resource_allocation_params(
684 target_flavor["guest-epa"].get("disk-io-quota")
685 )
686
687 if diskioquota:
688 extended["disk-io-quota"] = diskioquota
689
690 if target_flavor["guest-epa"].get("vif-quota"):
691 vifquota = _get_resource_allocation_params(
692 target_flavor["guest-epa"].get("vif-quota")
693 )
694
695 if vifquota:
696 extended["vif-quota"] = vifquota
697
698 if numa:
699 extended["numas"] = [numa]
700
701 if extended:
702 flavor_data["extended"] = extended
703
704 extra_dict = {"find_params": {"flavor_data": flavor_data}}
705 flavor_data_name = flavor_data.copy()
706 flavor_data_name["name"] = target_flavor["name"]
707 extra_dict["params"] = {"flavor_data": flavor_data_name}
708
709 return extra_dict
710
711 def _ip_profile_2_ro(ip_profile):
712 if not ip_profile:
713 return None
714
715 ro_ip_profile = {
716 "ip_version": "IPv4"
717 if "v4" in ip_profile.get("ip-version", "ipv4")
718 else "IPv6",
719 "subnet_address": ip_profile.get("subnet-address"),
720 "gateway_address": ip_profile.get("gateway-address"),
721 "dhcp_enabled": ip_profile.get("dhcp-params", {}).get(
722 "enabled", False
723 ),
724 "dhcp_start_address": ip_profile.get("dhcp-params", {}).get(
725 "start-address", None
726 ),
727 "dhcp_count": ip_profile.get("dhcp-params", {}).get("count", None),
728 }
729
730 if ip_profile.get("dns-server"):
731 ro_ip_profile["dns_address"] = ";".join(
732 [v["address"] for v in ip_profile["dns-server"]]
733 )
734
735 if ip_profile.get("security-group"):
736 ro_ip_profile["security_group"] = ip_profile["security-group"]
737
738 return ro_ip_profile
739
740 def _process_net_params(target_vld, vim_info, target_record_id):
741 nonlocal indata
742 extra_dict = {}
743
744 if vim_info.get("sdn"):
745 # vnf_preffix = "vnfrs:{}".format(vnfr_id)
746 # ns_preffix = "nsrs:{}".format(nsr_id)
747 # remove the ending ".sdn
748 vld_target_record_id, _, _ = target_record_id.rpartition(".")
749 extra_dict["params"] = {
750 k: vim_info[k]
751 for k in ("sdn-ports", "target_vim", "vlds", "type")
752 if vim_info.get(k)
753 }
754
755 # TODO needed to add target_id in the dependency.
756 if vim_info.get("target_vim"):
757 extra_dict["depends_on"] = [
758 vim_info.get("target_vim") + " " + vld_target_record_id
759 ]
760
761 return extra_dict
762
763 if vim_info.get("vim_network_name"):
764 extra_dict["find_params"] = {
765 "filter_dict": {"name": vim_info.get("vim_network_name")}
766 }
767 elif vim_info.get("vim_network_id"):
768 extra_dict["find_params"] = {
769 "filter_dict": {"id": vim_info.get("vim_network_id")}
770 }
771 elif target_vld.get("mgmt-network"):
772 extra_dict["find_params"] = {"mgmt": True, "name": target_vld["id"]}
773 else:
774 # create
775 extra_dict["params"] = {
776 "net_name": "{}-{}".format(
777 indata["name"][:16],
778 target_vld.get("name", target_vld["id"])[:16],
779 ),
780 "ip_profile": _ip_profile_2_ro(vim_info.get("ip_profile")),
781 "provider_network_profile": vim_info.get("provider_network"),
782 }
783
784 if not target_vld.get("underlay"):
785 extra_dict["params"]["net_type"] = "bridge"
786 else:
787 extra_dict["params"]["net_type"] = (
788 "ptp" if target_vld.get("type") == "ELINE" else "data"
789 )
790
791 return extra_dict
792
793 def _process_vdu_params(target_vdu, vim_info, target_record_id):
794 nonlocal vnfr_id
795 nonlocal nsr_id
796 nonlocal indata
797 nonlocal vnfr
798 nonlocal vdu2cloud_init
799 nonlocal tasks_by_target_record_id
800
801 vnf_preffix = "vnfrs:{}".format(vnfr_id)
802 ns_preffix = "nsrs:{}".format(nsr_id)
803 image_text = ns_preffix + ":image." + target_vdu["ns-image-id"]
804 flavor_text = ns_preffix + ":flavor." + target_vdu["ns-flavor-id"]
805 extra_dict = {"depends_on": [image_text, flavor_text]}
806 net_list = []
807
808 for iface_index, interface in enumerate(target_vdu["interfaces"]):
809 if interface.get("ns-vld-id"):
810 net_text = ns_preffix + ":vld." + interface["ns-vld-id"]
811 elif interface.get("vnf-vld-id"):
812 net_text = vnf_preffix + ":vld." + interface["vnf-vld-id"]
813 else:
814 self.logger.error(
815 "Interface {} from vdu {} not connected to any vld".format(
816 iface_index, target_vdu["vdu-name"]
817 )
818 )
819
820 continue # interface not connected to any vld
821
822 extra_dict["depends_on"].append(net_text)
823
824 if "port-security-enabled" in interface:
825 interface["port_security"] = interface.pop(
826 "port-security-enabled"
827 )
828
829 if "port-security-disable-strategy" in interface:
830 interface["port_security_disable_strategy"] = interface.pop(
831 "port-security-disable-strategy"
832 )
833
834 net_item = {
835 x: v
836 for x, v in interface.items()
837 if x
838 in (
839 "name",
840 "vpci",
841 "port_security",
842 "port_security_disable_strategy",
843 "floating_ip",
844 )
845 }
846 net_item["net_id"] = "TASK-" + net_text
847 net_item["type"] = "virtual"
848
849 # TODO mac_address: used for SR-IOV ifaces #TODO for other types
850 # TODO floating_ip: True/False (or it can be None)
851 if interface.get("type") in ("SR-IOV", "PCI-PASSTHROUGH"):
852 # mark the net create task as type data
853 if deep_get(
854 tasks_by_target_record_id, net_text, "params", "net_type"
855 ):
856 tasks_by_target_record_id[net_text]["params"][
857 "net_type"
858 ] = "data"
859
860 net_item["use"] = "data"
861 net_item["model"] = interface["type"]
862 net_item["type"] = interface["type"]
863 elif (
864 interface.get("type") == "OM-MGMT"
865 or interface.get("mgmt-interface")
866 or interface.get("mgmt-vnf")
867 ):
868 net_item["use"] = "mgmt"
869 else:
870 # if interface.get("type") in ("VIRTIO", "E1000", "PARAVIRT"):
871 net_item["use"] = "bridge"
872 net_item["model"] = interface.get("type")
873
874 if interface.get("ip-address"):
875 net_item["ip_address"] = interface["ip-address"]
876
877 if interface.get("mac-address"):
878 net_item["mac_address"] = interface["mac-address"]
879
880 net_list.append(net_item)
881
882 if interface.get("mgmt-vnf"):
883 extra_dict["mgmt_vnf_interface"] = iface_index
884 elif interface.get("mgmt-interface"):
885 extra_dict["mgmt_vdu_interface"] = iface_index
886
887 # cloud config
888 cloud_config = {}
889
890 if target_vdu.get("cloud-init"):
891 if target_vdu["cloud-init"] not in vdu2cloud_init:
892 vdu2cloud_init[target_vdu["cloud-init"]] = self._get_cloud_init(
893 target_vdu["cloud-init"]
894 )
895
896 cloud_content_ = vdu2cloud_init[target_vdu["cloud-init"]]
897 cloud_config["user-data"] = self._parse_jinja2(
898 cloud_content_,
899 target_vdu.get("additionalParams"),
900 target_vdu["cloud-init"],
901 )
902
903 if target_vdu.get("boot-data-drive"):
904 cloud_config["boot-data-drive"] = target_vdu.get("boot-data-drive")
905
906 ssh_keys = []
907
908 if target_vdu.get("ssh-keys"):
909 ssh_keys += target_vdu.get("ssh-keys")
910
911 if target_vdu.get("ssh-access-required"):
912 ssh_keys.append(ro_nsr_public_key)
913
914 if ssh_keys:
915 cloud_config["key-pairs"] = ssh_keys
916
917 disk_list = None
918 if target_vdu.get("virtual-storages"):
919 disk_list = [
920 {"size": disk["size-of-storage"]}
921 for disk in target_vdu["virtual-storages"]
922 if disk.get("type-of-storage")
923 == "persistent-storage:persistent-storage"
924 ]
925
926 extra_dict["params"] = {
927 "name": "{}-{}-{}-{}".format(
928 indata["name"][:16],
929 vnfr["member-vnf-index-ref"][:16],
930 target_vdu["vdu-name"][:32],
931 target_vdu.get("count-index") or 0,
932 ),
933 "description": target_vdu["vdu-name"],
934 "start": True,
935 "image_id": "TASK-" + image_text,
936 "flavor_id": "TASK-" + flavor_text,
937 "net_list": net_list,
938 "cloud_config": cloud_config or None,
939 "disk_list": disk_list,
940 "availability_zone_index": None, # TODO
941 "availability_zone_list": None, # TODO
942 }
943
944 return extra_dict
945
946 def _process_items(
947 target_list,
948 existing_list,
949 db_record,
950 db_update,
951 db_path,
952 item,
953 process_params,
954 ):
955 nonlocal db_new_tasks
956 nonlocal tasks_by_target_record_id
957 nonlocal action_id
958 nonlocal nsr_id
959 nonlocal task_index
960
961 # ensure all the target_list elements has an "id". If not assign the index as id
962 for target_index, tl in enumerate(target_list):
963 if tl and not tl.get("id"):
964 tl["id"] = str(target_index)
965
966 # step 1 items (networks,vdus,...) to be deleted/updated
967 for item_index, existing_item in enumerate(existing_list):
968 target_item = next(
969 (t for t in target_list if t["id"] == existing_item["id"]), None
970 )
971
972 for target_vim, existing_viminfo in existing_item.get(
973 "vim_info", {}
974 ).items():
975 if existing_viminfo is None:
976 continue
977
978 if target_item:
979 target_viminfo = target_item.get("vim_info", {}).get(
980 target_vim
981 )
982 else:
983 target_viminfo = None
984
985 if target_viminfo is None:
986 # must be deleted
987 self._assign_vim(target_vim)
988 target_record_id = "{}.{}".format(
989 db_record, existing_item["id"]
990 )
991 item_ = item
992
993 if target_vim.startswith("sdn"):
994 # item must be sdn-net instead of net if target_vim is a sdn
995 item_ = "sdn_net"
996 target_record_id += ".sdn"
997
998 deployment_info = {
999 "action_id": action_id,
1000 "nsr_id": nsr_id,
1001 "task_index": task_index,
1002 }
1003
1004 task = Ns._create_task(
1005 deployment_info=deployment_info,
1006 target_id=target_vim,
1007 item=item_,
1008 action="DELETE",
1009 target_record=f"{db_record}.{item_index}.vim_info.{target_vim}",
1010 target_record_id=target_record_id,
1011 )
1012
1013 task_index = deployment_info.get("task_index")
1014
1015 tasks_by_target_record_id[target_record_id] = task
1016 db_new_tasks.append(task)
1017 # TODO delete
1018 # TODO check one by one the vims to be created/deleted
1019
1020 # step 2 items (networks,vdus,...) to be created
1021 for target_item in target_list:
1022 item_index = -1
1023
1024 for item_index, existing_item in enumerate(existing_list):
1025 if existing_item["id"] == target_item["id"]:
1026 break
1027 else:
1028 item_index += 1
1029 db_update[db_path + ".{}".format(item_index)] = target_item
1030 existing_list.append(target_item)
1031 existing_item = None
1032
1033 for target_vim, target_viminfo in target_item.get(
1034 "vim_info", {}
1035 ).items():
1036 existing_viminfo = None
1037
1038 if existing_item:
1039 existing_viminfo = existing_item.get("vim_info", {}).get(
1040 target_vim
1041 )
1042
1043 # TODO check if different. Delete and create???
1044 # TODO delete if not exist
1045 if existing_viminfo is not None:
1046 continue
1047
1048 target_record_id = "{}.{}".format(db_record, target_item["id"])
1049 item_ = item
1050
1051 if target_vim.startswith("sdn"):
1052 # item must be sdn-net instead of net if target_vim is a sdn
1053 item_ = "sdn_net"
1054 target_record_id += ".sdn"
1055
1056 extra_dict = process_params(
1057 target_item, target_viminfo, target_record_id
1058 )
1059 self._assign_vim(target_vim)
1060
1061 deployment_info = {
1062 "action_id": action_id,
1063 "nsr_id": nsr_id,
1064 "task_index": task_index,
1065 }
1066
1067 task = Ns._create_task(
1068 deployment_info=deployment_info,
1069 target_id=target_vim,
1070 item=item_,
1071 action="CREATE",
1072 target_record=f"{db_record}.{item_index}.vim_info.{target_vim}",
1073 target_record_id=target_record_id,
1074 extra_dict=extra_dict,
1075 )
1076
1077 task_index = deployment_info.get("task_index")
1078
1079 tasks_by_target_record_id[target_record_id] = task
1080 db_new_tasks.append(task)
1081
1082 if target_item.get("common_id"):
1083 task["common_id"] = target_item["common_id"]
1084
1085 db_update[db_path + ".{}".format(item_index)] = target_item
1086
1087 def _process_action(indata):
1088 nonlocal db_new_tasks
1089 nonlocal action_id
1090 nonlocal nsr_id
1091 nonlocal task_index
1092 nonlocal db_vnfrs
1093 nonlocal db_ro_nsr
1094
1095 if indata["action"]["action"] == "inject_ssh_key":
1096 key = indata["action"].get("key")
1097 user = indata["action"].get("user")
1098 password = indata["action"].get("password")
1099
1100 for vnf in indata.get("vnf", ()):
1101 if vnf["_id"] not in db_vnfrs:
1102 raise NsException("Invalid vnf={}".format(vnf["_id"]))
1103
1104 db_vnfr = db_vnfrs[vnf["_id"]]
1105
1106 for target_vdu in vnf.get("vdur", ()):
1107 vdu_index, vdur = next(
1108 (
1109 i_v
1110 for i_v in enumerate(db_vnfr["vdur"])
1111 if i_v[1]["id"] == target_vdu["id"]
1112 ),
1113 (None, None),
1114 )
1115
1116 if not vdur:
1117 raise NsException(
1118 "Invalid vdu vnf={}.{}".format(
1119 vnf["_id"], target_vdu["id"]
1120 )
1121 )
1122
1123 target_vim, vim_info = next(
1124 k_v for k_v in vdur["vim_info"].items()
1125 )
1126 self._assign_vim(target_vim)
1127 target_record = "vnfrs:{}:vdur.{}.ssh_keys".format(
1128 vnf["_id"], vdu_index
1129 )
1130 extra_dict = {
1131 "depends_on": [
1132 "vnfrs:{}:vdur.{}".format(vnf["_id"], vdur["id"])
1133 ],
1134 "params": {
1135 "ip_address": vdur.get("ip-address"),
1136 "user": user,
1137 "key": key,
1138 "password": password,
1139 "private_key": db_ro_nsr["private_key"],
1140 "salt": db_ro_nsr["_id"],
1141 "schema_version": db_ro_nsr["_admin"][
1142 "schema_version"
1143 ],
1144 },
1145 }
1146
1147 deployment_info = {
1148 "action_id": action_id,
1149 "nsr_id": nsr_id,
1150 "task_index": task_index,
1151 }
1152
1153 task = Ns._create_task(
1154 deployment_info=deployment_info,
1155 target_id=target_vim,
1156 item="vdu",
1157 action="EXEC",
1158 target_record=target_record,
1159 target_record_id=None,
1160 extra_dict=extra_dict,
1161 )
1162
1163 task_index = deployment_info.get("task_index")
1164
1165 db_new_tasks.append(task)
1166
1167 with self.write_lock:
1168 if indata.get("action"):
1169 _process_action(indata)
1170 else:
1171 # compute network differences
1172 # NS.vld
1173 step = "process NS VLDs"
1174 _process_items(
1175 target_list=indata["ns"]["vld"] or [],
1176 existing_list=db_nsr.get("vld") or [],
1177 db_record="nsrs:{}:vld".format(nsr_id),
1178 db_update=db_nsr_update,
1179 db_path="vld",
1180 item="net",
1181 process_params=_process_net_params,
1182 )
1183
1184 step = "process NS images"
1185 _process_items(
1186 target_list=indata.get("image") or [],
1187 existing_list=db_nsr.get("image") or [],
1188 db_record="nsrs:{}:image".format(nsr_id),
1189 db_update=db_nsr_update,
1190 db_path="image",
1191 item="image",
1192 process_params=Ns._process_image_params,
1193 )
1194
1195 step = "process NS flavors"
1196 _process_items(
1197 target_list=indata.get("flavor") or [],
1198 existing_list=db_nsr.get("flavor") or [],
1199 db_record="nsrs:{}:flavor".format(nsr_id),
1200 db_update=db_nsr_update,
1201 db_path="flavor",
1202 item="flavor",
1203 process_params=_process_flavor_params,
1204 )
1205
1206 # VNF.vld
1207 for vnfr_id, vnfr in db_vnfrs.items():
1208 # vnfr_id need to be set as global variable for among others nested method _process_vdu_params
1209 step = "process VNF={} VLDs".format(vnfr_id)
1210 target_vnf = next(
1211 (
1212 vnf
1213 for vnf in indata.get("vnf", ())
1214 if vnf["_id"] == vnfr_id
1215 ),
1216 None,
1217 )
1218 target_list = target_vnf.get("vld") if target_vnf else None
1219 _process_items(
1220 target_list=target_list or [],
1221 existing_list=vnfr.get("vld") or [],
1222 db_record="vnfrs:{}:vld".format(vnfr_id),
1223 db_update=db_vnfrs_update[vnfr["_id"]],
1224 db_path="vld",
1225 item="net",
1226 process_params=_process_net_params,
1227 )
1228
1229 target_list = target_vnf.get("vdur") if target_vnf else None
1230 step = "process VNF={} VDUs".format(vnfr_id)
1231 _process_items(
1232 target_list=target_list or [],
1233 existing_list=vnfr.get("vdur") or [],
1234 db_record="vnfrs:{}:vdur".format(vnfr_id),
1235 db_update=db_vnfrs_update[vnfr["_id"]],
1236 db_path="vdur",
1237 item="vdu",
1238 process_params=_process_vdu_params,
1239 )
1240
1241 for db_task in db_new_tasks:
1242 step = "Updating database, Appending tasks to ro_tasks"
1243 target_id = db_task.pop("target_id")
1244 common_id = db_task.get("common_id")
1245
1246 if common_id:
1247 if self.db.set_one(
1248 "ro_tasks",
1249 q_filter={
1250 "target_id": target_id,
1251 "tasks.common_id": common_id,
1252 },
1253 update_dict={"to_check_at": now, "modified_at": now},
1254 push={"tasks": db_task},
1255 fail_on_empty=False,
1256 ):
1257 continue
1258
1259 if not self.db.set_one(
1260 "ro_tasks",
1261 q_filter={
1262 "target_id": target_id,
1263 "tasks.target_record": db_task["target_record"],
1264 },
1265 update_dict={"to_check_at": now, "modified_at": now},
1266 push={"tasks": db_task},
1267 fail_on_empty=False,
1268 ):
1269 # Create a ro_task
1270 step = "Updating database, Creating ro_tasks"
1271 db_ro_task = Ns._create_ro_task(target_id, db_task)
1272 nb_ro_tasks += 1
1273 self.db.create("ro_tasks", db_ro_task)
1274
1275 step = "Updating database, nsrs"
1276 if db_nsr_update:
1277 self.db.set_one("nsrs", {"_id": nsr_id}, db_nsr_update)
1278
1279 for vnfr_id, db_vnfr_update in db_vnfrs_update.items():
1280 if db_vnfr_update:
1281 step = "Updating database, vnfrs={}".format(vnfr_id)
1282 self.db.set_one("vnfrs", {"_id": vnfr_id}, db_vnfr_update)
1283
1284 self.logger.debug(
1285 logging_text
1286 + "Exit. Created {} ro_tasks; {} tasks".format(
1287 nb_ro_tasks, len(db_new_tasks)
1288 )
1289 )
1290
1291 return (
1292 {"status": "ok", "nsr_id": nsr_id, "action_id": action_id},
1293 action_id,
1294 True,
1295 )
1296 except Exception as e:
1297 if isinstance(e, (DbException, NsException)):
1298 self.logger.error(
1299 logging_text + "Exit Exception while '{}': {}".format(step, e)
1300 )
1301 else:
1302 e = traceback_format_exc()
1303 self.logger.critical(
1304 logging_text + "Exit Exception while '{}': {}".format(step, e),
1305 exc_info=True,
1306 )
1307
1308 raise NsException(e)
1309
1310 def delete(self, session, indata, version, nsr_id, *args, **kwargs):
1311 self.logger.debug("ns.delete version={} nsr_id={}".format(version, nsr_id))
1312 # self.db.del_list({"_id": ro_task["_id"], "tasks.nsr_id.ne": nsr_id})
1313
1314 with self.write_lock:
1315 try:
1316 NsWorker.delete_db_tasks(self.db, nsr_id, None)
1317 except NsWorkerException as e:
1318 raise NsException(e)
1319
1320 return None, None, True
1321
1322 def status(self, session, indata, version, nsr_id, action_id, *args, **kwargs):
1323 # self.logger.debug("ns.status version={} nsr_id={}, action_id={} indata={}"
1324 # .format(version, nsr_id, action_id, indata))
1325 task_list = []
1326 done = 0
1327 total = 0
1328 ro_tasks = self.db.get_list("ro_tasks", {"tasks.action_id": action_id})
1329 global_status = "DONE"
1330 details = []
1331
1332 for ro_task in ro_tasks:
1333 for task in ro_task["tasks"]:
1334 if task and task["action_id"] == action_id:
1335 task_list.append(task)
1336 total += 1
1337
1338 if task["status"] == "FAILED":
1339 global_status = "FAILED"
1340 error_text = "Error at {} {}: {}".format(
1341 task["action"].lower(),
1342 task["item"],
1343 ro_task["vim_info"].get("vim_details") or "unknown",
1344 )
1345 details.append(error_text)
1346 elif task["status"] in ("SCHEDULED", "BUILD"):
1347 if global_status != "FAILED":
1348 global_status = "BUILD"
1349 else:
1350 done += 1
1351
1352 return_data = {
1353 "status": global_status,
1354 "details": ". ".join(details)
1355 if details
1356 else "progress {}/{}".format(done, total),
1357 "nsr_id": nsr_id,
1358 "action_id": action_id,
1359 "tasks": task_list,
1360 }
1361
1362 return return_data, None, True
1363
1364 def cancel(self, session, indata, version, nsr_id, action_id, *args, **kwargs):
1365 print(
1366 "ns.cancel session={} indata={} version={} nsr_id={}, action_id={}".format(
1367 session, indata, version, nsr_id, action_id
1368 )
1369 )
1370
1371 return None, None, True
1372
1373 def get_deploy(self, session, indata, version, nsr_id, action_id, *args, **kwargs):
1374 nsrs = self.db.get_list("nsrs", {})
1375 return_data = []
1376
1377 for ns in nsrs:
1378 return_data.append({"_id": ns["_id"], "name": ns["name"]})
1379
1380 return return_data, None, True
1381
1382 def get_actions(self, session, indata, version, nsr_id, action_id, *args, **kwargs):
1383 ro_tasks = self.db.get_list("ro_tasks", {"tasks.nsr_id": nsr_id})
1384 return_data = []
1385
1386 for ro_task in ro_tasks:
1387 for task in ro_task["tasks"]:
1388 if task["action_id"] not in return_data:
1389 return_data.append(task["action_id"])
1390
1391 return return_data, None, True