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