1 # -*- coding: utf-8 -*-
4 # Copyright 2020 Telefonica Investigacion y Desarrollo, S.A.U.
6 # Licensed under the Apache License, Version 2.0 (the "License"); you may
7 # not use this file except in compliance with the License. You may obtain
8 # a copy of the License at
10 # http://www.apache.org/licenses/LICENSE-2.0
12 # Unless required by applicable law or agreed to in writing, software
13 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
14 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
15 # License for the specific language governing permissions and limitations
21 This is thread that interacts with a VIM. It processes TASKs sequentially against a single VIM.
22 The tasks are stored at database in table ro_tasks
23 A single ro_task refers to a VIM element (flavor, image, network, ...).
24 A ro_task can contain several 'tasks', each one with a target, where to store the results
27 from copy
import deepcopy
28 from http
import HTTPStatus
30 from os
import makedirs
36 from typing
import Dict
37 from unittest
.mock
import Mock
39 from importlib_metadata
import entry_points
40 from osm_common
.dbbase
import DbException
41 from osm_ng_ro
.vim_admin
import LockRenew
42 from osm_ro_plugin
import sdnconn
43 from osm_ro_plugin
import vimconn
44 from osm_ro_plugin
.sdn_dummy
import SdnDummyConnector
45 from osm_ro_plugin
.vim_dummy
import VimDummyConnector
48 __author__
= "Alfonso Tierno"
49 __date__
= "$28-Sep-2017 12:07:15$"
52 def deep_get(target_dict
, *args
, **kwargs
):
54 Get a value from target_dict entering in the nested keys. If keys does not exist, it returns None
55 Example target_dict={a: {b: 5}}; key_list=[a,b] returns 5; both key_list=[a,b,c] and key_list=[f,h] return None
56 :param target_dict: dictionary to be read
57 :param args: list of keys to read from target_dict
58 :param kwargs: only can contain default=value to return if key is not present in the nested dictionary
59 :return: The wanted value if exist, None or default otherwise
62 if not isinstance(target_dict
, dict) or key
not in target_dict
:
63 return kwargs
.get("default")
64 target_dict
= target_dict
[key
]
68 class NsWorkerException(Exception):
72 class FailingConnector
:
73 def __init__(self
, error_msg
):
74 self
.error_msg
= error_msg
76 for method
in dir(vimconn
.VimConnector
):
79 self
, method
, Mock(side_effect
=vimconn
.VimConnException(error_msg
))
82 for method
in dir(sdnconn
.SdnConnectorBase
):
85 self
, method
, Mock(side_effect
=sdnconn
.SdnConnectorError(error_msg
))
89 class NsWorkerExceptionNotFound(NsWorkerException
):
93 class VimInteractionBase
:
94 """Base class to call VIM/SDN for creating, deleting and refresh networks, VMs, flavors, ...
95 It implements methods that does nothing and return ok"""
97 def __init__(self
, db
, my_vims
, db_vims
, logger
):
100 self
.my_vims
= my_vims
101 self
.db_vims
= db_vims
103 def new(self
, ro_task
, task_index
, task_depends
):
106 def refresh(self
, ro_task
):
107 """skip calling VIM to get image, flavor status. Assumes ok"""
108 if ro_task
["vim_info"]["vim_status"] == "VIM_ERROR":
113 def delete(self
, ro_task
, task_index
):
114 """skip calling VIM to delete image. Assumes ok"""
117 def exec(self
, ro_task
, task_index
, task_depends
):
118 return "DONE", None, None
121 class VimInteractionNet(VimInteractionBase
):
122 def new(self
, ro_task
, task_index
, task_depends
):
124 task
= ro_task
["tasks"][task_index
]
125 task_id
= task
["task_id"]
128 target_vim
= self
.my_vims
[ro_task
["target_id"]]
130 mgmtnet_defined_in_vim
= False
134 if task
.get("find_params"):
135 # if management, get configuration of VIM
136 if task
["find_params"].get("filter_dict"):
137 vim_filter
= task
["find_params"]["filter_dict"]
139 elif task
["find_params"].get("mgmt"):
142 self
.db_vims
[ro_task
["target_id"]],
144 "management_network_id",
146 mgmtnet_defined_in_vim
= True
148 "id": self
.db_vims
[ro_task
["target_id"]]["config"][
149 "management_network_id"
153 self
.db_vims
[ro_task
["target_id"]],
155 "management_network_name",
157 mgmtnet_defined_in_vim
= True
159 "name": self
.db_vims
[ro_task
["target_id"]]["config"][
160 "management_network_name"
164 vim_filter
= {"name": task
["find_params"]["name"]}
166 raise NsWorkerExceptionNotFound(
167 "Invalid find_params for new_net {}".format(task
["find_params"])
170 vim_nets
= target_vim
.get_network_list(vim_filter
)
171 if not vim_nets
and not task
.get("params"):
172 # If there is mgmt-network in the descriptor,
173 # there is no mapping of that network to a VIM network in the descriptor,
174 # also there is no mapping in the "--config" parameter or at VIM creation;
175 # that mgmt-network will be created.
176 if mgmtnet
and not mgmtnet_defined_in_vim
:
178 vim_filter
.get("name")
179 if vim_filter
.get("name")
180 else vim_filter
.get("id")[:16]
182 vim_net_id
, created_items
= target_vim
.new_network(
186 "Created mgmt network vim_net_id: {}".format(vim_net_id
)
190 raise NsWorkerExceptionNotFound(
191 "Network not found with this criteria: '{}'".format(
192 task
.get("find_params")
195 elif len(vim_nets
) > 1:
196 raise NsWorkerException(
197 "More than one network found with this criteria: '{}'".format(
203 vim_net_id
= vim_nets
[0]["id"]
206 params
= task
["params"]
207 vim_net_id
, created_items
= target_vim
.new_network(**params
)
210 ro_vim_item_update
= {
211 "vim_id": vim_net_id
,
212 "vim_status": "BUILD",
214 "created_items": created_items
,
219 "task={} {} new-net={} created={}".format(
220 task_id
, ro_task
["target_id"], vim_net_id
, created
224 return "BUILD", ro_vim_item_update
225 except (vimconn
.VimConnException
, NsWorkerException
) as e
:
227 "task={} vim={} new-net: {}".format(task_id
, ro_task
["target_id"], e
)
229 ro_vim_item_update
= {
230 "vim_status": "VIM_ERROR",
232 "vim_message": str(e
),
235 return "FAILED", ro_vim_item_update
237 def refresh(self
, ro_task
):
238 """Call VIM to get network status"""
239 ro_task_id
= ro_task
["_id"]
240 target_vim
= self
.my_vims
[ro_task
["target_id"]]
241 vim_id
= ro_task
["vim_info"]["vim_id"]
242 net_to_refresh_list
= [vim_id
]
245 vim_dict
= target_vim
.refresh_nets_status(net_to_refresh_list
)
246 vim_info
= vim_dict
[vim_id
]
248 if vim_info
["status"] == "ACTIVE":
250 elif vim_info
["status"] == "BUILD":
251 task_status
= "BUILD"
253 task_status
= "FAILED"
254 except vimconn
.VimConnException
as e
:
255 # Mark all tasks at VIM_ERROR status
257 "ro_task={} vim={} get-net={}: {}".format(
258 ro_task_id
, ro_task
["target_id"], vim_id
, e
261 vim_info
= {"status": "VIM_ERROR", "error_msg": str(e
)}
262 task_status
= "FAILED"
264 ro_vim_item_update
= {}
265 if ro_task
["vim_info"]["vim_status"] != vim_info
["status"]:
266 ro_vim_item_update
["vim_status"] = vim_info
["status"]
268 if ro_task
["vim_info"]["vim_name"] != vim_info
.get("name"):
269 ro_vim_item_update
["vim_name"] = vim_info
.get("name")
271 if vim_info
["status"] in ("ERROR", "VIM_ERROR"):
272 if ro_task
["vim_info"]["vim_message"] != vim_info
.get("error_msg"):
273 ro_vim_item_update
["vim_message"] = vim_info
.get("error_msg")
274 elif vim_info
["status"] == "DELETED":
275 ro_vim_item_update
["vim_id"] = None
276 ro_vim_item_update
["vim_message"] = "Deleted externally"
278 if ro_task
["vim_info"]["vim_details"] != vim_info
["vim_info"]:
279 ro_vim_item_update
["vim_details"] = vim_info
["vim_info"]
281 if ro_vim_item_update
:
283 "ro_task={} {} get-net={}: status={} {}".format(
285 ro_task
["target_id"],
287 ro_vim_item_update
.get("vim_status"),
288 ro_vim_item_update
.get("vim_message")
289 if ro_vim_item_update
.get("vim_status") != "ACTIVE"
294 return task_status
, ro_vim_item_update
296 def delete(self
, ro_task
, task_index
):
297 task
= ro_task
["tasks"][task_index
]
298 task_id
= task
["task_id"]
299 net_vim_id
= ro_task
["vim_info"]["vim_id"]
300 ro_vim_item_update_ok
= {
301 "vim_status": "DELETED",
303 "vim_message": "DELETED",
308 if net_vim_id
or ro_task
["vim_info"]["created_items"]:
309 target_vim
= self
.my_vims
[ro_task
["target_id"]]
310 target_vim
.delete_network(
311 net_vim_id
, ro_task
["vim_info"]["created_items"]
313 except vimconn
.VimConnNotFoundException
:
314 ro_vim_item_update_ok
["vim_message"] = "already deleted"
315 except vimconn
.VimConnException
as e
:
317 "ro_task={} vim={} del-net={}: {}".format(
318 ro_task
["_id"], ro_task
["target_id"], net_vim_id
, e
321 ro_vim_item_update
= {
322 "vim_status": "VIM_ERROR",
323 "vim_message": "Error while deleting: {}".format(e
),
326 return "FAILED", ro_vim_item_update
329 "task={} {} del-net={} {}".format(
331 ro_task
["target_id"],
333 ro_vim_item_update_ok
.get("vim_message", ""),
337 return "DONE", ro_vim_item_update_ok
340 class VimInteractionVdu(VimInteractionBase
):
341 max_retries_inject_ssh_key
= 20 # 20 times
342 time_retries_inject_ssh_key
= 30 # wevery 30 seconds
344 def new(self
, ro_task
, task_index
, task_depends
):
345 task
= ro_task
["tasks"][task_index
]
346 task_id
= task
["task_id"]
349 target_vim
= self
.my_vims
[ro_task
["target_id"]]
353 params
= task
["params"]
354 params_copy
= deepcopy(params
)
355 net_list
= params_copy
["net_list"]
358 # change task_id into network_id
359 if "net_id" in net
and net
["net_id"].startswith("TASK-"):
360 network_id
= task_depends
[net
["net_id"]]
363 raise NsWorkerException(
364 "Cannot create VM because depends on a network not created or found "
365 "for {}".format(net
["net_id"])
368 net
["net_id"] = network_id
370 if params_copy
["image_id"].startswith("TASK-"):
371 params_copy
["image_id"] = task_depends
[params_copy
["image_id"]]
373 if params_copy
["flavor_id"].startswith("TASK-"):
374 params_copy
["flavor_id"] = task_depends
[params_copy
["flavor_id"]]
376 affinity_group_list
= params_copy
["affinity_group_list"]
377 for affinity_group
in affinity_group_list
:
378 # change task_id into affinity_group_id
379 if "affinity_group_id" in affinity_group
and affinity_group
[
381 ].startswith("TASK-"):
382 affinity_group_id
= task_depends
[
383 affinity_group
["affinity_group_id"]
386 if not affinity_group_id
:
387 raise NsWorkerException(
388 "found for {}".format(affinity_group
["affinity_group_id"])
391 affinity_group
["affinity_group_id"] = affinity_group_id
393 vim_vm_id
, created_items
= target_vim
.new_vminstance(**params_copy
)
394 interfaces
= [iface
["vim_id"] for iface
in params_copy
["net_list"]]
396 # add to created items previous_created_volumes (healing)
397 if task
.get("previous_created_volumes"):
398 for k
, v
in task
["previous_created_volumes"].items():
401 ro_vim_item_update
= {
403 "vim_status": "BUILD",
405 "created_items": created_items
,
408 "interfaces_vim_ids": interfaces
,
410 "interfaces_backup": [],
413 "task={} {} new-vm={} created={}".format(
414 task_id
, ro_task
["target_id"], vim_vm_id
, created
418 return "BUILD", ro_vim_item_update
419 except (vimconn
.VimConnException
, NsWorkerException
) as e
:
420 self
.logger
.debug(traceback
.format_exc())
422 "task={} {} new-vm: {}".format(task_id
, ro_task
["target_id"], e
)
424 ro_vim_item_update
= {
425 "vim_status": "VIM_ERROR",
427 "vim_message": str(e
),
430 return "FAILED", ro_vim_item_update
432 def delete(self
, ro_task
, task_index
):
433 task
= ro_task
["tasks"][task_index
]
434 task_id
= task
["task_id"]
435 vm_vim_id
= ro_task
["vim_info"]["vim_id"]
436 ro_vim_item_update_ok
= {
437 "vim_status": "DELETED",
439 "vim_message": "DELETED",
445 "delete_vminstance: vm_vim_id={} created_items={}".format(
446 vm_vim_id
, ro_task
["vim_info"]["created_items"]
449 if vm_vim_id
or ro_task
["vim_info"]["created_items"]:
450 target_vim
= self
.my_vims
[ro_task
["target_id"]]
451 target_vim
.delete_vminstance(
453 ro_task
["vim_info"]["created_items"],
454 ro_task
["vim_info"].get("volumes_to_hold", []),
456 except vimconn
.VimConnNotFoundException
:
457 ro_vim_item_update_ok
["vim_message"] = "already deleted"
458 except vimconn
.VimConnException
as e
:
460 "ro_task={} vim={} del-vm={}: {}".format(
461 ro_task
["_id"], ro_task
["target_id"], vm_vim_id
, e
464 ro_vim_item_update
= {
465 "vim_status": "VIM_ERROR",
466 "vim_message": "Error while deleting: {}".format(e
),
469 return "FAILED", ro_vim_item_update
472 "task={} {} del-vm={} {}".format(
474 ro_task
["target_id"],
476 ro_vim_item_update_ok
.get("vim_message", ""),
480 return "DONE", ro_vim_item_update_ok
482 def refresh(self
, ro_task
):
483 """Call VIM to get vm status"""
484 ro_task_id
= ro_task
["_id"]
485 target_vim
= self
.my_vims
[ro_task
["target_id"]]
486 vim_id
= ro_task
["vim_info"]["vim_id"]
491 vm_to_refresh_list
= [vim_id
]
493 vim_dict
= target_vim
.refresh_vms_status(vm_to_refresh_list
)
494 vim_info
= vim_dict
[vim_id
]
496 if vim_info
["status"] == "ACTIVE":
498 elif vim_info
["status"] == "BUILD":
499 task_status
= "BUILD"
501 task_status
= "FAILED"
503 # try to load and parse vim_information
505 vim_info_info
= yaml
.safe_load(vim_info
["vim_info"])
506 if vim_info_info
.get("name"):
507 vim_info
["name"] = vim_info_info
["name"]
508 except Exception as vim_info_error
:
509 self
.logger
.exception(
510 f
"{vim_info_error} occured while getting the vim_info from yaml"
512 except vimconn
.VimConnException
as e
:
513 # Mark all tasks at VIM_ERROR status
515 "ro_task={} vim={} get-vm={}: {}".format(
516 ro_task_id
, ro_task
["target_id"], vim_id
, e
519 vim_info
= {"status": "VIM_ERROR", "error_msg": str(e
)}
520 task_status
= "FAILED"
522 ro_vim_item_update
= {}
524 # Interfaces cannot be present if e.g. VM is not present, that is status=DELETED
526 if vim_info
.get("interfaces"):
527 for vim_iface_id
in ro_task
["vim_info"]["interfaces_vim_ids"]:
531 for iface
in vim_info
["interfaces"]
532 if vim_iface_id
== iface
["vim_interface_id"]
537 # iface.pop("vim_info", None)
538 vim_interfaces
.append(iface
)
542 for t
in ro_task
["tasks"]
543 if t
and t
["action"] == "CREATE" and t
["status"] != "FINISHED"
545 if vim_interfaces
and task_create
.get("mgmt_vnf_interface") is not None:
546 vim_interfaces
[task_create
["mgmt_vnf_interface"]][
550 mgmt_vdu_iface
= task_create
.get(
551 "mgmt_vdu_interface", task_create
.get("mgmt_vnf_interface", 0)
554 vim_interfaces
[mgmt_vdu_iface
]["mgmt_vdu_interface"] = True
556 if ro_task
["vim_info"]["interfaces"] != vim_interfaces
:
557 ro_vim_item_update
["interfaces"] = vim_interfaces
559 if ro_task
["vim_info"]["vim_status"] != vim_info
["status"]:
560 ro_vim_item_update
["vim_status"] = vim_info
["status"]
562 if ro_task
["vim_info"]["vim_name"] != vim_info
.get("name"):
563 ro_vim_item_update
["vim_name"] = vim_info
.get("name")
565 if vim_info
["status"] in ("ERROR", "VIM_ERROR"):
566 if ro_task
["vim_info"]["vim_message"] != vim_info
.get("error_msg"):
567 ro_vim_item_update
["vim_message"] = vim_info
.get("error_msg")
568 elif vim_info
["status"] == "DELETED":
569 ro_vim_item_update
["vim_id"] = None
570 ro_vim_item_update
["vim_message"] = "Deleted externally"
572 if ro_task
["vim_info"]["vim_details"] != vim_info
["vim_info"]:
573 ro_vim_item_update
["vim_details"] = vim_info
["vim_info"]
575 if ro_vim_item_update
:
577 "ro_task={} {} get-vm={}: status={} {}".format(
579 ro_task
["target_id"],
581 ro_vim_item_update
.get("vim_status"),
582 ro_vim_item_update
.get("vim_message")
583 if ro_vim_item_update
.get("vim_status") != "ACTIVE"
588 return task_status
, ro_vim_item_update
590 def exec(self
, ro_task
, task_index
, task_depends
):
591 task
= ro_task
["tasks"][task_index
]
592 task_id
= task
["task_id"]
593 target_vim
= self
.my_vims
[ro_task
["target_id"]]
594 db_task_update
= {"retries": 0}
595 retries
= task
.get("retries", 0)
598 params
= task
["params"]
599 params_copy
= deepcopy(params
)
600 params_copy
["ro_key"] = self
.db
.decrypt(
601 params_copy
.pop("private_key"),
602 params_copy
.pop("schema_version"),
603 params_copy
.pop("salt"),
605 params_copy
["ip_addr"] = params_copy
.pop("ip_address")
606 target_vim
.inject_user_key(**params_copy
)
608 "task={} {} action-vm=inject_key".format(task_id
, ro_task
["target_id"])
615 ) # params_copy["key"]
616 except (vimconn
.VimConnException
, NsWorkerException
) as e
:
619 self
.logger
.debug(traceback
.format_exc())
620 if retries
< self
.max_retries_inject_ssh_key
:
626 "next_retry": self
.time_retries_inject_ssh_key
,
631 "task={} {} inject-ssh-key: {}".format(task_id
, ro_task
["target_id"], e
)
633 ro_vim_item_update
= {"vim_message": str(e
)}
635 return "FAILED", ro_vim_item_update
, db_task_update
638 class VimInteractionImage(VimInteractionBase
):
639 def new(self
, ro_task
, task_index
, task_depends
):
640 task
= ro_task
["tasks"][task_index
]
641 task_id
= task
["task_id"]
644 target_vim
= self
.my_vims
[ro_task
["target_id"]]
648 if task
.get("find_params"):
649 vim_images
= target_vim
.get_image_list(**task
["find_params"])
652 raise NsWorkerExceptionNotFound(
653 "Image not found with this criteria: '{}'".format(
657 elif len(vim_images
) > 1:
658 raise NsWorkerException(
659 "More than one image found with this criteria: '{}'".format(
664 vim_image_id
= vim_images
[0]["id"]
666 ro_vim_item_update
= {
667 "vim_id": vim_image_id
,
668 "vim_status": "DONE",
670 "created_items": created_items
,
675 "task={} {} new-image={} created={}".format(
676 task_id
, ro_task
["target_id"], vim_image_id
, created
680 return "DONE", ro_vim_item_update
681 except (NsWorkerException
, vimconn
.VimConnException
) as e
:
683 "task={} {} new-image: {}".format(task_id
, ro_task
["target_id"], e
)
685 ro_vim_item_update
= {
686 "vim_status": "VIM_ERROR",
688 "vim_message": str(e
),
691 return "FAILED", ro_vim_item_update
694 class VimInteractionFlavor(VimInteractionBase
):
695 def delete(self
, ro_task
, task_index
):
696 task
= ro_task
["tasks"][task_index
]
697 task_id
= task
["task_id"]
698 flavor_vim_id
= ro_task
["vim_info"]["vim_id"]
699 ro_vim_item_update_ok
= {
700 "vim_status": "DELETED",
702 "vim_message": "DELETED",
708 target_vim
= self
.my_vims
[ro_task
["target_id"]]
709 target_vim
.delete_flavor(flavor_vim_id
)
710 except vimconn
.VimConnNotFoundException
:
711 ro_vim_item_update_ok
["vim_message"] = "already deleted"
712 except vimconn
.VimConnException
as e
:
714 "ro_task={} vim={} del-flavor={}: {}".format(
715 ro_task
["_id"], ro_task
["target_id"], flavor_vim_id
, e
718 ro_vim_item_update
= {
719 "vim_status": "VIM_ERROR",
720 "vim_message": "Error while deleting: {}".format(e
),
723 return "FAILED", ro_vim_item_update
726 "task={} {} del-flavor={} {}".format(
728 ro_task
["target_id"],
730 ro_vim_item_update_ok
.get("vim_message", ""),
734 return "DONE", ro_vim_item_update_ok
736 def new(self
, ro_task
, task_index
, task_depends
):
737 task
= ro_task
["tasks"][task_index
]
738 task_id
= task
["task_id"]
741 target_vim
= self
.my_vims
[ro_task
["target_id"]]
747 if task
.get("find_params"):
749 flavor_data
= task
["find_params"]["flavor_data"]
750 vim_flavor_id
= target_vim
.get_flavor_id_from_data(flavor_data
)
751 except vimconn
.VimConnNotFoundException
as flavor_not_found_msg
:
753 f
"VimConnNotFoundException occured: {flavor_not_found_msg}"
756 if not vim_flavor_id
and task
.get("params"):
758 flavor_data
= task
["params"]["flavor_data"]
759 vim_flavor_id
= target_vim
.new_flavor(flavor_data
)
762 ro_vim_item_update
= {
763 "vim_id": vim_flavor_id
,
764 "vim_status": "DONE",
766 "created_items": created_items
,
771 "task={} {} new-flavor={} created={}".format(
772 task_id
, ro_task
["target_id"], vim_flavor_id
, created
776 return "DONE", ro_vim_item_update
777 except (vimconn
.VimConnException
, NsWorkerException
) as e
:
779 "task={} vim={} new-flavor: {}".format(task_id
, ro_task
["target_id"], e
)
781 ro_vim_item_update
= {
782 "vim_status": "VIM_ERROR",
784 "vim_message": str(e
),
787 return "FAILED", ro_vim_item_update
790 class VimInteractionAffinityGroup(VimInteractionBase
):
791 def delete(self
, ro_task
, task_index
):
792 task
= ro_task
["tasks"][task_index
]
793 task_id
= task
["task_id"]
794 affinity_group_vim_id
= ro_task
["vim_info"]["vim_id"]
795 ro_vim_item_update_ok
= {
796 "vim_status": "DELETED",
798 "vim_message": "DELETED",
803 if affinity_group_vim_id
:
804 target_vim
= self
.my_vims
[ro_task
["target_id"]]
805 target_vim
.delete_affinity_group(affinity_group_vim_id
)
806 except vimconn
.VimConnNotFoundException
:
807 ro_vim_item_update_ok
["vim_message"] = "already deleted"
808 except vimconn
.VimConnException
as e
:
810 "ro_task={} vim={} del-affinity-or-anti-affinity-group={}: {}".format(
811 ro_task
["_id"], ro_task
["target_id"], affinity_group_vim_id
, e
814 ro_vim_item_update
= {
815 "vim_status": "VIM_ERROR",
816 "vim_message": "Error while deleting: {}".format(e
),
819 return "FAILED", ro_vim_item_update
822 "task={} {} del-affinity-or-anti-affinity-group={} {}".format(
824 ro_task
["target_id"],
825 affinity_group_vim_id
,
826 ro_vim_item_update_ok
.get("vim_message", ""),
830 return "DONE", ro_vim_item_update_ok
832 def new(self
, ro_task
, task_index
, task_depends
):
833 task
= ro_task
["tasks"][task_index
]
834 task_id
= task
["task_id"]
837 target_vim
= self
.my_vims
[ro_task
["target_id"]]
840 affinity_group_vim_id
= None
841 affinity_group_data
= None
843 if task
.get("params"):
844 affinity_group_data
= task
["params"].get("affinity_group_data")
846 if affinity_group_data
and affinity_group_data
.get("vim-affinity-group-id"):
848 param_affinity_group_id
= task
["params"]["affinity_group_data"].get(
849 "vim-affinity-group-id"
851 affinity_group_vim_id
= target_vim
.get_affinity_group(
852 param_affinity_group_id
854 except vimconn
.VimConnNotFoundException
:
856 "task={} {} new-affinity-or-anti-affinity-group. Provided VIM Affinity Group ID {}"
857 "could not be found at VIM. Creating a new one.".format(
858 task_id
, ro_task
["target_id"], param_affinity_group_id
862 if not affinity_group_vim_id
and affinity_group_data
:
863 affinity_group_vim_id
= target_vim
.new_affinity_group(
868 ro_vim_item_update
= {
869 "vim_id": affinity_group_vim_id
,
870 "vim_status": "DONE",
872 "created_items": created_items
,
877 "task={} {} new-affinity-or-anti-affinity-group={} created={}".format(
878 task_id
, ro_task
["target_id"], affinity_group_vim_id
, created
882 return "DONE", ro_vim_item_update
883 except (vimconn
.VimConnException
, NsWorkerException
) as e
:
885 "task={} vim={} new-affinity-or-anti-affinity-group:"
886 " {}".format(task_id
, ro_task
["target_id"], e
)
888 ro_vim_item_update
= {
889 "vim_status": "VIM_ERROR",
891 "vim_message": str(e
),
894 return "FAILED", ro_vim_item_update
897 class VimInteractionUpdateVdu(VimInteractionBase
):
898 def exec(self
, ro_task
, task_index
, task_depends
):
899 task
= ro_task
["tasks"][task_index
]
900 task_id
= task
["task_id"]
901 db_task_update
= {"retries": 0}
904 target_vim
= self
.my_vims
[ro_task
["target_id"]]
907 if task
.get("params"):
908 vim_vm_id
= task
["params"].get("vim_vm_id")
909 action
= task
["params"].get("action")
910 context
= {action
: action
}
911 target_vim
.action_vminstance(vim_vm_id
, context
)
913 ro_vim_item_update
= {
915 "vim_status": "DONE",
917 "created_items": created_items
,
922 "task={} {} vm-migration done".format(task_id
, ro_task
["target_id"])
924 return "DONE", ro_vim_item_update
, db_task_update
925 except (vimconn
.VimConnException
, NsWorkerException
) as e
:
927 "task={} vim={} VM Migration:"
928 " {}".format(task_id
, ro_task
["target_id"], e
)
930 ro_vim_item_update
= {
931 "vim_status": "VIM_ERROR",
933 "vim_message": str(e
),
936 return "FAILED", ro_vim_item_update
, db_task_update
939 class VimInteractionSdnNet(VimInteractionBase
):
941 def _match_pci(port_pci
, mapping
):
943 Check if port_pci matches with mapping
944 mapping can have brackets to indicate that several chars are accepted. e.g
945 pci '0000:af:10.1' matches with '0000:af:1[01].[1357]'
946 :param port_pci: text
947 :param mapping: text, can contain brackets to indicate several chars are available
948 :return: True if matches, False otherwise
950 if not port_pci
or not mapping
:
952 if port_pci
== mapping
:
958 bracket_start
= mapping
.find("[", mapping_index
)
960 if bracket_start
== -1:
963 bracket_end
= mapping
.find("]", bracket_start
)
964 if bracket_end
== -1:
967 length
= bracket_start
- mapping_index
970 and port_pci
[pci_index
: pci_index
+ length
]
971 != mapping
[mapping_index
:bracket_start
]
976 port_pci
[pci_index
+ length
]
977 not in mapping
[bracket_start
+ 1 : bracket_end
]
981 pci_index
+= length
+ 1
982 mapping_index
= bracket_end
+ 1
984 if port_pci
[pci_index
:] != mapping
[mapping_index
:]:
989 def _get_interfaces(self
, vlds_to_connect
, vim_account_id
):
991 :param vlds_to_connect: list with format vnfrs:<id>:vld.<vld_id> or nsrs:<id>:vld.<vld_id>
992 :param vim_account_id:
997 for vld
in vlds_to_connect
:
998 table
, _
, db_id
= vld
.partition(":")
999 db_id
, _
, vld
= db_id
.partition(":")
1000 _
, _
, vld_id
= vld
.partition(".")
1002 if table
== "vnfrs":
1003 q_filter
= {"vim-account-id": vim_account_id
, "_id": db_id
}
1004 iface_key
= "vnf-vld-id"
1005 else: # table == "nsrs"
1006 q_filter
= {"vim-account-id": vim_account_id
, "nsr-id-ref": db_id
}
1007 iface_key
= "ns-vld-id"
1009 db_vnfrs
= self
.db
.get_list("vnfrs", q_filter
=q_filter
)
1011 for db_vnfr
in db_vnfrs
:
1012 for vdu_index
, vdur
in enumerate(db_vnfr
.get("vdur", ())):
1013 for iface_index
, interface
in enumerate(vdur
["interfaces"]):
1014 if interface
.get(iface_key
) == vld_id
and interface
.get(
1016 ) in ("SR-IOV", "PCI-PASSTHROUGH"):
1018 interface_
= interface
.copy()
1019 interface_
["id"] = "vnfrs:{}:vdu.{}.interfaces.{}".format(
1020 db_vnfr
["_id"], vdu_index
, iface_index
1023 if vdur
.get("status") == "ERROR":
1024 interface_
["status"] = "ERROR"
1026 interfaces
.append(interface_
)
1030 def refresh(self
, ro_task
):
1031 # look for task create
1032 task_create_index
, _
= next(
1034 for i_t
in enumerate(ro_task
["tasks"])
1036 and i_t
[1]["action"] == "CREATE"
1037 and i_t
[1]["status"] != "FINISHED"
1040 return self
.new(ro_task
, task_create_index
, None)
1042 def new(self
, ro_task
, task_index
, task_depends
):
1044 task
= ro_task
["tasks"][task_index
]
1045 task_id
= task
["task_id"]
1046 target_vim
= self
.my_vims
[ro_task
["target_id"]]
1048 sdn_net_id
= ro_task
["vim_info"]["vim_id"]
1050 created_items
= ro_task
["vim_info"].get("created_items")
1051 connected_ports
= ro_task
["vim_info"].get("connected_ports", [])
1052 new_connected_ports
= []
1053 last_update
= ro_task
["vim_info"].get("last_update", 0)
1054 sdn_status
= ro_task
["vim_info"].get("vim_status", "BUILD") or "BUILD"
1056 created
= ro_task
["vim_info"].get("created", False)
1060 params
= task
["params"]
1061 vlds_to_connect
= params
.get("vlds", [])
1062 associated_vim
= params
.get("target_vim")
1063 # external additional ports
1064 additional_ports
= params
.get("sdn-ports") or ()
1065 _
, _
, vim_account_id
= (
1067 if associated_vim
is None
1068 else associated_vim
.partition(":")
1072 # get associated VIM
1073 if associated_vim
not in self
.db_vims
:
1074 self
.db_vims
[associated_vim
] = self
.db
.get_one(
1075 "vim_accounts", {"_id": vim_account_id
}
1078 db_vim
= self
.db_vims
[associated_vim
]
1080 # look for ports to connect
1081 ports
= self
._get
_interfaces
(vlds_to_connect
, vim_account_id
)
1085 pending_ports
= error_ports
= 0
1087 sdn_need_update
= False
1090 vlan_used
= port
.get("vlan") or vlan_used
1092 # TODO. Do not connect if already done
1093 if not port
.get("compute_node") or not port
.get("pci"):
1094 if port
.get("status") == "ERROR":
1101 compute_node_mappings
= next(
1104 for c
in db_vim
["config"].get("sdn-port-mapping", ())
1105 if c
and c
["compute_node"] == port
["compute_node"]
1110 if compute_node_mappings
:
1111 # process port_mapping pci of type 0000:af:1[01].[1357]
1115 for p
in compute_node_mappings
["ports"]
1116 if self
._match
_pci
(port
["pci"], p
.get("pci"))
1122 if not db_vim
["config"].get("mapping_not_needed"):
1124 "Port mapping not found for compute_node={} pci={}".format(
1125 port
["compute_node"], port
["pci"]
1132 service_endpoint_id
= "{}:{}".format(port
["compute_node"], port
["pci"])
1134 "service_endpoint_id": pmap
.get("service_endpoint_id")
1135 or service_endpoint_id
,
1136 "service_endpoint_encapsulation_type": "dot1q"
1137 if port
["type"] == "SR-IOV"
1139 "service_endpoint_encapsulation_info": {
1140 "vlan": port
.get("vlan"),
1141 "mac": port
.get("mac-address"),
1142 "device_id": pmap
.get("device_id") or port
["compute_node"],
1143 "device_interface_id": pmap
.get("device_interface_id")
1145 "switch_dpid": pmap
.get("switch_id") or pmap
.get("switch_dpid"),
1146 "switch_port": pmap
.get("switch_port"),
1147 "service_mapping_info": pmap
.get("service_mapping_info"),
1152 # if port["modified_at"] > last_update:
1153 # sdn_need_update = True
1154 new_connected_ports
.append(port
["id"]) # TODO
1155 sdn_ports
.append(new_port
)
1159 "{} interfaces have not been created as VDU is on ERROR status".format(
1164 # connect external ports
1165 for index
, additional_port
in enumerate(additional_ports
):
1166 additional_port_id
= additional_port
.get(
1167 "service_endpoint_id"
1168 ) or "external-{}".format(index
)
1171 "service_endpoint_id": additional_port_id
,
1172 "service_endpoint_encapsulation_type": additional_port
.get(
1173 "service_endpoint_encapsulation_type", "dot1q"
1175 "service_endpoint_encapsulation_info": {
1176 "vlan": additional_port
.get("vlan") or vlan_used
,
1177 "mac": additional_port
.get("mac_address"),
1178 "device_id": additional_port
.get("device_id"),
1179 "device_interface_id": additional_port
.get(
1180 "device_interface_id"
1182 "switch_dpid": additional_port
.get("switch_dpid")
1183 or additional_port
.get("switch_id"),
1184 "switch_port": additional_port
.get("switch_port"),
1185 "service_mapping_info": additional_port
.get(
1186 "service_mapping_info"
1191 new_connected_ports
.append(additional_port_id
)
1194 # if there are more ports to connect or they have been modified, call create/update
1196 sdn_status
= "ERROR"
1197 sdn_info
= "; ".join(error_list
)
1198 elif set(connected_ports
) != set(new_connected_ports
) or sdn_need_update
:
1199 last_update
= time
.time()
1202 if len(sdn_ports
) < 2:
1203 sdn_status
= "ACTIVE"
1205 if not pending_ports
:
1207 "task={} {} new-sdn-net done, less than 2 ports".format(
1208 task_id
, ro_task
["target_id"]
1212 net_type
= params
.get("type") or "ELAN"
1216 ) = target_vim
.create_connectivity_service(net_type
, sdn_ports
)
1219 "task={} {} new-sdn-net={} created={}".format(
1220 task_id
, ro_task
["target_id"], sdn_net_id
, created
1224 created_items
= target_vim
.edit_connectivity_service(
1225 sdn_net_id
, conn_info
=created_items
, connection_points
=sdn_ports
1229 "task={} {} update-sdn-net={} created={}".format(
1230 task_id
, ro_task
["target_id"], sdn_net_id
, created
1234 connected_ports
= new_connected_ports
1236 wim_status_dict
= target_vim
.get_connectivity_service_status(
1237 sdn_net_id
, conn_info
=created_items
1239 sdn_status
= wim_status_dict
["sdn_status"]
1241 if wim_status_dict
.get("sdn_info"):
1242 sdn_info
= str(wim_status_dict
.get("sdn_info")) or ""
1244 if wim_status_dict
.get("error_msg"):
1245 sdn_info
= wim_status_dict
.get("error_msg") or ""
1248 if sdn_status
!= "ERROR":
1249 sdn_info
= "Waiting for getting interfaces location from VIM. Obtained '{}' of {}".format(
1250 len(ports
) - pending_ports
, len(ports
)
1253 if sdn_status
== "ACTIVE":
1254 sdn_status
= "BUILD"
1256 ro_vim_item_update
= {
1257 "vim_id": sdn_net_id
,
1258 "vim_status": sdn_status
,
1260 "created_items": created_items
,
1261 "connected_ports": connected_ports
,
1262 "vim_details": sdn_info
,
1263 "vim_message": None,
1264 "last_update": last_update
,
1267 return sdn_status
, ro_vim_item_update
1268 except Exception as e
:
1270 "task={} vim={} new-net: {}".format(task_id
, ro_task
["target_id"], e
),
1271 exc_info
=not isinstance(
1272 e
, (sdnconn
.SdnConnectorError
, vimconn
.VimConnException
)
1275 ro_vim_item_update
= {
1276 "vim_status": "VIM_ERROR",
1278 "vim_message": str(e
),
1281 return "FAILED", ro_vim_item_update
1283 def delete(self
, ro_task
, task_index
):
1284 task
= ro_task
["tasks"][task_index
]
1285 task_id
= task
["task_id"]
1286 sdn_vim_id
= ro_task
["vim_info"].get("vim_id")
1287 ro_vim_item_update_ok
= {
1288 "vim_status": "DELETED",
1290 "vim_message": "DELETED",
1296 target_vim
= self
.my_vims
[ro_task
["target_id"]]
1297 target_vim
.delete_connectivity_service(
1298 sdn_vim_id
, ro_task
["vim_info"].get("created_items")
1301 except Exception as e
:
1303 isinstance(e
, sdnconn
.SdnConnectorError
)
1304 and e
.http_code
== HTTPStatus
.NOT_FOUND
.value
1306 ro_vim_item_update_ok
["vim_message"] = "already deleted"
1309 "ro_task={} vim={} del-sdn-net={}: {}".format(
1310 ro_task
["_id"], ro_task
["target_id"], sdn_vim_id
, e
1312 exc_info
=not isinstance(
1313 e
, (sdnconn
.SdnConnectorError
, vimconn
.VimConnException
)
1316 ro_vim_item_update
= {
1317 "vim_status": "VIM_ERROR",
1318 "vim_message": "Error while deleting: {}".format(e
),
1321 return "FAILED", ro_vim_item_update
1324 "task={} {} del-sdn-net={} {}".format(
1326 ro_task
["target_id"],
1328 ro_vim_item_update_ok
.get("vim_message", ""),
1332 return "DONE", ro_vim_item_update_ok
1335 class VimInteractionMigration(VimInteractionBase
):
1336 def exec(self
, ro_task
, task_index
, task_depends
):
1337 task
= ro_task
["tasks"][task_index
]
1338 task_id
= task
["task_id"]
1339 db_task_update
= {"retries": 0}
1340 target_vim
= self
.my_vims
[ro_task
["target_id"]]
1344 refreshed_vim_info
= {}
1347 if task
.get("params"):
1348 vim_vm_id
= task
["params"].get("vim_vm_id")
1349 migrate_host
= task
["params"].get("migrate_host")
1350 _
, migrated_compute_node
= target_vim
.migrate_instance(
1351 vim_vm_id
, migrate_host
1354 if migrated_compute_node
:
1355 # When VM is migrated, vdu["vim_info"] needs to be updated
1356 vdu_old_vim_info
= task
["params"]["vdu_vim_info"].get(
1357 ro_task
["target_id"]
1360 # Refresh VM to get new vim_info
1361 vm_to_refresh_list
= [vim_vm_id
]
1362 vim_dict
= target_vim
.refresh_vms_status(vm_to_refresh_list
)
1363 refreshed_vim_info
= vim_dict
[vim_vm_id
]
1365 if refreshed_vim_info
.get("interfaces"):
1366 for old_iface
in vdu_old_vim_info
.get("interfaces"):
1370 for iface
in refreshed_vim_info
["interfaces"]
1371 if old_iface
["vim_interface_id"]
1372 == iface
["vim_interface_id"]
1376 vim_interfaces
.append(iface
)
1378 ro_vim_item_update
= {
1379 "vim_id": vim_vm_id
,
1380 "vim_status": "ACTIVE",
1382 "created_items": created_items
,
1383 "vim_details": None,
1384 "vim_message": None,
1387 if refreshed_vim_info
and refreshed_vim_info
.get("status") not in (
1391 ro_vim_item_update
["vim_details"] = refreshed_vim_info
["vim_info"]
1394 ro_vim_item_update
["interfaces"] = vim_interfaces
1397 "task={} {} vm-migration done".format(task_id
, ro_task
["target_id"])
1400 return "DONE", ro_vim_item_update
, db_task_update
1402 except (vimconn
.VimConnException
, NsWorkerException
) as e
:
1404 "task={} vim={} VM Migration:"
1405 " {}".format(task_id
, ro_task
["target_id"], e
)
1407 ro_vim_item_update
= {
1408 "vim_status": "VIM_ERROR",
1410 "vim_message": str(e
),
1413 return "FAILED", ro_vim_item_update
, db_task_update
1416 class VimInteractionResize(VimInteractionBase
):
1417 def exec(self
, ro_task
, task_index
, task_depends
):
1418 task
= ro_task
["tasks"][task_index
]
1419 task_id
= task
["task_id"]
1420 db_task_update
= {"retries": 0}
1422 target_flavor_uuid
= None
1424 refreshed_vim_info
= {}
1425 target_vim
= self
.my_vims
[ro_task
["target_id"]]
1428 if task
.get("params"):
1429 vim_vm_id
= task
["params"].get("vim_vm_id")
1430 flavor_dict
= task
["params"].get("flavor_dict")
1431 self
.logger
.info("flavor_dict %s", flavor_dict
)
1434 target_flavor_uuid
= target_vim
.get_flavor_id_from_data(flavor_dict
)
1435 except Exception as e
:
1436 self
.logger
.info("Cannot find any flavor matching %s.", str(e
))
1438 target_flavor_uuid
= target_vim
.new_flavor(flavor_dict
)
1439 except Exception as e
:
1440 self
.logger
.error("Error creating flavor at VIM %s.", str(e
))
1442 if target_flavor_uuid
is not None:
1443 resized_status
= target_vim
.resize_instance(
1444 vim_vm_id
, target_flavor_uuid
1448 # Refresh VM to get new vim_info
1449 vm_to_refresh_list
= [vim_vm_id
]
1450 vim_dict
= target_vim
.refresh_vms_status(vm_to_refresh_list
)
1451 refreshed_vim_info
= vim_dict
[vim_vm_id
]
1453 ro_vim_item_update
= {
1454 "vim_id": vim_vm_id
,
1455 "vim_status": "DONE",
1457 "created_items": created_items
,
1458 "vim_details": None,
1459 "vim_message": None,
1462 if refreshed_vim_info
and refreshed_vim_info
.get("status") not in (
1466 ro_vim_item_update
["vim_details"] = refreshed_vim_info
["vim_info"]
1469 "task={} {} resize done".format(task_id
, ro_task
["target_id"])
1471 return "DONE", ro_vim_item_update
, db_task_update
1472 except (vimconn
.VimConnException
, NsWorkerException
) as e
:
1474 "task={} vim={} Resize:" " {}".format(task_id
, ro_task
["target_id"], e
)
1476 ro_vim_item_update
= {
1477 "vim_status": "VIM_ERROR",
1479 "vim_message": str(e
),
1482 return "FAILED", ro_vim_item_update
, db_task_update
1485 class ConfigValidate
:
1486 def __init__(self
, config
: Dict
):
1491 # default 1 min, allowed >= 60 or -1, -1 disables periodic checks
1493 self
.conf
["period"]["refresh_active"] >= 60
1494 or self
.conf
["period"]["refresh_active"] == -1
1496 return self
.conf
["period"]["refresh_active"]
1502 return self
.conf
["period"]["refresh_build"]
1506 return self
.conf
["period"]["refresh_image"]
1510 return self
.conf
["period"]["refresh_error"]
1513 def queue_size(self
):
1514 return self
.conf
["period"]["queue_size"]
1517 class NsWorker(threading
.Thread
):
1518 def __init__(self
, worker_index
, config
, plugins
, db
):
1520 :param worker_index: thread index
1521 :param config: general configuration of RO, among others the process_id with the docker id where it runs
1522 :param plugins: global shared dict with the loaded plugins
1523 :param db: database class instance to use
1525 threading
.Thread
.__init
__(self
)
1526 self
.config
= config
1527 self
.plugins
= plugins
1528 self
.plugin_name
= "unknown"
1529 self
.logger
= logging
.getLogger("ro.worker{}".format(worker_index
))
1530 self
.worker_index
= worker_index
1531 # refresh periods for created items
1532 self
.refresh_config
= ConfigValidate(config
)
1533 self
.task_queue
= queue
.Queue(self
.refresh_config
.queue_size
)
1534 # targetvim: vimplugin class
1536 # targetvim: vim information from database
1539 self
.vim_targets
= []
1540 self
.my_id
= config
["process_id"] + ":" + str(worker_index
)
1543 "net": VimInteractionNet(self
.db
, self
.my_vims
, self
.db_vims
, self
.logger
),
1544 "vdu": VimInteractionVdu(self
.db
, self
.my_vims
, self
.db_vims
, self
.logger
),
1545 "image": VimInteractionImage(
1546 self
.db
, self
.my_vims
, self
.db_vims
, self
.logger
1548 "flavor": VimInteractionFlavor(
1549 self
.db
, self
.my_vims
, self
.db_vims
, self
.logger
1551 "sdn_net": VimInteractionSdnNet(
1552 self
.db
, self
.my_vims
, self
.db_vims
, self
.logger
1554 "update": VimInteractionUpdateVdu(
1555 self
.db
, self
.my_vims
, self
.db_vims
, self
.logger
1557 "affinity-or-anti-affinity-group": VimInteractionAffinityGroup(
1558 self
.db
, self
.my_vims
, self
.db_vims
, self
.logger
1560 "migrate": VimInteractionMigration(
1561 self
.db
, self
.my_vims
, self
.db_vims
, self
.logger
1563 "verticalscale": VimInteractionResize(
1564 self
.db
, self
.my_vims
, self
.db_vims
, self
.logger
1567 self
.time_last_task_processed
= None
1568 # lists of tasks to delete because nsrs or vnfrs has been deleted from db
1569 self
.tasks_to_delete
= []
1570 # it is idle when there are not vim_targets associated
1572 self
.task_locked_time
= config
["global"]["task_locked_time"]
1574 def insert_task(self
, task
):
1576 self
.task_queue
.put(task
, False)
1579 raise NsWorkerException("timeout inserting a task")
1581 def terminate(self
):
1582 self
.insert_task("exit")
1584 def del_task(self
, task
):
1585 with self
.task_lock
:
1586 if task
["status"] == "SCHEDULED":
1587 task
["status"] = "SUPERSEDED"
1589 else: # task["status"] == "processing"
1590 self
.task_lock
.release()
1593 def _process_vim_config(self
, target_id
: str, db_vim
: dict) -> None:
1595 Process vim config, creating vim configuration files as ca_cert
1596 :param target_id: vim/sdn/wim + id
1597 :param db_vim: Vim dictionary obtained from database
1598 :return: None. Modifies vim. Creates a folder target_id:worker_index and several files
1600 if not db_vim
.get("config"):
1604 work_dir
= "/app/osm_ro/certs"
1607 if db_vim
["config"].get("ca_cert_content"):
1608 file_name
= f
"{work_dir}/{target_id}:{self.worker_index}"
1610 if not path
.isdir(file_name
):
1613 file_name
= file_name
+ "/ca_cert"
1615 with
open(file_name
, "w") as f
:
1616 f
.write(db_vim
["config"]["ca_cert_content"])
1617 del db_vim
["config"]["ca_cert_content"]
1618 db_vim
["config"]["ca_cert"] = file_name
1619 except Exception as e
:
1620 raise NsWorkerException(
1621 "Error writing to file '{}': {}".format(file_name
, e
)
1624 def _load_plugin(self
, name
, type="vim"):
1625 # type can be vim or sdn
1626 if "rovim_dummy" not in self
.plugins
:
1627 self
.plugins
["rovim_dummy"] = VimDummyConnector
1629 if "rosdn_dummy" not in self
.plugins
:
1630 self
.plugins
["rosdn_dummy"] = SdnDummyConnector
1632 if name
in self
.plugins
:
1633 return self
.plugins
[name
]
1636 for ep
in entry_points(group
="osm_ro{}.plugins".format(type), name
=name
):
1637 self
.plugins
[name
] = ep
.load()
1638 except Exception as e
:
1639 raise NsWorkerException("Cannot load plugin osm_{}: {}".format(name
, e
))
1641 if name
and name
not in self
.plugins
:
1642 raise NsWorkerException(
1643 "Plugin 'osm_{n}' has not been installed".format(n
=name
)
1646 return self
.plugins
[name
]
1648 def _unload_vim(self
, target_id
):
1650 Unload a vim_account. Removes it from self db_vims dictionary, my_vims dictionary and vim_targets list
1651 :param target_id: Contains type:_id; where type can be 'vim', ...
1655 self
.db_vims
.pop(target_id
, None)
1656 self
.my_vims
.pop(target_id
, None)
1658 if target_id
in self
.vim_targets
:
1659 self
.vim_targets
.remove(target_id
)
1661 self
.logger
.info("Unloaded {}".format(target_id
))
1662 except Exception as e
:
1663 self
.logger
.error("Cannot unload {}: {}".format(target_id
, e
))
1665 def _check_vim(self
, target_id
):
1667 Load a VIM/SDN/WIM (if not loaded) and check connectivity, updating database with ENABLE or ERROR
1668 :param target_id: Contains type:_id; type can be 'vim', 'sdn' or 'wim'
1671 target
, _
, _id
= target_id
.partition(":")
1677 loaded
= target_id
in self
.vim_targets
1687 step
= "Getting {} from db".format(target_id
)
1688 db_vim
= self
.db
.get_one(target_database
, {"_id": _id
})
1690 for op_index
, operation
in enumerate(
1691 db_vim
["_admin"].get("operations", ())
1693 if operation
["operationState"] != "PROCESSING":
1696 locked_at
= operation
.get("locked_at")
1698 if locked_at
is not None and locked_at
>= now
- self
.task_locked_time
:
1699 # some other thread is doing this operation
1703 op_text
= "_admin.operations.{}.".format(op_index
)
1705 if not self
.db
.set_one(
1709 op_text
+ "operationState": "PROCESSING",
1710 op_text
+ "locked_at": locked_at
,
1713 op_text
+ "locked_at": now
,
1714 "admin.current_operation": op_index
,
1716 fail_on_empty
=False,
1720 unset_dict
[op_text
+ "locked_at"] = None
1721 unset_dict
["current_operation"] = None
1722 step
= "Loading " + target_id
1723 error_text
= self
._load
_vim
(target_id
)
1726 step
= "Checking connectivity"
1729 self
.my_vims
[target_id
].check_vim_connectivity()
1731 self
.my_vims
[target_id
].check_credentials()
1733 update_dict
["_admin.operationalState"] = "ENABLED"
1734 update_dict
["_admin.detailed-status"] = ""
1735 unset_dict
[op_text
+ "detailed-status"] = None
1736 update_dict
[op_text
+ "operationState"] = "COMPLETED"
1740 except Exception as e
:
1741 error_text
= "{}: {}".format(step
, e
)
1742 self
.logger
.error("{} for {}: {}".format(step
, target_id
, e
))
1745 if update_dict
or unset_dict
:
1747 update_dict
[op_text
+ "operationState"] = "FAILED"
1748 update_dict
[op_text
+ "detailed-status"] = error_text
1749 unset_dict
.pop(op_text
+ "detailed-status", None)
1750 update_dict
["_admin.operationalState"] = "ERROR"
1751 update_dict
["_admin.detailed-status"] = error_text
1754 update_dict
[op_text
+ "statusEnteredTime"] = now
1758 q_filter
={"_id": _id
},
1759 update_dict
=update_dict
,
1761 fail_on_empty
=False,
1765 self
._unload
_vim
(target_id
)
1767 def _reload_vim(self
, target_id
):
1768 if target_id
in self
.vim_targets
:
1769 self
._load
_vim
(target_id
)
1771 # if the vim is not loaded, but database information of VIM is cached at self.db_vims,
1772 # just remove it to force load again next time it is needed
1773 self
.db_vims
.pop(target_id
, None)
1775 def _load_vim(self
, target_id
):
1777 Load or reload a vim_account, sdn_controller or wim_account.
1778 Read content from database, load the plugin if not loaded.
1779 In case of error loading the plugin, it load a failing VIM_connector
1780 It fills self db_vims dictionary, my_vims dictionary and vim_targets list
1781 :param target_id: Contains type:_id; where type can be 'vim', ...
1782 :return: None if ok, descriptive text if error
1784 target
, _
, _id
= target_id
.partition(":")
1796 step
= "Getting {}={} from db".format(target
, _id
)
1797 # TODO process for wim, sdnc, ...
1798 vim
= self
.db
.get_one(target_database
, {"_id": _id
})
1800 # if deep_get(vim, "config", "sdn-controller"):
1801 # step = "Getting sdn-controller-id='{}' from db".format(vim["config"]["sdn-controller"])
1802 # db_sdn = self.db.get_one("sdns", {"_id": vim["config"]["sdn-controller"]})
1804 step
= "Decrypting password"
1805 schema_version
= vim
.get("schema_version")
1806 self
.db
.encrypt_decrypt_fields(
1809 fields
=("password", "secret"),
1810 schema_version
=schema_version
,
1813 self
._process
_vim
_config
(target_id
, vim
)
1816 plugin_name
= "rovim_" + vim
["vim_type"]
1817 step
= "Loading plugin '{}'".format(plugin_name
)
1818 vim_module_conn
= self
._load
_plugin
(plugin_name
)
1819 step
= "Loading {}'".format(target_id
)
1820 self
.my_vims
[target_id
] = vim_module_conn(
1823 tenant_id
=vim
.get("vim_tenant_id"),
1824 tenant_name
=vim
.get("vim_tenant_name"),
1827 user
=vim
["vim_user"],
1828 passwd
=vim
["vim_password"],
1829 config
=vim
.get("config") or {},
1833 plugin_name
= "rosdn_" + (vim
.get("type") or vim
.get("wim_type"))
1834 step
= "Loading plugin '{}'".format(plugin_name
)
1835 vim_module_conn
= self
._load
_plugin
(plugin_name
, "sdn")
1836 step
= "Loading {}'".format(target_id
)
1838 wim_config
= wim
.pop("config", {}) or {}
1839 wim
["uuid"] = wim
["_id"]
1840 if "url" in wim
and "wim_url" not in wim
:
1841 wim
["wim_url"] = wim
["url"]
1842 elif "url" not in wim
and "wim_url" in wim
:
1843 wim
["url"] = wim
["wim_url"]
1846 wim_config
["dpid"] = wim
.pop("dpid")
1848 if wim
.get("switch_id"):
1849 wim_config
["switch_id"] = wim
.pop("switch_id")
1851 # wim, wim_account, config
1852 self
.my_vims
[target_id
] = vim_module_conn(wim
, wim
, wim_config
)
1853 self
.db_vims
[target_id
] = vim
1854 self
.error_status
= None
1857 "Connector loaded for {}, plugin={}".format(target_id
, plugin_name
)
1859 except Exception as e
:
1861 "Cannot load {} plugin={}: {} {}".format(
1862 target_id
, plugin_name
, step
, e
1866 self
.db_vims
[target_id
] = vim
or {}
1867 self
.db_vims
[target_id
] = FailingConnector(str(e
))
1868 error_status
= "{} Error: {}".format(step
, e
)
1872 if target_id
not in self
.vim_targets
:
1873 self
.vim_targets
.append(target_id
)
1875 def _get_db_task(self
):
1877 Read actions from database and reload them at memory. Fill self.refresh_list, pending_list, vim_actions
1882 if not self
.time_last_task_processed
:
1883 self
.time_last_task_processed
= now
1888 # Log RO tasks only when loglevel is DEBUG
1889 if self.logger.getEffectiveLevel() == logging.DEBUG:
1896 + str(self.task_locked_time)
1898 + "time_last_task_processed="
1899 + str(self.time_last_task_processed)
1905 locked
= self
.db
.set_one(
1908 "target_id": self
.vim_targets
,
1909 "tasks.status": ["SCHEDULED", "BUILD", "DONE", "FAILED"],
1910 "locked_at.lt": now
- self
.task_locked_time
,
1911 "to_check_at.lt": self
.time_last_task_processed
,
1912 "to_check_at.gt": -1,
1914 update_dict
={"locked_by": self
.my_id
, "locked_at": now
},
1915 fail_on_empty
=False,
1920 ro_task
= self
.db
.get_one(
1923 "target_id": self
.vim_targets
,
1924 "tasks.status": ["SCHEDULED", "BUILD", "DONE", "FAILED"],
1930 if self
.time_last_task_processed
== now
:
1931 self
.time_last_task_processed
= None
1934 self
.time_last_task_processed
= now
1935 # self.time_last_task_processed = min(self.time_last_task_processed + 1000, now)
1937 except DbException
as e
:
1938 self
.logger
.error("Database exception at _get_db_task: {}".format(e
))
1939 except Exception as e
:
1940 self
.logger
.critical(
1941 "Unexpected exception at _get_db_task: {}".format(e
), exc_info
=True
1946 def _get_db_all_tasks(self
):
1948 Read all content of table ro_tasks to log it
1952 # Checking the content of the BD:
1955 ro_task
= self
.db
.get_list("ro_tasks")
1957 self
._log
_ro
_task
(rt
, None, None, "TASK_WF", "GET_ALL_TASKS")
1960 except DbException
as e
:
1961 self
.logger
.error("Database exception at _get_db_all_tasks: {}".format(e
))
1962 except Exception as e
:
1963 self
.logger
.critical(
1964 "Unexpected exception at _get_db_all_tasks: {}".format(e
), exc_info
=True
1969 def _log_ro_task(self
, ro_task
, db_ro_task_update
, db_ro_task_delete
, mark
, event
):
1971 Generate a log with the following format:
1973 Mark;Event;ro_task_id;locked_at;modified_at;created_at;to_check_at;locked_by;
1974 target_id;vim_info.refresh_at;vim_info;no_of_tasks;task_status;action_id;
1975 task_array_index;task_id;task_action;task_item;task_args
1979 TASK_WF;GET_TASK;888f1864-749a-4fc2-bc1a-97c0fffd6a6f:2;1642158724.8210013;
1980 1642158640.7986135;1642158640.7986135;1642158640.7986135;b134c9494e75:0a
1981 ;vim:b7ff9e24-8868-4d68-8a57-a59dc11d0327;None;{'created': False,
1982 'created_items': None, 'vim_id': None, 'vim_name': None, 'vim_status': None,
1983 'vim_details': None, 'vim_message': None, 'refresh_at': None};1;SCHEDULED;
1984 888f1864-749a-4fc2-bc1a-97c0fffd6a6f;0;888f1864-749a-4fc2-bc1a-97c0fffd6a6f:2;
1985 CREATE;image;{'filter_dict': {'name': 'ubuntu-os-cloud:image-family:ubuntu-1804-lts'}}
1990 if ro_task
is not None and isinstance(ro_task
, dict):
1991 for t
in ro_task
["tasks"]:
1995 line
.append(ro_task
.get("_id", ""))
1996 line
.append(str(ro_task
.get("locked_at", "")))
1997 line
.append(str(ro_task
.get("modified_at", "")))
1998 line
.append(str(ro_task
.get("created_at", "")))
1999 line
.append(str(ro_task
.get("to_check_at", "")))
2000 line
.append(str(ro_task
.get("locked_by", "")))
2001 line
.append(str(ro_task
.get("target_id", "")))
2002 line
.append(str(ro_task
.get("vim_info", {}).get("refresh_at", "")))
2003 line
.append(str(ro_task
.get("vim_info", "")))
2004 line
.append(str(ro_task
.get("tasks", "")))
2005 if isinstance(t
, dict):
2006 line
.append(str(t
.get("status", "")))
2007 line
.append(str(t
.get("action_id", "")))
2009 line
.append(str(t
.get("task_id", "")))
2010 line
.append(str(t
.get("action", "")))
2011 line
.append(str(t
.get("item", "")))
2012 line
.append(str(t
.get("find_params", "")))
2013 line
.append(str(t
.get("params", "")))
2015 line
.extend([""] * 2)
2017 line
.extend([""] * 5)
2020 self
.logger
.debug(";".join(line
))
2021 elif db_ro_task_update
is not None and isinstance(db_ro_task_update
, dict):
2024 st
= "tasks.{}.status".format(i
)
2025 if st
not in db_ro_task_update
:
2030 line
.append(db_ro_task_update
.get("_id", ""))
2031 line
.append(str(db_ro_task_update
.get("locked_at", "")))
2032 line
.append(str(db_ro_task_update
.get("modified_at", "")))
2034 line
.append(str(db_ro_task_update
.get("to_check_at", "")))
2035 line
.append(str(db_ro_task_update
.get("locked_by", "")))
2037 line
.append(str(db_ro_task_update
.get("vim_info.refresh_at", "")))
2039 line
.append(str(db_ro_task_update
.get("vim_info", "")))
2040 line
.append(str(str(db_ro_task_update
).count(".status")))
2041 line
.append(db_ro_task_update
.get(st
, ""))
2044 line
.extend([""] * 3)
2046 self
.logger
.debug(";".join(line
))
2048 elif db_ro_task_delete
is not None and isinstance(db_ro_task_delete
, dict):
2052 line
.append(db_ro_task_delete
.get("_id", ""))
2054 line
.append(db_ro_task_delete
.get("modified_at", ""))
2055 line
.extend([""] * 13)
2056 self
.logger
.debug(";".join(line
))
2062 line
.extend([""] * 16)
2063 self
.logger
.debug(";".join(line
))
2065 except Exception as e
:
2066 self
.logger
.error("Error logging ro_task: {}".format(e
))
2068 def _delete_task(self
, ro_task
, task_index
, task_depends
, db_update
):
2070 Determine if this task need to be done or superseded
2073 my_task
= ro_task
["tasks"][task_index
]
2074 task_id
= my_task
["task_id"]
2075 needed_delete
= ro_task
["vim_info"]["created"] or ro_task
["vim_info"].get(
2076 "created_items", False
2079 self
.logger
.debug("Needed delete: {}".format(needed_delete
))
2080 if my_task
["status"] == "FAILED":
2081 return None, None # TODO need to be retry??
2084 for index
, task
in enumerate(ro_task
["tasks"]):
2085 if index
== task_index
or not task
:
2089 my_task
["target_record"] == task
["target_record"]
2090 and task
["action"] == "CREATE"
2093 db_update
["tasks.{}.status".format(index
)] = task
[
2096 elif task
["action"] == "CREATE" and task
["status"] not in (
2100 needed_delete
= False
2104 "Deleting ro_task={} task_index={}".format(ro_task
, task_index
)
2106 return self
.item2class
[my_task
["item"]].delete(ro_task
, task_index
)
2108 return "SUPERSEDED", None
2109 except Exception as e
:
2110 if not isinstance(e
, NsWorkerException
):
2111 self
.logger
.critical(
2112 "Unexpected exception at _delete_task task={}: {}".format(
2118 return "FAILED", {"vim_status": "VIM_ERROR", "vim_message": str(e
)}
2120 def _create_task(self
, ro_task
, task_index
, task_depends
, db_update
):
2122 Determine if this task need to create something at VIM
2125 my_task
= ro_task
["tasks"][task_index
]
2126 task_id
= my_task
["task_id"]
2129 if my_task
["status"] == "FAILED":
2130 return None, None # TODO need to be retry??
2131 elif my_task
["status"] == "SCHEDULED":
2132 # check if already created by another task
2133 for index
, task
in enumerate(ro_task
["tasks"]):
2134 if index
== task_index
or not task
:
2137 if task
["action"] == "CREATE" and task
["status"] not in (
2142 return task
["status"], "COPY_VIM_INFO"
2145 task_status
, ro_vim_item_update
= self
.item2class
[my_task
["item"]].new(
2146 ro_task
, task_index
, task_depends
2148 # TODO update other CREATE tasks
2149 except Exception as e
:
2150 if not isinstance(e
, NsWorkerException
):
2152 "Error executing task={}: {}".format(task_id
, e
), exc_info
=True
2155 task_status
= "FAILED"
2156 ro_vim_item_update
= {"vim_status": "VIM_ERROR", "vim_message": str(e
)}
2157 # TODO update ro_vim_item_update
2159 return task_status
, ro_vim_item_update
2163 def _get_dependency(self
, task_id
, ro_task
=None, target_id
=None):
2165 Look for dependency task
2166 :param task_id: Can be one of
2167 1. target_vim+blank+task.target_record_id: "(vim|sdn|wim):<id> (vnfrs|nsrs):(vld|vdu|flavor|image).<id>"
2168 2. task.target_record_id: "(vnfrs|nsrs):(vld|vdu|flavor|image).<id>"
2169 3. task.task_id: "<action_id>:number"
2172 :return: database ro_task plus index of task
2175 task_id
.startswith("vim:")
2176 or task_id
.startswith("sdn:")
2177 or task_id
.startswith("wim:")
2179 target_id
, _
, task_id
= task_id
.partition(" ")
2181 if task_id
.startswith("nsrs:") or task_id
.startswith("vnfrs:"):
2182 ro_task_dependency
= self
.db
.get_one(
2184 q_filter
={"target_id": target_id
, "tasks.target_record_id": task_id
},
2185 fail_on_empty
=False,
2188 if ro_task_dependency
:
2189 for task_index
, task
in enumerate(ro_task_dependency
["tasks"]):
2190 if task
["target_record_id"] == task_id
:
2191 return ro_task_dependency
, task_index
2195 for task_index
, task
in enumerate(ro_task
["tasks"]):
2196 if task
and task
["task_id"] == task_id
:
2197 return ro_task
, task_index
2199 ro_task_dependency
= self
.db
.get_one(
2202 "tasks.ANYINDEX.task_id": task_id
,
2203 "tasks.ANYINDEX.target_record.ne": None,
2205 fail_on_empty
=False,
2208 self
.logger
.debug("ro_task_dependency={}".format(ro_task_dependency
))
2209 if ro_task_dependency
:
2210 for task_index
, task
in enumerate(ro_task_dependency
["tasks"]):
2211 if task
["task_id"] == task_id
:
2212 return ro_task_dependency
, task_index
2213 raise NsWorkerException("Cannot get depending task {}".format(task_id
))
2215 def update_vm_refresh(self
):
2216 """Enables the VM status updates if self.refresh_config.active parameter
2217 is not -1 and than updates the DB accordingly
2221 self
.logger
.debug("Checking if VM status update config")
2222 next_refresh
= time
.time()
2223 if self
.refresh_config
.active
== -1:
2226 next_refresh
+= self
.refresh_config
.active
2228 if next_refresh
!= -1:
2229 db_ro_task_update
= {}
2231 next_check_at
= now
+ (24 * 60 * 60)
2232 next_check_at
= min(next_check_at
, next_refresh
)
2233 db_ro_task_update
["vim_info.refresh_at"] = next_refresh
2234 db_ro_task_update
["to_check_at"] = next_check_at
2237 "Finding tasks which to be updated to enable VM status updates"
2239 refresh_tasks
= self
.db
.get_list(
2242 "tasks.status": "DONE",
2243 "to_check_at.lt": 0,
2246 self
.logger
.debug("Updating tasks to change the to_check_at status")
2247 for task
in refresh_tasks
:
2254 update_dict
=db_ro_task_update
,
2258 except Exception as e
:
2259 self
.logger
.error(f
"Error updating tasks to enable VM status updates: {e}")
2261 def _process_pending_tasks(self
, ro_task
):
2262 ro_task_id
= ro_task
["_id"]
2265 next_check_at
= now
+ (24 * 60 * 60)
2266 db_ro_task_update
= {}
2268 def _update_refresh(new_status
):
2269 # compute next_refresh
2271 nonlocal next_check_at
2272 nonlocal db_ro_task_update
2275 next_refresh
= time
.time()
2277 if task
["item"] in ("image", "flavor"):
2278 next_refresh
+= self
.refresh_config
.image
2279 elif new_status
== "BUILD":
2280 next_refresh
+= self
.refresh_config
.build
2281 elif new_status
== "DONE":
2282 if self
.refresh_config
.active
== -1:
2285 next_refresh
+= self
.refresh_config
.active
2287 next_refresh
+= self
.refresh_config
.error
2289 next_check_at
= min(next_check_at
, next_refresh
)
2290 db_ro_task_update
["vim_info.refresh_at"] = next_refresh
2291 ro_task
["vim_info"]["refresh_at"] = next_refresh
2295 # Log RO tasks only when loglevel is DEBUG
2296 if self.logger.getEffectiveLevel() == logging.DEBUG:
2297 self._log_ro_task(ro_task, None, None, "TASK_WF", "GET_TASK")
2299 # Check if vim status refresh is enabled again
2300 self
.update_vm_refresh()
2301 # 0: get task_status_create
2303 task_status_create
= None
2307 for t
in ro_task
["tasks"]
2309 and t
["action"] == "CREATE"
2310 and t
["status"] in ("BUILD", "DONE")
2316 task_status_create
= task_create
["status"]
2318 # 1: look for tasks in status SCHEDULED, or in status CREATE if action is DONE or BUILD
2319 for task_action
in ("DELETE", "CREATE", "EXEC"):
2320 db_vim_update
= None
2323 for task_index
, task
in enumerate(ro_task
["tasks"]):
2325 continue # task deleted
2328 target_update
= None
2332 task_action
in ("DELETE", "EXEC")
2333 and task
["status"] not in ("SCHEDULED", "BUILD")
2335 or task
["action"] != task_action
2337 task_action
== "CREATE"
2338 and task
["status"] in ("FINISHED", "SUPERSEDED")
2343 task_path
= "tasks.{}.status".format(task_index
)
2345 db_vim_info_update
= None
2347 if task
["status"] == "SCHEDULED":
2348 # check if tasks that this depends on have been completed
2349 dependency_not_completed
= False
2351 for dependency_task_id
in task
.get("depends_on") or ():
2354 dependency_task_index
,
2355 ) = self
._get
_dependency
(
2356 dependency_task_id
, target_id
=ro_task
["target_id"]
2358 dependency_task
= dependency_ro_task
["tasks"][
2359 dependency_task_index
2362 "dependency_ro_task={} dependency_task_index={}".format(
2363 dependency_ro_task
, dependency_task_index
2367 if dependency_task
["status"] == "SCHEDULED":
2368 dependency_not_completed
= True
2369 next_check_at
= min(
2370 next_check_at
, dependency_ro_task
["to_check_at"]
2372 # must allow dependent task to be processed first
2373 # to do this set time after last_task_processed
2374 next_check_at
= max(
2375 self
.time_last_task_processed
, next_check_at
2378 elif dependency_task
["status"] == "FAILED":
2379 error_text
= "Cannot {} {} because depends on failed {} {} id={}): {}".format(
2382 dependency_task
["action"],
2383 dependency_task
["item"],
2385 dependency_ro_task
["vim_info"].get(
2390 "task={} {}".format(task
["task_id"], error_text
)
2392 raise NsWorkerException(error_text
)
2394 task_depends
[dependency_task_id
] = dependency_ro_task
[
2398 "TASK-{}".format(dependency_task_id
)
2399 ] = dependency_ro_task
["vim_info"]["vim_id"]
2401 if dependency_not_completed
:
2402 self
.logger
.warning(
2403 "DEPENDENCY NOT COMPLETED {}".format(
2404 dependency_ro_task
["vim_info"]["vim_id"]
2407 # TODO set at vim_info.vim_details that it is waiting
2410 # before calling VIM-plugin as it can take more than task_locked_time, insert to LockRenew
2411 # the task of renew this locking. It will update database locket_at periodically
2413 lock_object
= LockRenew
.add_lock_object(
2414 "ro_tasks", ro_task
, self
2417 if task
["action"] == "DELETE":
2418 (new_status
, db_vim_info_update
,) = self
._delete
_task
(
2419 ro_task
, task_index
, task_depends
, db_ro_task_update
2422 "FINISHED" if new_status
== "DONE" else new_status
2424 # ^with FINISHED instead of DONE it will not be refreshing
2426 if new_status
in ("FINISHED", "SUPERSEDED"):
2427 target_update
= "DELETE"
2428 elif task
["action"] == "EXEC":
2433 ) = self
.item2class
[task
["item"]].exec(
2434 ro_task
, task_index
, task_depends
2437 "FINISHED" if new_status
== "DONE" else new_status
2439 # ^with FINISHED instead of DONE it will not be refreshing
2442 # load into database the modified db_task_update "retries" and "next_retry"
2443 if db_task_update
.get("retries"):
2445 "tasks.{}.retries".format(task_index
)
2446 ] = db_task_update
["retries"]
2448 next_check_at
= time
.time() + db_task_update
.get(
2451 target_update
= None
2452 elif task
["action"] == "CREATE":
2453 if task
["status"] == "SCHEDULED":
2454 if task_status_create
:
2455 new_status
= task_status_create
2456 target_update
= "COPY_VIM_INFO"
2458 new_status
, db_vim_info_update
= self
.item2class
[
2460 ].new(ro_task
, task_index
, task_depends
)
2461 # self._create_task(ro_task, task_index, task_depends, db_ro_task_update)
2462 _update_refresh(new_status
)
2464 refresh_at
= ro_task
["vim_info"]["refresh_at"]
2465 if refresh_at
and refresh_at
!= -1 and now
> refresh_at
:
2466 (new_status
, db_vim_info_update
,) = self
.item2class
[
2469 _update_refresh(new_status
)
2471 # The refresh is updated to avoid set the value of "refresh_at" to
2472 # default value (next_check_at = now + (24 * 60 * 60)) when status is BUILD,
2473 # because it can happen that in this case the task is never processed
2474 _update_refresh(task
["status"])
2476 except Exception as e
:
2477 new_status
= "FAILED"
2478 db_vim_info_update
= {
2479 "vim_status": "VIM_ERROR",
2480 "vim_message": str(e
),
2484 e
, (NsWorkerException
, vimconn
.VimConnException
)
2487 "Unexpected exception at _delete_task task={}: {}".format(
2494 if db_vim_info_update
:
2495 db_vim_update
= db_vim_info_update
.copy()
2496 db_ro_task_update
.update(
2499 for k
, v
in db_vim_info_update
.items()
2502 ro_task
["vim_info"].update(db_vim_info_update
)
2505 if task_action
== "CREATE":
2506 task_status_create
= new_status
2507 db_ro_task_update
[task_path
] = new_status
2509 if target_update
or db_vim_update
:
2510 if target_update
== "DELETE":
2511 self
._update
_target
(task
, None)
2512 elif target_update
== "COPY_VIM_INFO":
2513 self
._update
_target
(task
, ro_task
["vim_info"])
2515 self
._update
_target
(task
, db_vim_update
)
2517 except Exception as e
:
2519 isinstance(e
, DbException
)
2520 and e
.http_code
== HTTPStatus
.NOT_FOUND
2522 # if the vnfrs or nsrs has been removed from database, this task must be removed
2524 "marking to delete task={}".format(task
["task_id"])
2526 self
.tasks_to_delete
.append(task
)
2529 "Unexpected exception at _update_target task={}: {}".format(
2535 locked_at
= ro_task
["locked_at"]
2539 lock_object
["locked_at"],
2540 lock_object
["locked_at"] + self
.task_locked_time
,
2542 # locked_at contains two times to avoid race condition. In case the lock has been renew, it will
2543 # contain exactly locked_at + self.task_locked_time
2544 LockRenew
.remove_lock_object(lock_object
)
2547 "_id": ro_task
["_id"],
2548 "to_check_at": ro_task
["to_check_at"],
2549 "locked_at": locked_at
,
2551 # modify own task. Try filtering by to_next_check. For race condition if to_check_at has been modified,
2552 # outside this task (by ro_nbi) do not update it
2553 db_ro_task_update
["locked_by"] = None
2554 # locked_at converted to int only for debugging. When has not decimals it means it has been unlocked
2555 db_ro_task_update
["locked_at"] = int(now
- self
.task_locked_time
)
2556 db_ro_task_update
["modified_at"] = now
2557 db_ro_task_update
["to_check_at"] = next_check_at
2560 # Log RO tasks only when loglevel is DEBUG
2561 if self.logger.getEffectiveLevel() == logging.DEBUG:
2562 db_ro_task_update_log = db_ro_task_update.copy()
2563 db_ro_task_update_log["_id"] = q_filter["_id"]
2564 self._log_ro_task(None, db_ro_task_update_log, None, "TASK_WF", "SET_TASK")
2567 if not self
.db
.set_one(
2569 update_dict
=db_ro_task_update
,
2571 fail_on_empty
=False,
2573 del db_ro_task_update
["to_check_at"]
2574 del q_filter
["to_check_at"]
2576 # Log RO tasks only when loglevel is DEBUG
2577 if self.logger.getEffectiveLevel() == logging.DEBUG:
2580 db_ro_task_update_log,
2583 "SET_TASK " + str(q_filter),
2589 update_dict
=db_ro_task_update
,
2592 except DbException
as e
:
2594 "ro_task={} Error updating database {}".format(ro_task_id
, e
)
2596 except Exception as e
:
2598 "Error executing ro_task={}: {}".format(ro_task_id
, e
), exc_info
=True
2601 def _update_target(self
, task
, ro_vim_item_update
):
2602 table
, _
, temp
= task
["target_record"].partition(":")
2603 _id
, _
, path_vim_status
= temp
.partition(":")
2604 path_item
= path_vim_status
[: path_vim_status
.rfind(".")]
2605 path_item
= path_item
[: path_item
.rfind(".")]
2606 # path_vim_status: dot separated list targeting vim information, e.g. "vdur.10.vim_info.vim:id"
2607 # path_item: dot separated list targeting record information, e.g. "vdur.10"
2609 if ro_vim_item_update
:
2611 path_vim_status
+ "." + k
: v
2612 for k
, v
in ro_vim_item_update
.items()
2621 "interfaces_backup",
2625 if path_vim_status
.startswith("vdur."):
2626 # for backward compatibility, add vdur.name apart from vdur.vim_name
2627 if ro_vim_item_update
.get("vim_name"):
2628 update_dict
[path_item
+ ".name"] = ro_vim_item_update
["vim_name"]
2630 # for backward compatibility, add vdur.vim-id apart from vdur.vim_id
2631 if ro_vim_item_update
.get("vim_id"):
2632 update_dict
[path_item
+ ".vim-id"] = ro_vim_item_update
["vim_id"]
2634 # update general status
2635 if ro_vim_item_update
.get("vim_status"):
2636 update_dict
[path_item
+ ".status"] = ro_vim_item_update
[
2640 if ro_vim_item_update
.get("interfaces"):
2641 path_interfaces
= path_item
+ ".interfaces"
2643 for i
, iface
in enumerate(ro_vim_item_update
.get("interfaces")):
2647 path_interfaces
+ ".{}.".format(i
) + k
: v
2648 for k
, v
in iface
.items()
2649 if k
in ("vlan", "compute_node", "pci")
2653 # put ip_address and mac_address with ip-address and mac-address
2654 if iface
.get("ip_address"):
2656 path_interfaces
+ ".{}.".format(i
) + "ip-address"
2657 ] = iface
["ip_address"]
2659 if iface
.get("mac_address"):
2661 path_interfaces
+ ".{}.".format(i
) + "mac-address"
2662 ] = iface
["mac_address"]
2664 if iface
.get("mgmt_vnf_interface") and iface
.get("ip_address"):
2665 update_dict
["ip-address"] = iface
.get("ip_address").split(
2669 if iface
.get("mgmt_vdu_interface") and iface
.get("ip_address"):
2670 update_dict
[path_item
+ ".ip-address"] = iface
.get(
2674 self
.db
.set_one(table
, q_filter
={"_id": _id
}, update_dict
=update_dict
)
2676 # If interfaces exists, it backups VDU interfaces in the DB for healing operations
2677 if ro_vim_item_update
.get("interfaces"):
2678 search_key
= path_vim_status
+ ".interfaces"
2679 if update_dict
.get(search_key
):
2680 interfaces_backup_update
= {
2681 path_vim_status
+ ".interfaces_backup": update_dict
[search_key
]
2686 q_filter
={"_id": _id
},
2687 update_dict
=interfaces_backup_update
,
2691 update_dict
= {path_item
+ ".status": "DELETED"}
2694 q_filter
={"_id": _id
},
2695 update_dict
=update_dict
,
2696 unset
={path_vim_status
: None},
2699 def _process_delete_db_tasks(self
):
2701 Delete task from database because vnfrs or nsrs or both have been deleted
2702 :return: None. Uses and modify self.tasks_to_delete
2704 while self
.tasks_to_delete
:
2705 task
= self
.tasks_to_delete
[0]
2706 vnfrs_deleted
= None
2707 nsr_id
= task
["nsr_id"]
2709 if task
["target_record"].startswith("vnfrs:"):
2710 # check if nsrs is present
2711 if self
.db
.get_one("nsrs", {"_id": nsr_id
}, fail_on_empty
=False):
2712 vnfrs_deleted
= task
["target_record"].split(":")[1]
2715 self
.delete_db_tasks(self
.db
, nsr_id
, vnfrs_deleted
)
2716 except Exception as e
:
2718 "Error deleting task={}: {}".format(task
["task_id"], e
)
2720 self
.tasks_to_delete
.pop(0)
2723 def delete_db_tasks(db
, nsr_id
, vnfrs_deleted
):
2725 Static method because it is called from osm_ng_ro.ns
2726 :param db: instance of database to use
2727 :param nsr_id: affected nsrs id
2728 :param vnfrs_deleted: only tasks with this vnfr id. If None, all affected by nsr_id
2729 :return: None, exception is fails
2732 for retry
in range(retries
):
2733 ro_tasks
= db
.get_list("ro_tasks", {"tasks.nsr_id": nsr_id
})
2737 for ro_task
in ro_tasks
:
2739 to_delete_ro_task
= True
2741 for index
, task
in enumerate(ro_task
["tasks"]):
2744 elif (not vnfrs_deleted
and task
["nsr_id"] == nsr_id
) or (
2746 and task
["target_record"].startswith("vnfrs:" + vnfrs_deleted
)
2748 db_update
["tasks.{}".format(index
)] = None
2750 # used by other nsr, ro_task cannot be deleted
2751 to_delete_ro_task
= False
2753 # delete or update if nobody has changed ro_task meanwhile. Used modified_at for known if changed
2754 if to_delete_ro_task
:
2758 "_id": ro_task
["_id"],
2759 "modified_at": ro_task
["modified_at"],
2761 fail_on_empty
=False,
2765 db_update
["modified_at"] = now
2769 "_id": ro_task
["_id"],
2770 "modified_at": ro_task
["modified_at"],
2772 update_dict
=db_update
,
2773 fail_on_empty
=False,
2779 raise NsWorkerException("Exceeded {} retries".format(retries
))
2783 self
.logger
.info("Starting")
2785 # step 1: get commands from queue
2787 if self
.vim_targets
:
2788 task
= self
.task_queue
.get(block
=False)
2791 self
.logger
.debug("enters in idle state")
2793 task
= self
.task_queue
.get(block
=True)
2796 if task
[0] == "terminate":
2798 elif task
[0] == "load_vim":
2799 self
.logger
.info("order to load vim {}".format(task
[1]))
2800 self
._load
_vim
(task
[1])
2801 elif task
[0] == "unload_vim":
2802 self
.logger
.info("order to unload vim {}".format(task
[1]))
2803 self
._unload
_vim
(task
[1])
2804 elif task
[0] == "reload_vim":
2805 self
._reload
_vim
(task
[1])
2806 elif task
[0] == "check_vim":
2807 self
.logger
.info("order to check vim {}".format(task
[1]))
2808 self
._check
_vim
(task
[1])
2810 except Exception as e
:
2811 if isinstance(e
, queue
.Empty
):
2814 self
.logger
.critical(
2815 "Error processing task: {}".format(e
), exc_info
=True
2818 # step 2: process pending_tasks, delete not needed tasks
2820 if self
.tasks_to_delete
:
2821 self
._process
_delete
_db
_tasks
()
2824 # Log RO tasks only when loglevel is DEBUG
2825 if self.logger.getEffectiveLevel() == logging.DEBUG:
2826 _ = self._get_db_all_tasks()
2828 ro_task
= self
._get
_db
_task
()
2830 self
.logger
.debug("Task to process: {}".format(ro_task
))
2832 self
._process
_pending
_tasks
(ro_task
)
2836 except Exception as e
:
2837 self
.logger
.critical(
2838 "Unexpected exception at run: " + str(e
), exc_info
=True
2841 self
.logger
.info("Finishing")