""""
This is thread that interacts with a VIM. It processes TASKs sequentially against a single VIM.
The tasks are stored at database in table vim_actions
-The task content is:
+The task content is (M: stored at memory, D: stored at database):
MD instance_action_id: reference a global action over an instance-scenario: database instance_actions
- MD task_index: index number of the task. This with the previous are a key
+ MD task_index: index number of the task. This together with the previous forms a unique key identifier
MD datacenter_vim_id: should contain the uuid of the VIM managed by this thread
MD vim_id: id of the vm,net,etc at VIM
- MD action: CREATE, DELETE, LOOK, TODO: LOOK_CREATE
+ MD action: CREATE, DELETE, FIND
MD item: database table name, can be instance_vms, instance_nets, TODO: datacenter_flavors, datacenter_images
- MD item_id: uuid of the referenced entry in the preious table
+ MD item_id: uuid of the referenced entry in the previous table
MD status: SCHEDULED,BUILD,DONE,FAILED,SUPERSEDED
MD extra: text with yaml format at database, dict at memory with:
- params: list with the params to be sent to the VIM for CREATE or LOOK. For DELETE the vim_id is taken from other related tasks
- depends_on: list with the 'task_index'es of tasks that must be completed before. e.g. a vm depends on a net
+ params: list with the params to be sent to the VIM for CREATE or FIND. For DELETE the vim_id is taken from other related tasks
+ find: (only for CREATE tasks) if present it should FIND before creating and use if existing. Contains the FIND params
+ depends_on: list with the 'task_index'es of tasks that must be completed before. e.g. a vm creation depends on a net creation
sdn_net_id: used for net.
tries:
interfaces: used for VMs. Each key is the uuid of the instance_interfaces entry at database
iface_id: uuid of intance_interfaces
sdn_port_id:
sdn_net_id:
+ created_items: dictionary with extra elements created that need to be deleted. e.g. ports, volumes,...
created: False if the VIM element is not created by other actions, and it should not be deleted
vim_status: VIM status of the element. Stored also at database in the instance_XXX
M depends: dict with task_index(from depends_on) to task class
__author__ = "Alfonso Tierno, Pablo Montes"
__date__ = "$28-Sep-2017 12:07:15$"
-# from logging import Logger
-# import auxiliary_functions as af
-
def is_task_id(task_id):
return task_id.startswith("TASK-")
pass
+class VimThreadExceptionNotFound(VimThreadException):
+ pass
+
+
class vim_thread(threading.Thread):
REFRESH_BUILD = 5 # 5 seconds
REFRESH_ACTIVE = 60 # 1 minute
- def __init__(self, vimconn, task_lock, name=None, datacenter_name=None, datacenter_tenant_id=None,
+ def __init__(self, myvimconn, task_lock, name=None, datacenter_name=None, datacenter_tenant_id=None,
db=None, db_lock=None, ovim=None):
"""Init a thread.
Arguments:
'db', 'db_lock': database class and lock to use it in exclusion
"""
threading.Thread.__init__(self)
- self.vim = vimconn
+ if isinstance(myvimconn, vimconn.vimconnException):
+ self.vim = None
+ self.error_status = "Error accesing to VIM: {}".format(myvimconn)
+ else:
+ self.vim = myvimconn
+ self.error_status = None
self.datacenter_name = datacenter_name
self.datacenter_tenant_id = datacenter_tenant_id
self.ovim = ovim
task_list = []
old_action_key = None
- with self.db_lock:
- vim_actions = self.db.get_rows(FROM="vim_actions",
- WHERE={"datacenter_vim_id": self.datacenter_tenant_id },
- ORDER_BY=("item", "item_id", "created_at",))
- for task in vim_actions:
- item = task["item"]
- item_id = task["item_id"]
- action_key = item + item_id
- if old_action_key != action_key:
- if not action_completed and task_list:
- # This will fill needed task parameters into memory, and insert the task if needed in
- # self.pending_tasks or self.refresh_tasks
- self._insert_pending_tasks(task_list)
- task_list = []
- old_action_key = action_key
- action_completed = False
- elif action_completed:
- continue
+ old_item_id = ""
+ old_item = ""
+ old_created_at = 0.0
+ database_limit = 200
+ while True:
+ # get 200 (database_limit) entries each time
+ with self.db_lock:
+ vim_actions = self.db.get_rows(FROM="vim_actions",
+ WHERE={"datacenter_vim_id": self.datacenter_tenant_id,
+ "item_id>=": old_item_id},
+ ORDER_BY=("item_id", "item", "created_at",),
+ LIMIT=database_limit)
+ for task in vim_actions:
+ item = task["item"]
+ item_id = task["item_id"]
+
+ # skip the first entries that are already processed in the previous pool of 200
+ if old_item_id:
+ if item_id == old_item_id and item == old_item and task["created_at"] == old_created_at:
+ old_item_id = False # next one will be a new un-processed task
+ continue
- if task["status"] == "SCHEDULED" or task["action"] == "CREATE" or task["action"] == "FIND":
- task_list.append(task)
- elif task["action"] == "DELETE":
- # action completed because deleted and status is not SCHEDULED. Not needed anything
- action_completed = True
+ action_key = item + item_id
+ if old_action_key != action_key:
+ if not action_completed and task_list:
+ # This will fill needed task parameters into memory, and insert the task if needed in
+ # self.pending_tasks or self.refresh_tasks
+ self._insert_pending_tasks(task_list)
+ task_list = []
+ old_action_key = action_key
+ action_completed = False
+ elif action_completed:
+ continue
+ if task["status"] == "SCHEDULED" or task["action"] == "CREATE" or task["action"] == "FIND":
+ task_list.append(task)
+ elif task["action"] == "DELETE":
+ # action completed because deleted and status is not SCHEDULED. Not needed anything
+ action_completed = True
+ if len(vim_actions) == database_limit:
+ # update variables for get the next database iteration
+ old_item_id = item_id
+ old_item = item
+ old_created_at = task["created_at"]
+ else:
+ break
# Last actions group need to be inserted too
if not action_completed and task_list:
self._insert_pending_tasks(task_list)
+ self.logger.debug("reloaded vim actions pending:{} refresh:{}".format(
+ len(self.pending_tasks), len(self.refresh_tasks)))
def _refres_elements(self):
"""Call VIM to get VMs and networks status until 10 elements"""
if vim_info.get("error_msg"):
vim_info["error_msg"] = self._format_vim_error_msg(vim_info["error_msg"])
if task_vim_status != vim_info["status"] or task_error_msg != vim_info.get("error_msg") or \
- task_vim_info != vim_info["vim_info"]:
+ task_vim_info != vim_info.get("vim_info"):
task["extra"]["vim_status"] = vim_info["status"]
task["error_msg"] = vim_info.get("error_msg")
- task["vim_info"] = vim_info["vim_info"]
+ task["vim_info"] = vim_info.get("vim_info")
temp_dict = {"status": vim_info["status"],
"error_msg": vim_info.get("error_msg"),
- "vim_info": vim_info["vim_info"]}
+ "vim_info": vim_info.get("vim_info")}
with self.db_lock:
self.db.update_rows('instance_nets', UPDATE=temp_dict, WHERE={"uuid": task["item_id"]})
self.db.update_rows(
"""Insert a task at list of refreshing elements. The refreshing list is ordered by threshold_time (task['modified_at']
It is assumed that this is called inside this thread
"""
+ if not self.vim:
+ return
if not threshold_time:
threshold_time = time.time()
task["modified_at"] = threshold_time
while self.pending_tasks:
task = self.pending_tasks.pop(0)
nb_processed += 1
- if task["status"] == "SUPERSEDED":
- # not needed to do anything but update database with the new status
- result = True
- database_update = None
- elif task["item"] == 'instance_vms':
- if task["action"] == "CREATE":
- result, database_update = self.new_vm(task)
- nb_created += 1
- elif task["action"] == "DELETE":
- result, database_update = self.del_vm(task)
- else:
- raise vimconn.vimconnException(self.name + "unknown task action {}".format(task["action"]))
- elif task["item"] == 'instance_nets':
- if task["action"] == "CREATE":
- result, database_update = self.new_net(task)
- nb_created += 1
- elif task["action"] == "DELETE":
- result, database_update = self.del_net(task)
- elif task["action"] == "FIND":
- result, database_update = self.get_net(task)
+ try:
+ # check if tasks that this depends on have been completed
+ dependency_not_completed = False
+ for task_index in task["extra"].get("depends_on", ()):
+ task_dependency = task["depends"].get("TASK-" + str(task_index))
+ if not task_dependency:
+ task_dependency = self._look_for_task(task["instance_action_id"], "TASK-" + str(task_index))
+ if not task_dependency:
+ raise VimThreadException(
+ "Cannot get depending net task trying to get depending task {}.{}".format(
+ task["instance_action_id"], task_index))
+ # task["depends"]["TASK-" + str(task_index)] = task_dependency #it references another object,so database must be look again
+ if task_dependency["status"] == "SCHEDULED":
+ dependency_not_completed = True
+ break
+ elif task_dependency["status"] == "FAILED":
+ raise VimThreadException(
+ "Cannot {} {}, task {}.{} {} because depends on failed {} {}, task{}.{}"
+ "task {}.{}".format(task["action"], task["item"],
+ task["instance_action_id"], task["task_index"],
+ task_dependency["instance_action_id"], task_dependency["task_index"],
+ task_dependency["action"], task_dependency["item"] ))
+ if dependency_not_completed:
+ # Move this task to the end.
+ task["extra"]["tries"] = task["extra"].get("tries", 0) + 1
+ if task["extra"]["tries"] <= 3:
+ self.pending_tasks.append(task)
+ continue
+ else:
+ raise VimThreadException(
+ "Cannot {} {}, (task {}.{}) because timeout waiting to complete {} {}, "
+ "(task {}.{})".format(task["action"], task["item"],
+ task["instance_action_id"], task["task_index"],
+ task_dependency["instance_action_id"], task_dependency["task_index"],
+ task_dependency["action"], task_dependency["item"]))
+
+ if task["status"] == "SUPERSEDED":
+ # not needed to do anything but update database with the new status
+ result = True
+ database_update = None
+ elif not self.vim:
+ task["status"] == "ERROR"
+ task["error_msg"] = self.error_status
+ result = False
+ database_update = {"status": "VIM_ERROR", "error_msg": task["error_msg"]}
+ elif task["item"] == 'instance_vms':
+ if task["action"] == "CREATE":
+ result, database_update = self.new_vm(task)
+ nb_created += 1
+ elif task["action"] == "DELETE":
+ result, database_update = self.del_vm(task)
+ else:
+ raise vimconn.vimconnException(self.name + "unknown task action {}".format(task["action"]))
+ elif task["item"] == 'instance_nets':
+ if task["action"] == "CREATE":
+ result, database_update = self.new_net(task)
+ nb_created += 1
+ elif task["action"] == "DELETE":
+ result, database_update = self.del_net(task)
+ elif task["action"] == "FIND":
+ result, database_update = self.get_net(task)
+ else:
+ raise vimconn.vimconnException(self.name + "unknown task action {}".format(task["action"]))
else:
- raise vimconn.vimconnException(self.name + "unknown task action {}".format(task["action"]))
- else:
- raise vimconn.vimconnException(self.name + "unknown task item {}".format(task["item"]))
- # TODO
+ raise vimconn.vimconnException(self.name + "unknown task item {}".format(task["item"]))
+ # TODO
+ except VimThreadException as e:
+ result = False
+ task["error_msg"] = str(e)
+ task["status"] = "FAILED"
+ database_update = {"status": "VIM_ERROR", "vim_vm_id": None, "error_msg": task["error_msg"]}
- if task["status"] == "SCHEDULED":
- # This is because a depend task is not completed. Moved to the end. NOT USED YET
- if task["extra"].get("tries", 0) > 3:
- task["status"] == "FAILED"
- else:
- task["extra"]["tries"] = task["extra"].get("tries", 0) + 1
- self.pending_tasks.append(task)
- elif task["action"] == "DELETE":
+ if task["action"] == "DELETE":
action_key = task["item"] + task["item_id"]
del self.grouped_tasks[action_key]
elif task["action"] in ("CREATE", "FIND") and task["status"] in ("DONE", "BUILD"):
with self.db_lock:
self.db.update_rows(
table="vim_actions",
- UPDATE={"status": task["status"], "vim_id": task["vim_id"], "modified_at": now,
+ UPDATE={"status": task["status"], "vim_id": task.get("vim_id"), "modified_at": now,
"error_msg": task["error_msg"],
"extra": yaml.safe_dump(task["extra"], default_flow_style=True, width=256)},
WHERE={"instance_action_id": task["instance_action_id"], "task_index": task["task_index"]})
for to_supersede in self.grouped_tasks.get(action_key, ()):
if to_supersede["action"] == "FIND" and to_supersede.get("vim_id"):
task["vim_id"] = to_supersede["vim_id"]
- if to_supersede["action"] == "CREATE" and to_supersede.get("vim_id"):
+ if to_supersede["action"] == "CREATE" and to_supersede.get("vim_id") and \
+ to_supersede["extra"].get("created", True):
need_delete_action = True
task["vim_id"] = to_supersede["vim_id"]
if to_supersede["extra"].get("sdn_vim_id"):
task["extra"]["sdn_vim_id"] = to_supersede["extra"]["sdn_vim_id"]
if to_supersede["extra"].get("interfaces"):
task["extra"]["interfaces"] = to_supersede["extra"]["interfaces"]
+ if to_supersede["extra"].get("created_items"):
+ if not task["extra"].get("created_items"):
+ task["extra"]["created_items"] = {}
+ task["extra"]["created_items"].update(to_supersede["extra"]["created_items"])
# Mark task as SUPERSEDED.
# If task is in self.pending_tasks, it will be removed and database will be update
# If task is in self.refresh_tasks, it will be removed
return error_text[:max_length//2-3] + " ... " + error_text[-max_length//2+3:]
return error_text
- def new_net(self, task):
- try:
- task_id = task["instance_action_id"] + "." + str(task["task_index"])
- params = task["params"]
- vim_net_id = self.vim.new_network(*params)
-
- net_name = params[0]
- net_type = params[1]
-
- network = None
- sdn_net_id = None
- sdn_controller = self.vim.config.get('sdn-controller')
- if sdn_controller and (net_type == "data" or net_type == "ptp"):
- network = {"name": net_name, "type": net_type, "region": self.vim["config"]["datacenter_id"]}
-
- vim_net = self.vim.get_network(vim_net_id)
- if vim_net.get('encapsulation') != 'vlan':
- raise vimconn.vimconnException(
- "net '{}' defined as type '{}' has not vlan encapsulation '{}'".format(
- net_name, net_type, vim_net['encapsulation']))
- network["vlan"] = vim_net.get('segmentation_id')
- try:
- with self.db_lock:
- sdn_net_id = self.ovim.new_network(network)
- except (ovimException, Exception) as e:
- self.logger.error("task=%s cannot create SDN network vim_net_id=%s input='%s' ovimException='%s'",
- str(task_id), vim_net_id, str(network), str(e))
- task["status"] = "DONE"
- task["extra"]["vim_info"] = {}
- task["extra"]["sdn_net_id"] = sdn_net_id
- task["error_msg"] = None
- task["vim_id"] = vim_net_id
- instance_element_update = {"vim_net_id": vim_net_id, "sdn_net_id": sdn_net_id, "status": "BUILD", "error_msg": None}
- return True, instance_element_update
- except vimconn.vimconnException as e:
- self.logger.error("Error creating NET, task=%s: %s", str(task_id), str(e))
- task["status"] = "FAILED"
- task["vim_id"] = None
- task["error_msg"] = self._format_vim_error_msg(str(e))
- instance_element_update = {"vim_net_id": None, "sdn_net_id": None, "status": "VIM_ERROR", "error_msg": task["error_msg"]}
- return False, instance_element_update
-
def new_vm(self, task):
try:
params = task["params"]
error_text = ""
for net in net_list:
if "net_id" in net and is_task_id(net["net_id"]): # change task_id into network_id
- if net["net_id"] in depends:
- task_net = depends[net["net_id"]]
- else:
- task_net = self._look_for_task(task["instance_action_id"], net["net_id"])
- if not task_net:
- raise VimThreadException(
- "Error trying to get depending task from task_index={}".format(net["net_id"]))
- network_id = task_net.get("vim_id")
+ task_dependency = task["depends"].get(net["net_id"])
+ if not task_dependency:
+ task_dependency = self._look_for_task(task["instance_action_id"], net["net_id"])
+ if not task_dependency:
+ raise VimThreadException(
+ "Cannot get depending net task trying to get depending task {}.{}".format(
+ task["instance_action_id"], net["net_id"]))
+ network_id = task_dependency.get("vim_id")
if not network_id:
raise VimThreadException(
"Cannot create VM because depends on a network not created or found: " +
- str(task_net["error_msg"]))
+ str(depends[net["net_id"]]["error_msg"]))
net["net_id"] = network_id
- vim_vm_id = self.vim.new_vminstance(*params)
+ vim_vm_id, created_items = self.vim.new_vminstance(*params)
# fill task_interfaces. Look for snd_net_id at database for each interface
task_interfaces = {}
task["vim_info"] = {}
task["vim_interfaces"] = {}
task["extra"]["interfaces"] = task_interfaces
+ task["extra"]["created"] = True
+ task["extra"]["created_items"] = created_items
task["error_msg"] = None
task["status"] = "DONE"
task["vim_id"] = vim_vm_id
iface["sdn_port_id"], vm_vim_id) + str(e), exc_info=True)
# TODO Set error_msg at instance_nets
- self.vim.delete_vminstance(vm_vim_id)
+ self.vim.delete_vminstance(vm_vim_id, task["extra"].get("created_items"))
task["status"] = "DONE"
task["error_msg"] = None
return True, None
task["status"] = "FAILED"
return False, None
+ def _get_net_internal(self, task, filter_param):
+ """
+ Common code for get_net and new_net. It looks for a network on VIM with the filter_params
+ :param task: task for this find or find-or-create action
+ :param filter_param: parameters to send to the vimconnector
+ :return: a dict with the content to update the instance_nets database table. Raises an exception on error, or
+ when network is not found or found more than one
+ """
+ vim_nets = self.vim.get_network_list(filter_param)
+ if not vim_nets:
+ raise VimThreadExceptionNotFound("Network not found with this criteria: '{}'".format(filter))
+ elif len(vim_nets) > 1:
+ raise VimThreadException("More than one network found with this criteria: '{}'".format(filter))
+ vim_net_id = vim_nets[0]["id"]
+
+ # Discover if this network is managed by a sdn controller
+ sdn_net_id = None
+ with self.db_lock:
+ result = self.db.get_rows(SELECT=('sdn_net_id',), FROM='instance_nets',
+ WHERE={'vim_net_id': vim_net_id, 'instance_scenario_id': None,
+ 'datacenter_tenant_id': self.datacenter_tenant_id})
+ if result:
+ sdn_net_id = result[0]['sdn_net_id']
+
+ task["status"] = "DONE"
+ task["extra"]["vim_info"] = {}
+ task["extra"]["created"] = False
+ task["extra"]["sdn_net_id"] = sdn_net_id
+ task["error_msg"] = None
+ task["vim_id"] = vim_net_id
+ instance_element_update = {"vim_net_id": vim_net_id, "created": False, "status": "BUILD",
+ "error_msg": None}
+ return instance_element_update
+
+ def get_net(self, task):
+ try:
+ task_id = task["instance_action_id"] + "." + str(task["task_index"])
+ params = task["params"]
+ filter_param = params[0]
+ instance_element_update = self._get_net_internal(task, filter_param)
+ return True, instance_element_update
+
+ except (vimconn.vimconnException, VimThreadException) as e:
+ self.logger.error("Error looking for NET, task=%s: %s", str(task_id), str(e))
+ task["status"] = "FAILED"
+ task["vim_id"] = None
+ task["error_msg"] = self._format_vim_error_msg(str(e))
+ instance_element_update = {"vim_net_id": None, "status": "VIM_ERROR",
+ "error_msg": task["error_msg"]}
+ return False, instance_element_update
+
+ def new_net(self, task):
+ try:
+ task_id = task["instance_action_id"] + "." + str(task["task_index"])
+ # FIND
+ if task["extra"].get("find"):
+ action_text = "finding"
+ filter_param = task["extra"]["find"][0]
+ try:
+ instance_element_update = self._get_net_internal(task, filter_param)
+ return True, instance_element_update
+ except VimThreadExceptionNotFound:
+ pass
+ # CREATE
+ params = task["params"]
+ action_text = "creating"
+ vim_net_id = self.vim.new_network(*params)
+
+ net_name = params[0]
+ net_type = params[1]
+
+ sdn_net_id = None
+ sdn_controller = self.vim.config.get('sdn-controller')
+ if sdn_controller and (net_type == "data" or net_type == "ptp"):
+ network = {"name": net_name, "type": net_type, "region": self.vim["config"]["datacenter_id"]}
+
+ vim_net = self.vim.get_network(vim_net_id)
+ if vim_net.get('encapsulation') != 'vlan':
+ raise vimconn.vimconnException(
+ "net '{}' defined as type '{}' has not vlan encapsulation '{}'".format(
+ net_name, net_type, vim_net['encapsulation']))
+ network["vlan"] = vim_net.get('segmentation_id')
+ try:
+ with self.db_lock:
+ sdn_net_id = self.ovim.new_network(network)
+ except (ovimException, Exception) as e:
+ self.logger.error("task=%s cannot create SDN network vim_net_id=%s input='%s' ovimException='%s'",
+ str(task_id), vim_net_id, str(network), str(e))
+ task["status"] = "DONE"
+ task["extra"]["vim_info"] = {}
+ task["extra"]["sdn_net_id"] = sdn_net_id
+ task["extra"]["created"] = True
+ task["error_msg"] = None
+ task["vim_id"] = vim_net_id
+ instance_element_update = {"vim_net_id": vim_net_id, "sdn_net_id": sdn_net_id, "status": "BUILD",
+ "created": True, "error_msg": None}
+ return True, instance_element_update
+ except vimconn.vimconnException as e:
+ self.logger.error("Error {} NET, task=%s: %s", action_text, str(task_id), str(e))
+ task["status"] = "FAILED"
+ task["vim_id"] = None
+ task["error_msg"] = self._format_vim_error_msg(str(e))
+ instance_element_update = {"vim_net_id": None, "sdn_net_id": None, "status": "VIM_ERROR",
+ "error_msg": task["error_msg"]}
+ return False, instance_element_update
+
def del_net(self, task):
net_vim_id = task["vim_id"]
sdn_net_id = task["extra"].get("sdn_net_id")
return True, None
task["status"] = "FAILED"
return False, None
-
- def get_net(self, task):
- try:
- task_id = task["instance_action_id"] + "." + str(task["task_index"])
- params = task["params"]
- filter = params[0]
- vim_nets = self.vim.get_network_list(filter)
- if not vim_nets:
- raise VimThreadException("Network not found with this criteria: '{}'".format(filter))
- elif len(vim_nets) > 1:
- raise VimThreadException("More than one network found with this criteria: '{}'".format(filter))
- vim_net_id = vim_nets[0]["id"]
-
- # Discover if this network is managed by a sdn controller
- sdn_net_id = None
- with self.db_lock:
- result = self.db.get_rows(SELECT=('sdn_net_id',), FROM='instance_nets',
- WHERE={'vim_net_id': vim_net_id, 'instance_scenario_id': None,
- 'datacenter_tenant_id': self.datacenter_tenant_id})
- if result:
- sdn_net_id = result[0]['sdn_net_id']
-
- task["status"] = "DONE"
- task["extra"]["vim_info"] = {}
- task["extra"]["created"] = False
- task["extra"]["sdn_net_id"] = sdn_net_id
- task["error_msg"] = None
- task["vim_id"] = vim_net_id
- instance_element_update = {"vim_net_id": vim_net_id, "created": False, "status": "BUILD",
- "error_msg": None}
- return True, instance_element_update
- except (vimconn.vimconnException, VimThreadException) as e:
- self.logger.error("Error looking for NET, task=%s: %s", str(task_id), str(e))
- task["status"] = "FAILED"
- task["vim_id"] = None
- task["error_msg"] = self._format_vim_error_msg(str(e))
- instance_element_update = {"vim_net_id": None, "status": "VIM_ERROR",
- "error_msg": task["error_msg"]}
- return False, instance_element_update