osm_ro/vimconn_openstack.py

   1 # -*- coding: utf-8 -*-
   2
   3 ##
   4 # Copyright 2015 Telefónica Investigación y Desarrollo, S.A.U.
   5 # This file is part of openmano
   6 # All Rights Reserved.
   7 #
   8 # Licensed under the Apache License, Version 2.0 (the "License"); you may
   9 # not use this file except in compliance with the License. You may obtain
  10 # a copy of the License at
  11 #
  12 #         http://www.apache.org/licenses/LICENSE-2.0
  13 #
  14 # Unless required by applicable law or agreed to in writing, software
  15 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  16 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  17 # License for the specific language governing permissions and limitations
  18 # under the License.
  19 #
  20 # For those usages not covered by the Apache License, Version 2.0 please
  21 # contact with: nfvlabs@tid.es
  22 ##
  23
  24 '''
  25 osconnector implements all the methods to interact with openstack using the python-client.
  26 '''
  27 __author__="Alfonso Tierno, Gerardo Garcia, Pablo Montes, xFlow Research"
  28 __date__ ="$22-jun-2014 11:19:29$"
  29
  30 import vimconn
  31 import json
  32 import yaml
  33 import logging
  34 import netaddr
  35 import time
  36 import yaml
  37 import random
  38
  39 from novaclient import client as nClient, exceptions as nvExceptions
  40 from keystoneauth1.identity import v2, v3
  41 from keystoneauth1 import session
  42 import keystoneclient.exceptions as ksExceptions
  43 import keystoneclient.v3.client as ksClient_v3
  44 import keystoneclient.v2_0.client as ksClient_v2
  45 from glanceclient import client as glClient
  46 import glanceclient.client as gl1Client
  47 import glanceclient.exc as gl1Exceptions
  48 from  cinderclient import client as cClient
  49 from httplib import HTTPException
  50 from neutronclient.neutron import client as neClient
  51 from neutronclient.common import exceptions as neExceptions
  52 from requests.exceptions import ConnectionError
  53
  54 '''contain the openstack virtual machine status to openmano status'''
  55 vmStatus2manoFormat={'ACTIVE':'ACTIVE',
  56                      'PAUSED':'PAUSED',
  57                      'SUSPENDED': 'SUSPENDED',
  58                      'SHUTOFF':'INACTIVE',
  59                      'BUILD':'BUILD',
  60                      'ERROR':'ERROR','DELETED':'DELETED'
  61                      }
  62 netStatus2manoFormat={'ACTIVE':'ACTIVE','PAUSED':'PAUSED','INACTIVE':'INACTIVE','BUILD':'BUILD','ERROR':'ERROR','DELETED':'DELETED'
  63                      }
  64
  65 #global var to have a timeout creating and deleting volumes
  66 volume_timeout = 60
  67 server_timeout = 300
  68
  69 class vimconnector(vimconn.vimconnector):
  70     def __init__(self, uuid, name, tenant_id, tenant_name, url, url_admin=None, user=None, passwd=None,
  71                  log_level=None, config={}, persistent_info={}):
  72         '''using common constructor parameters. In this case
  73         'url' is the keystone authorization url,
  74         'url_admin' is not use
  75         '''
  76         api_version = config.get('APIversion')
  77         if api_version and api_version not in ('v3.3', 'v2.0', '2', '3'):
  78             raise vimconn.vimconnException("Invalid value '{}' for config:APIversion. "
  79                                            "Allowed values are 'v3.3', 'v2.0', '2' or '3'".format(api_version))
  80         vimconn.vimconnector.__init__(self, uuid, name, tenant_id, tenant_name, url, url_admin, user, passwd, log_level,
  81                                       config)
  82
  83         self.insecure = self.config.get("insecure", False)
  84         if not url:
  85             raise TypeError, 'url param can not be NoneType'
  86         self.persistent_info = persistent_info
  87         self.session = persistent_info.get('session', {'reload_client': True})
  88         self.nova = self.session.get('nova')
  89         self.neutron = self.session.get('neutron')
  90         self.cinder = self.session.get('cinder')
  91         self.glance = self.session.get('glance')
  92         self.glancev1 = self.session.get('glancev1')
  93         self.keystone = self.session.get('keystone')
  94         self.api_version3 = self.session.get('api_version3')
  95
  96         self.logger = logging.getLogger('openmano.vim.openstack')
  97         if log_level:
  98             self.logger.setLevel( getattr(logging, log_level) )
  99
 100     def __getitem__(self, index):
 101         """Get individuals parameters.
 102         Throw KeyError"""
 103         if index == 'project_domain_id':
 104             return self.config.get("project_domain_id")
 105         elif index == 'user_domain_id':
 106             return self.config.get("user_domain_id")
 107         else:
 108             return vimconn.vimconnector.__getitem__(self, index)
 109
 110     def __setitem__(self, index, value):
 111         """Set individuals parameters and it is marked as dirty so to force connection reload.
 112         Throw KeyError"""
 113         if index == 'project_domain_id':
 114             self.config["project_domain_id"] = value
 115         elif index == 'user_domain_id':
 116                 self.config["user_domain_id"] = value
 117         else:
 118             vimconn.vimconnector.__setitem__(self, index, value)
 119         self.session['reload_client'] = True
 120
 121     def _reload_connection(self):
 122         '''Called before any operation, it check if credentials has changed
 123         Throw keystoneclient.apiclient.exceptions.AuthorizationFailure
 124         '''
 125         #TODO control the timing and possible token timeout, but it seams that python client does this task for us :-)
 126         if self.session['reload_client']:
 127             if self.config.get('APIversion'):
 128                 self.api_version3 = self.config['APIversion'] == 'v3.3' or self.config['APIversion'] == '3'
 129             else:  # get from ending auth_url that end with v3 or with v2.0
 130                 self.api_version3 =  self.url.split("/")[-1] == "v3"
 131             self.session['api_version3'] = self.api_version3
 132             if self.api_version3:
 133                 auth = v3.Password(auth_url=self.url,
 134                                    username=self.user,
 135                                    password=self.passwd,
 136                                    project_name=self.tenant_name,
 137                                    project_id=self.tenant_id,
 138                                    project_domain_id=self.config.get('project_domain_id', 'default'),
 139                                    user_domain_id=self.config.get('user_domain_id', 'default'))
 140             else:
 141                 auth = v2.Password(auth_url=self.url,
 142                                    username=self.user,
 143                                    password=self.passwd,
 144                                    tenant_name=self.tenant_name,
 145                                    tenant_id=self.tenant_id)
 146             sess = session.Session(auth=auth, verify=not self.insecure)
 147             if self.api_version3:
 148                 self.keystone = ksClient_v3.Client(session=sess)
 149             else:
 150                 self.keystone = ksClient_v2.Client(session=sess)
 151             self.session['keystone'] = self.keystone
 152             # In order to enable microversion functionality an explicit microversion must be specified in 'config'.
 153             # This implementation approach is due to the warning message in
 154             # https://developer.openstack.org/api-guide/compute/microversions.html
 155             # where it is stated that microversion backwards compatibility is not guaranteed and clients should
 156             # always require an specific microversion.
 157             # To be able to use 'device role tagging' functionality define 'microversion: 2.32' in datacenter config
 158             version = self.config.get("microversion")
 159             if not version:
 160                 version = "2.1"
 161             self.nova = self.session['nova'] = nClient.Client(str(version), session=sess)
 162             self.neutron = self.session['neutron'] = neClient.Client('2.0', session=sess)
 163             self.cinder = self.session['cinder'] = cClient.Client(2, session=sess)
 164             self.glance = self.session['glance'] = glClient.Client(2, session=sess)
 165             self.glancev1 = self.session['glancev1'] = glClient.Client('1', session=sess)
 166             self.session['reload_client'] = False
 167             self.persistent_info['session'] = self.session
 168
 169     def __net_os2mano(self, net_list_dict):
 170         '''Transform the net openstack format to mano format
 171         net_list_dict can be a list of dict or a single dict'''
 172         if type(net_list_dict) is dict:
 173             net_list_=(net_list_dict,)
 174         elif type(net_list_dict) is list:
 175             net_list_=net_list_dict
 176         else:
 177             raise TypeError("param net_list_dict must be a list or a dictionary")
 178         for net in net_list_:
 179             if net.get('provider:network_type') == "vlan":
 180                 net['type']='data'
 181             else:
 182                 net['type']='bridge'
 183
 184     def _format_exception(self, exception):
 185         '''Transform a keystone, nova, neutron  exception into a vimconn exception'''
 186         if isinstance(exception, (HTTPException, gl1Exceptions.HTTPException, gl1Exceptions.CommunicationError,
 187                                   ConnectionError, ksExceptions.ConnectionError, neExceptions.ConnectionFailed
 188                                   )):
 189             raise vimconn.vimconnConnectionException(type(exception).__name__ + ": " + str(exception))
 190         elif isinstance(exception, (nvExceptions.ClientException, ksExceptions.ClientException,
 191                                     neExceptions.NeutronException, nvExceptions.BadRequest)):
 192             raise vimconn.vimconnUnexpectedResponse(type(exception).__name__ + ": " + str(exception))
 193         elif isinstance(exception, (neExceptions.NetworkNotFoundClient, nvExceptions.NotFound)):
 194             raise vimconn.vimconnNotFoundException(type(exception).__name__ + ": " + str(exception))
 195         elif isinstance(exception, nvExceptions.Conflict):
 196             raise vimconn.vimconnConflictException(type(exception).__name__ + ": " + str(exception))
 197         elif isinstance(exception, vimconn.vimconnException):
 198             raise
 199         else:  # ()
 200             self.logger.error("General Exception " + str(exception), exc_info=True)
 201             raise vimconn.vimconnConnectionException(type(exception).__name__ + ": " + str(exception))
 202
 203     def get_tenant_list(self, filter_dict={}):
 204         '''Obtain tenants of VIM
 205         filter_dict can contain the following keys:
 206             name: filter by tenant name
 207             id: filter by tenant uuid/id
 208             <other VIM specific>
 209         Returns the tenant list of dictionaries: [{'name':'<name>, 'id':'<id>, ...}, ...]
 210         '''
 211         self.logger.debug("Getting tenants from VIM filter: '%s'", str(filter_dict))
 212         try:
 213             self._reload_connection()
 214             if self.api_version3:
 215                 project_class_list = self.keystone.projects.list(name=filter_dict.get("name"))
 216             else:
 217                 project_class_list = self.keystone.tenants.findall(**filter_dict)
 218             project_list=[]
 219             for project in project_class_list:
 220                 if filter_dict.get('id') and filter_dict["id"] != project.id:
 221                     continue
 222                 project_list.append(project.to_dict())
 223             return project_list
 224         except (ksExceptions.ConnectionError, ksExceptions.ClientException, ConnectionError) as e:
 225             self._format_exception(e)
 226
 227     def new_tenant(self, tenant_name, tenant_description):
 228         '''Adds a new tenant to openstack VIM. Returns the tenant identifier'''
 229         self.logger.debug("Adding a new tenant name: %s", tenant_name)
 230         try:
 231             self._reload_connection()
 232             if self.api_version3:
 233                 project = self.keystone.projects.create(tenant_name, self.config.get("project_domain_id", "default"),
 234                                                         description=tenant_description, is_domain=False)
 235             else:
 236                 project = self.keystone.tenants.create(tenant_name, tenant_description)
 237             return project.id
 238         except (ksExceptions.ConnectionError, ksExceptions.ClientException, ConnectionError)  as e:
 239             self._format_exception(e)
 240
 241     def delete_tenant(self, tenant_id):
 242         '''Delete a tenant from openstack VIM. Returns the old tenant identifier'''
 243         self.logger.debug("Deleting tenant %s from VIM", tenant_id)
 244         try:
 245             self._reload_connection()
 246             if self.api_version3:
 247                 self.keystone.projects.delete(tenant_id)
 248             else:
 249                 self.keystone.tenants.delete(tenant_id)
 250             return tenant_id
 251         except (ksExceptions.ConnectionError, ksExceptions.ClientException, ConnectionError)  as e:
 252             self._format_exception(e)
 253
 254     def new_network(self,net_name, net_type, ip_profile=None, shared=False, vlan=None):
 255         '''Adds a tenant network to VIM. Returns the network identifier'''
 256         self.logger.debug("Adding a new network to VIM name '%s', type '%s'", net_name, net_type)
 257         #self.logger.debug(">>>>>>>>>>>>>>>>>> IP profile %s", str(ip_profile))
 258         try:
 259             new_net = None
 260             self._reload_connection()
 261             network_dict = {'name': net_name, 'admin_state_up': True}
 262             if net_type=="data" or net_type=="ptp":
 263                 if self.config.get('dataplane_physical_net') == None:
 264                     raise vimconn.vimconnConflictException("You must provide a 'dataplane_physical_net' at config value before creating sriov network")
 265                 network_dict["provider:physical_network"] = self.config['dataplane_physical_net'] #"physnet_sriov" #TODO physical
 266                 network_dict["provider:network_type"]     = "vlan"
 267                 if vlan!=None:
 268                     network_dict["provider:network_type"] = vlan
 269             network_dict["shared"]=shared
 270             new_net=self.neutron.create_network({'network':network_dict})
 271             #print new_net
 272             #create subnetwork, even if there is no profile
 273             if not ip_profile:
 274                 ip_profile = {}
 275             if 'subnet_address' not in ip_profile:
 276                 #Fake subnet is required
 277                 subnet_rand = random.randint(0, 255)
 278                 ip_profile['subnet_address'] = "192.168.{}.0/24".format(subnet_rand)
 279             if 'ip_version' not in ip_profile:
 280                 ip_profile['ip_version'] = "IPv4"
 281             subnet = {"name":net_name+"-subnet",
 282                     "network_id": new_net["network"]["id"],
 283                     "ip_version": 4 if ip_profile['ip_version']=="IPv4" else 6,
 284                     "cidr": ip_profile['subnet_address']
 285                     }
 286             # Gateway should be set to None if not needed. Otherwise openstack assigns one by default
 287             subnet['gateway_ip'] = ip_profile.get('gateway_address')
 288             if ip_profile.get('dns_address'):
 289                 subnet['dns_nameservers'] = ip_profile['dns_address'].split(";")
 290             if 'dhcp_enabled' in ip_profile:
 291                 subnet['enable_dhcp'] = False if ip_profile['dhcp_enabled']=="false" else True
 292             if 'dhcp_start_address' in ip_profile:
 293                 subnet['allocation_pools'] = []
 294                 subnet['allocation_pools'].append(dict())
 295                 subnet['allocation_pools'][0]['start'] = ip_profile['dhcp_start_address']
 296             if 'dhcp_count' in ip_profile:
 297                 #parts = ip_profile['dhcp_start_address'].split('.')
 298                 #ip_int = (int(parts[0]) << 24) + (int(parts[1]) << 16) + (int(parts[2]) << 8) + int(parts[3])
 299                 ip_int = int(netaddr.IPAddress(ip_profile['dhcp_start_address']))
 300                 ip_int += ip_profile['dhcp_count'] - 1
 301                 ip_str = str(netaddr.IPAddress(ip_int))
 302                 subnet['allocation_pools'][0]['end'] = ip_str
 303             #self.logger.debug(">>>>>>>>>>>>>>>>>> Subnet: %s", str(subnet))
 304             self.neutron.create_subnet({"subnet": subnet} )
 305             return new_net["network"]["id"]
 306         except (neExceptions.ConnectionFailed, ksExceptions.ClientException, neExceptions.NeutronException, ConnectionError) as e:
 307             if new_net:
 308                 self.neutron.delete_network(new_net['network']['id'])
 309             self._format_exception(e)
 310
 311     def get_network_list(self, filter_dict={}):
 312         '''Obtain tenant networks of VIM
 313         Filter_dict can be:
 314             name: network name
 315             id: network uuid
 316             shared: boolean
 317             tenant_id: tenant
 318             admin_state_up: boolean
 319             status: 'ACTIVE'
 320         Returns the network list of dictionaries
 321         '''
 322         self.logger.debug("Getting network from VIM filter: '%s'", str(filter_dict))
 323         try:
 324             self._reload_connection()
 325             if self.api_version3 and "tenant_id" in filter_dict:
 326                 filter_dict['project_id'] = filter_dict.pop('tenant_id') #TODO check
 327             net_dict=self.neutron.list_networks(**filter_dict)
 328             net_list=net_dict["networks"]
 329             self.__net_os2mano(net_list)
 330             return net_list
 331         except (neExceptions.ConnectionFailed, ksExceptions.ClientException, neExceptions.NeutronException, ConnectionError) as e:
 332             self._format_exception(e)
 333
 334     def get_network(self, net_id):
 335         '''Obtain details of network from VIM
 336         Returns the network information from a network id'''
 337         self.logger.debug(" Getting tenant network %s from VIM", net_id)
 338         filter_dict={"id": net_id}
 339         net_list = self.get_network_list(filter_dict)
 340         if len(net_list)==0:
 341             raise vimconn.vimconnNotFoundException("Network '{}' not found".format(net_id))
 342         elif len(net_list)>1:
 343             raise vimconn.vimconnConflictException("Found more than one network with this criteria")
 344         net = net_list[0]
 345         subnets=[]
 346         for subnet_id in net.get("subnets", () ):
 347             try:
 348                 subnet = self.neutron.show_subnet(subnet_id)
 349             except Exception as e:
 350                 self.logger.error("osconnector.get_network(): Error getting subnet %s %s" % (net_id, str(e)))
 351                 subnet = {"id": subnet_id, "fault": str(e)}
 352             subnets.append(subnet)
 353         net["subnets"] = subnets
 354         net["encapsulation"] = net.get('provider:network_type')
 355         net["segmentation_id"] = net.get('provider:segmentation_id')
 356         return net
 357
 358     def delete_network(self, net_id):
 359         '''Deletes a tenant network from VIM. Returns the old network identifier'''
 360         self.logger.debug("Deleting network '%s' from VIM", net_id)
 361         try:
 362             self._reload_connection()
 363             #delete VM ports attached to this networks before the network
 364             ports = self.neutron.list_ports(network_id=net_id)
 365             for p in ports['ports']:
 366                 try:
 367                     self.neutron.delete_port(p["id"])
 368                 except Exception as e:
 369                     self.logger.error("Error deleting port %s: %s", p["id"], str(e))
 370             self.neutron.delete_network(net_id)
 371             return net_id
 372         except (neExceptions.ConnectionFailed, neExceptions.NetworkNotFoundClient, neExceptions.NeutronException,
 373                 ksExceptions.ClientException, neExceptions.NeutronException, ConnectionError) as e:
 374             self._format_exception(e)
 375
 376     def refresh_nets_status(self, net_list):
 377         '''Get the status of the networks
 378            Params: the list of network identifiers
 379            Returns a dictionary with:
 380                 net_id:         #VIM id of this network
 381                     status:     #Mandatory. Text with one of:
 382                                 #  DELETED (not found at vim)
 383                                 #  VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
 384                                 #  OTHER (Vim reported other status not understood)
 385                                 #  ERROR (VIM indicates an ERROR status)
 386                                 #  ACTIVE, INACTIVE, DOWN (admin down),
 387                                 #  BUILD (on building process)
 388                                 #
 389                     error_msg:  #Text with VIM error message, if any. Or the VIM connection ERROR
 390                     vim_info:   #Text with plain information obtained from vim (yaml.safe_dump)
 391
 392         '''
 393         net_dict={}
 394         for net_id in net_list:
 395             net = {}
 396             try:
 397                 net_vim = self.get_network(net_id)
 398                 if net_vim['status'] in netStatus2manoFormat:
 399                     net["status"] = netStatus2manoFormat[ net_vim['status'] ]
 400                 else:
 401                     net["status"] = "OTHER"
 402                     net["error_msg"] = "VIM status reported " + net_vim['status']
 403
 404                 if net['status'] == "ACTIVE" and not net_vim['admin_state_up']:
 405                     net['status'] = 'DOWN'
 406                 try:
 407                     net['vim_info'] = yaml.safe_dump(net_vim, default_flow_style=True, width=256)
 408                 except yaml.representer.RepresenterError:
 409                     net['vim_info'] = str(net_vim)
 410                 if net_vim.get('fault'):  #TODO
 411                     net['error_msg'] = str(net_vim['fault'])
 412             except vimconn.vimconnNotFoundException as e:
 413                 self.logger.error("Exception getting net status: %s", str(e))
 414                 net['status'] = "DELETED"
 415                 net['error_msg'] = str(e)
 416             except vimconn.vimconnException as e:
 417                 self.logger.error("Exception getting net status: %s", str(e))
 418                 net['status'] = "VIM_ERROR"
 419                 net['error_msg'] = str(e)
 420             net_dict[net_id] = net
 421         return net_dict
 422
 423     def get_flavor(self, flavor_id):
 424         '''Obtain flavor details from the  VIM. Returns the flavor dict details'''
 425         self.logger.debug("Getting flavor '%s'", flavor_id)
 426         try:
 427             self._reload_connection()
 428             flavor = self.nova.flavors.find(id=flavor_id)
 429             #TODO parse input and translate to VIM format (openmano_schemas.new_vminstance_response_schema)
 430             return flavor.to_dict()
 431         except (nvExceptions.NotFound, nvExceptions.ClientException, ksExceptions.ClientException, ConnectionError) as e:
 432             self._format_exception(e)
 433
 434     def get_flavor_id_from_data(self, flavor_dict):
 435         """Obtain flavor id that match the flavor description
 436            Returns the flavor_id or raises a vimconnNotFoundException
 437            flavor_dict: contains the required ram, vcpus, disk
 438            If 'use_existing_flavors' is set to True at config, the closer flavor that provides same or more ram, vcpus
 439                 and disk is returned. Otherwise a flavor with exactly same ram, vcpus and disk is returned or a
 440                 vimconnNotFoundException is raised
 441         """
 442         exact_match = False if self.config.get('use_existing_flavors') else True
 443         try:
 444             self._reload_connection()
 445             flavor_candidate_id = None
 446             flavor_candidate_data = (10000, 10000, 10000)
 447             flavor_target = (flavor_dict["ram"], flavor_dict["vcpus"], flavor_dict["disk"])
 448             # numa=None
 449             numas = flavor_dict.get("extended", {}).get("numas")
 450             if numas:
 451                 #TODO
 452                 raise vimconn.vimconnNotFoundException("Flavor with EPA still not implemted")
 453                 # if len(numas) > 1:
 454                 #     raise vimconn.vimconnNotFoundException("Cannot find any flavor with more than one numa")
 455                 # numa=numas[0]
 456                 # numas = extended.get("numas")
 457             for flavor in self.nova.flavors.list():
 458                 epa = flavor.get_keys()
 459                 if epa:
 460                     continue
 461                     # TODO
 462                 flavor_data = (flavor.ram, flavor.vcpus, flavor.disk)
 463                 if flavor_data == flavor_target:
 464                     return flavor.id
 465                 elif not exact_match and flavor_target < flavor_data < flavor_candidate_data:
 466                     flavor_candidate_id = flavor.id
 467                     flavor_candidate_data = flavor_data
 468             if not exact_match and flavor_candidate_id:
 469                 return flavor_candidate_id
 470             raise vimconn.vimconnNotFoundException("Cannot find any flavor matching '{}'".format(str(flavor_dict)))
 471         except (nvExceptions.NotFound, nvExceptions.ClientException, ksExceptions.ClientException, ConnectionError) as e:
 472             self._format_exception(e)
 473
 474
 475     def new_flavor(self, flavor_data, change_name_if_used=True):
 476         '''Adds a tenant flavor to openstack VIM
 477         if change_name_if_used is True, it will change name in case of conflict, because it is not supported name repetition
 478         Returns the flavor identifier
 479         '''
 480         self.logger.debug("Adding flavor '%s'", str(flavor_data))
 481         retry=0
 482         max_retries=3
 483         name_suffix = 0
 484         name=flavor_data['name']
 485         while retry<max_retries:
 486             retry+=1
 487             try:
 488                 self._reload_connection()
 489                 if change_name_if_used:
 490                     #get used names
 491                     fl_names=[]
 492                     fl=self.nova.flavors.list()
 493                     for f in fl:
 494                         fl_names.append(f.name)
 495                     while name in fl_names:
 496                         name_suffix += 1
 497                         name = flavor_data['name']+"-" + str(name_suffix)
 498
 499                 ram = flavor_data.get('ram',64)
 500                 vcpus = flavor_data.get('vcpus',1)
 501                 numa_properties=None
 502
 503                 extended = flavor_data.get("extended")
 504                 if extended:
 505                     numas=extended.get("numas")
 506                     if numas:
 507                         numa_nodes = len(numas)
 508                         if numa_nodes > 1:
 509                             return -1, "Can not add flavor with more than one numa"
 510                         numa_properties = {"hw:numa_nodes":str(numa_nodes)}
 511                         numa_properties["hw:mem_page_size"] = "large"
 512                         numa_properties["hw:cpu_policy"] = "dedicated"
 513                         numa_properties["hw:numa_mempolicy"] = "strict"
 514                         for numa in numas:
 515                             #overwrite ram and vcpus
 516                             ram = numa['memory']*1024
 517                             #See for reference: https://specs.openstack.org/openstack/nova-specs/specs/mitaka/implemented/virt-driver-cpu-thread-pinning.html
 518                             if 'paired-threads' in numa:
 519                                 vcpus = numa['paired-threads']*2
 520                                 #cpu_thread_policy "require" implies that the compute node must have an STM architecture
 521                                 numa_properties["hw:cpu_thread_policy"] = "require"
 522                                 numa_properties["hw:cpu_policy"] = "dedicated"
 523                             elif 'cores' in numa:
 524                                 vcpus = numa['cores']
 525                                 # cpu_thread_policy "prefer" implies that the host must not have an SMT architecture, or a non-SMT architecture will be emulated
 526                                 numa_properties["hw:cpu_thread_policy"] = "isolate"
 527                                 numa_properties["hw:cpu_policy"] = "dedicated"
 528                             elif 'threads' in numa:
 529                                 vcpus = numa['threads']
 530                                 # cpu_thread_policy "prefer" implies that the host may or may not have an SMT architecture
 531                                 numa_properties["hw:cpu_thread_policy"] = "prefer"
 532                                 numa_properties["hw:cpu_policy"] = "dedicated"
 533                             # for interface in numa.get("interfaces",() ):
 534                             #     if interface["dedicated"]=="yes":
 535                             #         raise vimconn.vimconnException("Passthrough interfaces are not supported for the openstack connector", http_code=vimconn.HTTP_Service_Unavailable)
 536                             #     #TODO, add the key 'pci_passthrough:alias"="<label at config>:<number ifaces>"' when a way to connect it is available
 537
 538                 #create flavor
 539                 new_flavor=self.nova.flavors.create(name,
 540                                 ram,
 541                                 vcpus,
 542                                 flavor_data.get('disk',1),
 543                                 is_public=flavor_data.get('is_public', True)
 544                             )
 545                 #add metadata
 546                 if numa_properties:
 547                     new_flavor.set_keys(numa_properties)
 548                 return new_flavor.id
 549             except nvExceptions.Conflict as e:
 550                 if change_name_if_used and retry < max_retries:
 551                     continue
 552                 self._format_exception(e)
 553             #except nvExceptions.BadRequest as e:
 554             except (ksExceptions.ClientException, nvExceptions.ClientException, ConnectionError) as e:
 555                 self._format_exception(e)
 556
 557     def delete_flavor(self,flavor_id):
 558         '''Deletes a tenant flavor from openstack VIM. Returns the old flavor_id
 559         '''
 560         try:
 561             self._reload_connection()
 562             self.nova.flavors.delete(flavor_id)
 563             return flavor_id
 564         #except nvExceptions.BadRequest as e:
 565         except (nvExceptions.NotFound, ksExceptions.ClientException, nvExceptions.ClientException, ConnectionError) as e:
 566             self._format_exception(e)
 567
 568     def new_image(self,image_dict):
 569         '''
 570         Adds a tenant image to VIM. imge_dict is a dictionary with:
 571             name: name
 572             disk_format: qcow2, vhd, vmdk, raw (by default), ...
 573             location: path or URI
 574             public: "yes" or "no"
 575             metadata: metadata of the image
 576         Returns the image_id
 577         '''
 578         retry=0
 579         max_retries=3
 580         while retry<max_retries:
 581             retry+=1
 582             try:
 583                 self._reload_connection()
 584                 #determine format  http://docs.openstack.org/developer/glance/formats.html
 585                 if "disk_format" in image_dict:
 586                     disk_format=image_dict["disk_format"]
 587                 else: #autodiscover based on extension
 588                     if image_dict['location'][-6:]==".qcow2":
 589                         disk_format="qcow2"
 590                     elif image_dict['location'][-4:]==".vhd":
 591                         disk_format="vhd"
 592                     elif image_dict['location'][-5:]==".vmdk":
 593                         disk_format="vmdk"
 594                     elif image_dict['location'][-4:]==".vdi":
 595                         disk_format="vdi"
 596                     elif image_dict['location'][-4:]==".iso":
 597                         disk_format="iso"
 598                     elif image_dict['location'][-4:]==".aki":
 599                         disk_format="aki"
 600                     elif image_dict['location'][-4:]==".ari":
 601                         disk_format="ari"
 602                     elif image_dict['location'][-4:]==".ami":
 603                         disk_format="ami"
 604                     else:
 605                         disk_format="raw"
 606                 self.logger.debug("new_image: '%s' loading from '%s'", image_dict['name'], image_dict['location'])
 607                 if image_dict['location'][0:4]=="http":
 608                     new_image = self.glancev1.images.create(name=image_dict['name'], is_public=image_dict.get('public',"yes")=="yes",
 609                             container_format="bare", location=image_dict['location'], disk_format=disk_format)
 610                 else: #local path
 611                     with open(image_dict['location']) as fimage:
 612                         new_image = self.glancev1.images.create(name=image_dict['name'], is_public=image_dict.get('public',"yes")=="yes",
 613                             container_format="bare", data=fimage, disk_format=disk_format)
 614                 #insert metadata. We cannot use 'new_image.properties.setdefault'
 615                 #because nova and glance are "INDEPENDENT" and we are using nova for reading metadata
 616                 new_image_nova=self.nova.images.find(id=new_image.id)
 617                 new_image_nova.metadata.setdefault('location',image_dict['location'])
 618                 metadata_to_load = image_dict.get('metadata')
 619                 if metadata_to_load:
 620                     for k,v in yaml.load(metadata_to_load).iteritems():
 621                         new_image_nova.metadata.setdefault(k,v)
 622                 return new_image.id
 623             except (nvExceptions.Conflict, ksExceptions.ClientException, nvExceptions.ClientException) as e:
 624                 self._format_exception(e)
 625             except (HTTPException, gl1Exceptions.HTTPException, gl1Exceptions.CommunicationError, ConnectionError) as e:
 626                 if retry==max_retries:
 627                     continue
 628                 self._format_exception(e)
 629             except IOError as e:  #can not open the file
 630                 raise vimconn.vimconnConnectionException(type(e).__name__ + ": " + str(e)+ " for " + image_dict['location'],
 631                                                          http_code=vimconn.HTTP_Bad_Request)
 632
 633     def delete_image(self, image_id):
 634         '''Deletes a tenant image from openstack VIM. Returns the old id
 635         '''
 636         try:
 637             self._reload_connection()
 638             self.nova.images.delete(image_id)
 639             return image_id
 640         except (nvExceptions.NotFound, ksExceptions.ClientException, nvExceptions.ClientException, gl1Exceptions.CommunicationError, ConnectionError) as e: #TODO remove
 641             self._format_exception(e)
 642
 643     def get_image_id_from_path(self, path):
 644         '''Get the image id from image path in the VIM database. Returns the image_id'''
 645         try:
 646             self._reload_connection()
 647             images = self.nova.images.list()
 648             for image in images:
 649                 if image.metadata.get("location")==path:
 650                     return image.id
 651             raise vimconn.vimconnNotFoundException("image with location '{}' not found".format( path))
 652         except (ksExceptions.ClientException, nvExceptions.ClientException, gl1Exceptions.CommunicationError, ConnectionError) as e:
 653             self._format_exception(e)
 654
 655     def get_image_list(self, filter_dict={}):
 656         '''Obtain tenant images from VIM
 657         Filter_dict can be:
 658             id: image id
 659             name: image name
 660             checksum: image checksum
 661         Returns the image list of dictionaries:
 662             [{<the fields at Filter_dict plus some VIM specific>}, ...]
 663             List can be empty
 664         '''
 665         self.logger.debug("Getting image list from VIM filter: '%s'", str(filter_dict))
 666         try:
 667             self._reload_connection()
 668             filter_dict_os=filter_dict.copy()
 669             #First we filter by the available filter fields: name, id. The others are removed.
 670             filter_dict_os.pop('checksum',None)
 671             image_list=self.nova.images.findall(**filter_dict_os)
 672             if len(image_list)==0:
 673                 return []
 674             #Then we filter by the rest of filter fields: checksum
 675             filtered_list = []
 676             for image in image_list:
 677                 image_class=self.glance.images.get(image.id)
 678                 if 'checksum' not in filter_dict or image_class['checksum']==filter_dict.get('checksum'):
 679                     filtered_list.append(image_class.copy())
 680             return filtered_list
 681         except (ksExceptions.ClientException, nvExceptions.ClientException, gl1Exceptions.CommunicationError, ConnectionError) as e:
 682             self._format_exception(e)
 683
 684     def __wait_for_vm(self, vm_id, status):
 685         """wait until vm is in the desired status and return True.
 686         If the VM gets in ERROR status, return false.
 687         If the timeout is reached generate an exception"""
 688         elapsed_time = 0
 689         while elapsed_time < server_timeout:
 690             vm_status = self.nova.servers.get(vm_id).status
 691             if vm_status == status:
 692                 return True
 693             if vm_status == 'ERROR':
 694                 return False
 695             time.sleep(1)
 696             elapsed_time += 1
 697
 698         # if we exceeded the timeout rollback
 699         if elapsed_time >= server_timeout:
 700             raise vimconn.vimconnException('Timeout waiting for instance ' + vm_id + ' to get ' + status,
 701                                            http_code=vimconn.HTTP_Request_Timeout)
 702
 703     def new_vminstance(self,name,description,start,image_id,flavor_id,net_list,cloud_config=None,disk_list=None):
 704         '''Adds a VM instance to VIM
 705         Params:
 706             start: indicates if VM must start or boot in pause mode. Ignored
 707             image_id,flavor_id: iamge and flavor uuid
 708             net_list: list of interfaces, each one is a dictionary with:
 709                 name:
 710                 net_id: network uuid to connect
 711                 vpci: virtual vcpi to assign, ignored because openstack lack #TODO
 712                 model: interface model, ignored #TODO
 713                 mac_address: used for  SR-IOV ifaces #TODO for other types
 714                 use: 'data', 'bridge',  'mgmt'
 715                 type: 'virtual', 'PF', 'VF', 'VFnotShared'
 716                 vim_id: filled/added by this function
 717                 floating_ip: True/False (or it can be None)
 718                 #TODO ip, security groups
 719         Returns the instance identifier
 720         '''
 721         self.logger.debug("new_vminstance input: image='%s' flavor='%s' nics='%s'",image_id, flavor_id,str(net_list))
 722         try:
 723             server = None
 724             metadata={}
 725             net_list_vim=[]
 726             external_network=[]     # list of external networks to be connected to instance, later on used to create floating_ip
 727             no_secured_ports = []   # List of port-is with port-security disabled
 728             self._reload_connection()
 729             metadata_vpci={}   # For a specific neutron plugin
 730             block_device_mapping = None
 731             for net in net_list:
 732                 if not net.get("net_id"): #skip non connected iface
 733                     continue
 734
 735                 port_dict={
 736                     "network_id": net["net_id"],
 737                     "name": net.get("name"),
 738                     "admin_state_up": True
 739                 }
 740                 if net["type"]=="virtual":
 741                     if "vpci" in net:
 742                         metadata_vpci[ net["net_id"] ] = [[ net["vpci"], "" ]]
 743                 elif net["type"]=="VF": # for VF
 744                     if "vpci" in net:
 745                         if "VF" not in metadata_vpci:
 746                             metadata_vpci["VF"]=[]
 747                         metadata_vpci["VF"].append([ net["vpci"], "" ])
 748                     port_dict["binding:vnic_type"]="direct"
 749                 else:  # For PT
 750                     if "vpci" in net:
 751                         if "PF" not in metadata_vpci:
 752                             metadata_vpci["PF"]=[]
 753                         metadata_vpci["PF"].append([ net["vpci"], "" ])
 754                     port_dict["binding:vnic_type"]="direct-physical"
 755                 if not port_dict["name"]:
 756                     port_dict["name"]=name
 757                 if net.get("mac_address"):
 758                     port_dict["mac_address"]=net["mac_address"]
 759                 new_port = self.neutron.create_port({"port": port_dict })
 760                 net["mac_adress"] = new_port["port"]["mac_address"]
 761                 net["vim_id"] = new_port["port"]["id"]
 762                 # if try to use a network without subnetwork, it will return a emtpy list
 763                 fixed_ips = new_port["port"].get("fixed_ips")
 764                 if fixed_ips:
 765                     net["ip"] = fixed_ips[0].get("ip_address")
 766                 else:
 767                     net["ip"] = None
 768                 net_list_vim.append({"port-id": new_port["port"]["id"], "tag": new_port["port"]["name"]})
 769
 770                 if net.get('floating_ip', False):
 771                     net['exit_on_floating_ip_error'] = True
 772                     external_network.append(net)
 773                 elif net['use'] == 'mgmt' and self.config.get('use_floating_ip'):
 774                     net['exit_on_floating_ip_error'] = False
 775                     external_network.append(net)
 776
 777                 # If port security is disabled when the port has not yet been attached to the VM, then all vm traffic is dropped.
 778                 # As a workaround we wait until the VM is active and then disable the port-security
 779                 if net.get("port_security") == False:
 780                     no_secured_ports.append(new_port["port"]["id"])
 781
 782             if metadata_vpci:
 783                 metadata = {"pci_assignement": json.dumps(metadata_vpci)}
 784                 if len(metadata["pci_assignement"]) >255:
 785                     #limit the metadata size
 786                     #metadata["pci_assignement"] = metadata["pci_assignement"][0:255]
 787                     self.logger.warn("Metadata deleted since it exceeds the expected length (255) ")
 788                     metadata = {}
 789
 790             self.logger.debug("name '%s' image_id '%s'flavor_id '%s' net_list_vim '%s' description '%s' metadata %s",
 791                               name, image_id, flavor_id, str(net_list_vim), description, str(metadata))
 792
 793             security_groups   = self.config.get('security_groups')
 794             if type(security_groups) is str:
 795                 security_groups = ( security_groups, )
 796             #cloud config
 797             userdata=None
 798             config_drive = None
 799             if isinstance(cloud_config, dict):
 800                 if cloud_config.get("user-data"):
 801                     userdata=cloud_config["user-data"]
 802                 if cloud_config.get("boot-data-drive") != None:
 803                     config_drive = cloud_config["boot-data-drive"]
 804                 if cloud_config.get("config-files") or cloud_config.get("users") or cloud_config.get("key-pairs"):
 805                     if userdata:
 806                         raise vimconn.vimconnConflictException("Cloud-config cannot contain both 'userdata' and 'config-files'/'users'/'key-pairs'")
 807                     userdata_dict={}
 808                     #default user
 809                     if cloud_config.get("key-pairs"):
 810                         userdata_dict["ssh-authorized-keys"] = cloud_config["key-pairs"]
 811                         userdata_dict["users"] = [{"default": None, "ssh-authorized-keys": cloud_config["key-pairs"] }]
 812                     if cloud_config.get("users"):
 813                         if "users" not in userdata_dict:
 814                             userdata_dict["users"] = [ "default" ]
 815                         for user in cloud_config["users"]:
 816                             user_info = {
 817                                 "name" : user["name"],
 818                                 "sudo": "ALL = (ALL)NOPASSWD:ALL"
 819                             }
 820                             if "user-info" in user:
 821                                 user_info["gecos"] = user["user-info"]
 822                             if user.get("key-pairs"):
 823                                 user_info["ssh-authorized-keys"] = user["key-pairs"]
 824                             userdata_dict["users"].append(user_info)
 825
 826                     if cloud_config.get("config-files"):
 827                         userdata_dict["write_files"] = []
 828                         for file in cloud_config["config-files"]:
 829                             file_info = {
 830                                 "path" : file["dest"],
 831                                 "content": file["content"]
 832                             }
 833                             if file.get("encoding"):
 834                                 file_info["encoding"] = file["encoding"]
 835                             if file.get("permissions"):
 836                                 file_info["permissions"] = file["permissions"]
 837                             if file.get("owner"):
 838                                 file_info["owner"] = file["owner"]
 839                             userdata_dict["write_files"].append(file_info)
 840                     userdata = "#cloud-config\n"
 841                     userdata += yaml.safe_dump(userdata_dict, indent=4, default_flow_style=False)
 842                 self.logger.debug("userdata: %s", userdata)
 843             elif isinstance(cloud_config, str):
 844                 userdata = cloud_config
 845
 846             #Create additional volumes in case these are present in disk_list
 847             base_disk_index = ord('b')
 848             if disk_list != None:
 849                 block_device_mapping = {}
 850                 for disk in disk_list:
 851                     if 'image_id' in disk:
 852                         volume = self.cinder.volumes.create(size = disk['size'],name = name + '_vd' +
 853                                     chr(base_disk_index), imageRef = disk['image_id'])
 854                     else:
 855                         volume = self.cinder.volumes.create(size=disk['size'], name=name + '_vd' +
 856                                     chr(base_disk_index))
 857                     block_device_mapping['_vd' +  chr(base_disk_index)] = volume.id
 858                     base_disk_index += 1
 859
 860                 #wait until volumes are with status available
 861                 keep_waiting = True
 862                 elapsed_time = 0
 863                 while keep_waiting and elapsed_time < volume_timeout:
 864                     keep_waiting = False
 865                     for volume_id in block_device_mapping.itervalues():
 866                         if self.cinder.volumes.get(volume_id).status != 'available':
 867                             keep_waiting = True
 868                     if keep_waiting:
 869                         time.sleep(1)
 870                         elapsed_time += 1
 871
 872                 #if we exceeded the timeout rollback
 873                 if elapsed_time >= volume_timeout:
 874                     #delete the volumes we just created
 875                     for volume_id in block_device_mapping.itervalues():
 876                         self.cinder.volumes.delete(volume_id)
 877
 878                     #delete ports we just created
 879                     for net_item  in net_list_vim:
 880                         if 'port-id' in net_item:
 881                             self.neutron.delete_port(net_item['port-id'])
 882
 883                     raise vimconn.vimconnException('Timeout creating volumes for instance ' + name,
 884                                                    http_code=vimconn.HTTP_Request_Timeout)
 885
 886             self.logger.debug("nova.servers.create({}, {}, {}, nics={}, meta={}, security_groups={}," \
 887                                               "availability_zone={}, key_name={}, userdata={}, config_drive={}, " \
 888                                               "block_device_mapping={})".format(name, image_id, flavor_id, net_list_vim,
 889                                                 metadata, security_groups, self.config.get('availability_zone'),
 890                                                 self.config.get('keypair'), userdata, config_drive, block_device_mapping))
 891             server = self.nova.servers.create(name, image_id, flavor_id, nics=net_list_vim, meta=metadata,
 892                                               security_groups=security_groups,
 893                                               availability_zone=self.config.get('availability_zone'),
 894                                               key_name=self.config.get('keypair'),
 895                                               userdata=userdata,
 896                                               config_drive=config_drive,
 897                                               block_device_mapping=block_device_mapping
 898                                               )  # , description=description)
 899
 900             # Previously mentioned workaround to wait until the VM is active and then disable the port-security
 901             if no_secured_ports:
 902                 self.__wait_for_vm(server.id, 'ACTIVE')
 903
 904             for port_id in no_secured_ports:
 905                 try:
 906                     self.neutron.update_port(port_id, {"port": {"port_security_enabled": False, "security_groups": None} })
 907
 908                 except Exception as e:
 909                     self.logger.error("It was not possible to disable port security for port {}".format(port_id))
 910                     self.delete_vminstance(server.id)
 911                     raise
 912
 913             #print "DONE :-)", server
 914             pool_id = None
 915             floating_ips = self.neutron.list_floatingips().get("floatingips", ())
 916
 917             if external_network:
 918                 self.__wait_for_vm(server.id, 'ACTIVE')
 919
 920             for floating_network in external_network:
 921                 try:
 922                     assigned = False
 923                     while(assigned == False):
 924                         if floating_ips:
 925                             ip = floating_ips.pop(0)
 926                             if not ip.get("port_id", False) and ip.get('tenant_id') == server.tenant_id:
 927                                 free_floating_ip = ip.get("floating_ip_address")
 928                                 try:
 929                                     fix_ip = floating_network.get('ip')
 930                                     server.add_floating_ip(free_floating_ip, fix_ip)
 931                                     assigned = True
 932                                 except Exception as e:
 933                                     raise vimconn.vimconnException(type(e).__name__ + ": Cannot create floating_ip "+  str(e), http_code=vimconn.HTTP_Conflict)
 934                         else:
 935                             #Find the external network
 936                             external_nets = list()
 937                             for net in self.neutron.list_networks()['networks']:
 938                                 if net['router:external']:
 939                                         external_nets.append(net)
 940
 941                             if len(external_nets) == 0:
 942                                 raise vimconn.vimconnException("Cannot create floating_ip automatically since no external "
 943                                                                "network is present",
 944                                                                 http_code=vimconn.HTTP_Conflict)
 945                             if len(external_nets) > 1:
 946                                 raise vimconn.vimconnException("Cannot create floating_ip automatically since multiple "
 947                                                                "external networks are present",
 948                                                                http_code=vimconn.HTTP_Conflict)
 949
 950                             pool_id = external_nets[0].get('id')
 951                             param = {'floatingip': {'floating_network_id': pool_id, 'tenant_id': server.tenant_id}}
 952                             try:
 953                                 #self.logger.debug("Creating floating IP")
 954                                 new_floating_ip = self.neutron.create_floatingip(param)
 955                                 free_floating_ip = new_floating_ip['floatingip']['floating_ip_address']
 956                                 fix_ip = floating_network.get('ip')
 957                                 server.add_floating_ip(free_floating_ip, fix_ip)
 958                                 assigned=True
 959                             except Exception as e:
 960                                 raise vimconn.vimconnException(type(e).__name__ + ": Cannot assign floating_ip "+  str(e), http_code=vimconn.HTTP_Conflict)
 961                 except Exception as e:
 962                     if not floating_network['exit_on_floating_ip_error']:
 963                         self.logger.warn("Cannot create floating_ip. %s", str(e))
 964                         continue
 965                     raise
 966
 967             return server.id
 968 #        except nvExceptions.NotFound as e:
 969 #            error_value=-vimconn.HTTP_Not_Found
 970 #            error_text= "vm instance %s not found" % vm_id
 971 #        except TypeError as e:
 972 #            raise vimconn.vimconnException(type(e).__name__ + ": "+  str(e), http_code=vimconn.HTTP_Bad_Request)
 973
 974         except Exception as e:
 975             # delete the volumes we just created
 976             if block_device_mapping:
 977                 for volume_id in block_device_mapping.itervalues():
 978                     self.cinder.volumes.delete(volume_id)
 979
 980             # Delete the VM
 981             if server != None:
 982                 self.delete_vminstance(server.id)
 983             else:
 984                 # delete ports we just created
 985                 for net_item in net_list_vim:
 986                     if 'port-id' in net_item:
 987                         self.neutron.delete_port(net_item['port-id'])
 988
 989             self._format_exception(e)
 990
 991     def get_vminstance(self,vm_id):
 992         '''Returns the VM instance information from VIM'''
 993         #self.logger.debug("Getting VM from VIM")
 994         try:
 995             self._reload_connection()
 996             server = self.nova.servers.find(id=vm_id)
 997             #TODO parse input and translate to VIM format (openmano_schemas.new_vminstance_response_schema)
 998             return server.to_dict()
 999         except (ksExceptions.ClientException, nvExceptions.ClientException, nvExceptions.NotFound, ConnectionError) as e:
1000             self._format_exception(e)
1001
1002     def get_vminstance_console(self,vm_id, console_type="vnc"):
1003         '''
1004         Get a console for the virtual machine
1005         Params:
1006             vm_id: uuid of the VM
1007             console_type, can be:
1008                 "novnc" (by default), "xvpvnc" for VNC types,
1009                 "rdp-html5" for RDP types, "spice-html5" for SPICE types
1010         Returns dict with the console parameters:
1011                 protocol: ssh, ftp, http, https, ...
1012                 server:   usually ip address
1013                 port:     the http, ssh, ... port
1014                 suffix:   extra text, e.g. the http path and query string
1015         '''
1016         self.logger.debug("Getting VM CONSOLE from VIM")
1017         try:
1018             self._reload_connection()
1019             server = self.nova.servers.find(id=vm_id)
1020             if console_type == None or console_type == "novnc":
1021                 console_dict = server.get_vnc_console("novnc")
1022             elif console_type == "xvpvnc":
1023                 console_dict = server.get_vnc_console(console_type)
1024             elif console_type == "rdp-html5":
1025                 console_dict = server.get_rdp_console(console_type)
1026             elif console_type == "spice-html5":
1027                 console_dict = server.get_spice_console(console_type)
1028             else:
1029                 raise vimconn.vimconnException("console type '{}' not allowed".format(console_type), http_code=vimconn.HTTP_Bad_Request)
1030
1031             console_dict1 = console_dict.get("console")
1032             if console_dict1:
1033                 console_url = console_dict1.get("url")
1034                 if console_url:
1035                     #parse console_url
1036                     protocol_index = console_url.find("//")
1037                     suffix_index = console_url[protocol_index+2:].find("/") + protocol_index+2
1038                     port_index = console_url[protocol_index+2:suffix_index].find(":") + protocol_index+2
1039                     if protocol_index < 0 or port_index<0 or suffix_index<0:
1040                         return -vimconn.HTTP_Internal_Server_Error, "Unexpected response from VIM"
1041                     console_dict={"protocol": console_url[0:protocol_index],
1042                                   "server":   console_url[protocol_index+2:port_index],
1043                                   "port":     console_url[port_index:suffix_index],
1044                                   "suffix":   console_url[suffix_index+1:]
1045                                   }
1046                     protocol_index += 2
1047                     return console_dict
1048             raise vimconn.vimconnUnexpectedResponse("Unexpected response from VIM")
1049
1050         except (nvExceptions.NotFound, ksExceptions.ClientException, nvExceptions.ClientException, nvExceptions.BadRequest, ConnectionError) as e:
1051             self._format_exception(e)
1052
1053     def delete_vminstance(self, vm_id):
1054         '''Removes a VM instance from VIM. Returns the old identifier
1055         '''
1056         #print "osconnector: Getting VM from VIM"
1057         try:
1058             self._reload_connection()
1059             #delete VM ports attached to this networks before the virtual machine
1060             ports = self.neutron.list_ports(device_id=vm_id)
1061             for p in ports['ports']:
1062                 try:
1063                     self.neutron.delete_port(p["id"])
1064                 except Exception as e:
1065                     self.logger.error("Error deleting port: " + type(e).__name__ + ": "+  str(e))
1066
1067             #commented because detaching the volumes makes the servers.delete not work properly ?!?
1068             #dettach volumes attached
1069             server = self.nova.servers.get(vm_id)
1070             volumes_attached_dict = server._info['os-extended-volumes:volumes_attached']
1071             #for volume in volumes_attached_dict:
1072             #    self.cinder.volumes.detach(volume['id'])
1073
1074             self.nova.servers.delete(vm_id)
1075
1076             #delete volumes.
1077             #Although having detached them should have them  in active status
1078             #we ensure in this loop
1079             keep_waiting = True
1080             elapsed_time = 0
1081             while keep_waiting and elapsed_time < volume_timeout:
1082                 keep_waiting = False
1083                 for volume in volumes_attached_dict:
1084                     if self.cinder.volumes.get(volume['id']).status != 'available':
1085                         keep_waiting = True
1086                     else:
1087                         self.cinder.volumes.delete(volume['id'])
1088                 if keep_waiting:
1089                     time.sleep(1)
1090                     elapsed_time += 1
1091
1092             return vm_id
1093         except (nvExceptions.NotFound, ksExceptions.ClientException, nvExceptions.ClientException, ConnectionError) as e:
1094             self._format_exception(e)
1095         #TODO insert exception vimconn.HTTP_Unauthorized
1096         #if reaching here is because an exception
1097
1098     def refresh_vms_status(self, vm_list):
1099         '''Get the status of the virtual machines and their interfaces/ports
1100            Params: the list of VM identifiers
1101            Returns a dictionary with:
1102                 vm_id:          #VIM id of this Virtual Machine
1103                     status:     #Mandatory. Text with one of:
1104                                 #  DELETED (not found at vim)
1105                                 #  VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
1106                                 #  OTHER (Vim reported other status not understood)
1107                                 #  ERROR (VIM indicates an ERROR status)
1108                                 #  ACTIVE, PAUSED, SUSPENDED, INACTIVE (not running),
1109                                 #  CREATING (on building process), ERROR
1110                                 #  ACTIVE:NoMgmtIP (Active but any of its interface has an IP address
1111                                 #
1112                     error_msg:  #Text with VIM error message, if any. Or the VIM connection ERROR
1113                     vim_info:   #Text with plain information obtained from vim (yaml.safe_dump)
1114                     interfaces:
1115                      -  vim_info:         #Text with plain information obtained from vim (yaml.safe_dump)
1116                         mac_address:      #Text format XX:XX:XX:XX:XX:XX
1117                         vim_net_id:       #network id where this interface is connected
1118                         vim_interface_id: #interface/port VIM id
1119                         ip_address:       #null, or text with IPv4, IPv6 address
1120                         compute_node:     #identification of compute node where PF,VF interface is allocated
1121                         pci:              #PCI address of the NIC that hosts the PF,VF
1122                         vlan:             #physical VLAN used for VF
1123         '''
1124         vm_dict={}
1125         self.logger.debug("refresh_vms status: Getting tenant VM instance information from VIM")
1126         for vm_id in vm_list:
1127             vm={}
1128             try:
1129                 vm_vim = self.get_vminstance(vm_id)
1130                 if vm_vim['status'] in vmStatus2manoFormat:
1131                     vm['status']    =  vmStatus2manoFormat[ vm_vim['status'] ]
1132                 else:
1133                     vm['status']    = "OTHER"
1134                     vm['error_msg'] = "VIM status reported " + vm_vim['status']
1135                 try:
1136                     vm['vim_info']  = yaml.safe_dump(vm_vim, default_flow_style=True, width=256)
1137                 except yaml.representer.RepresenterError:
1138                     vm['vim_info'] = str(vm_vim)
1139                 vm["interfaces"] = []
1140                 if vm_vim.get('fault'):
1141                     vm['error_msg'] = str(vm_vim['fault'])
1142                 #get interfaces
1143                 try:
1144                     self._reload_connection()
1145                     port_dict=self.neutron.list_ports(device_id=vm_id)
1146                     for port in port_dict["ports"]:
1147                         interface={}
1148                         try:
1149                             interface['vim_info'] = yaml.safe_dump(port, default_flow_style=True, width=256)
1150                         except yaml.representer.RepresenterError:
1151                             interface['vim_info'] = str(port)
1152                         interface["mac_address"] = port.get("mac_address")
1153                         interface["vim_net_id"] = port["network_id"]
1154                         interface["vim_interface_id"] = port["id"]
1155                         # check if OS-EXT-SRV-ATTR:host is there,
1156                         # in case of non-admin credentials, it will be missing
1157                         if vm_vim.get('OS-EXT-SRV-ATTR:host'):
1158                             interface["compute_node"] = vm_vim['OS-EXT-SRV-ATTR:host']
1159                         interface["pci"] = None
1160
1161                         # check if binding:profile is there,
1162                         # in case of non-admin credentials, it will be missing
1163                         if port.get('binding:profile'):
1164                             if port['binding:profile'].get('pci_slot'):
1165                                 # TODO: At the moment sr-iov pci addresses are converted to PF pci addresses by setting the slot to 0x00
1166                                 # TODO: This is just a workaround valid for niantinc. Find a better way to do so
1167                                 #   CHANGE DDDD:BB:SS.F to DDDD:BB:00.(F%2)   assuming there are 2 ports per nic
1168                                 pci = port['binding:profile']['pci_slot']
1169                                 # interface["pci"] = pci[:-4] + "00." + str(int(pci[-1]) % 2)
1170                                 interface["pci"] = pci
1171                         interface["vlan"] = None
1172                         #if network is of type vlan and port is of type direct (sr-iov) then set vlan id
1173                         network = self.neutron.show_network(port["network_id"])
1174                         if network['network'].get('provider:network_type') == 'vlan' and \
1175                             port.get("binding:vnic_type") == "direct":
1176                             interface["vlan"] = network['network'].get('provider:segmentation_id')
1177                         ips=[]
1178                         #look for floating ip address
1179                         floating_ip_dict = self.neutron.list_floatingips(port_id=port["id"])
1180                         if floating_ip_dict.get("floatingips"):
1181                             ips.append(floating_ip_dict["floatingips"][0].get("floating_ip_address") )
1182
1183                         for subnet in port["fixed_ips"]:
1184                             ips.append(subnet["ip_address"])
1185                         interface["ip_address"] = ";".join(ips)
1186                         vm["interfaces"].append(interface)
1187                 except Exception as e:
1188                     self.logger.error("Error getting vm interface information " + type(e).__name__ + ": "+  str(e))
1189             except vimconn.vimconnNotFoundException as e:
1190                 self.logger.error("Exception getting vm status: %s", str(e))
1191                 vm['status'] = "DELETED"
1192                 vm['error_msg'] = str(e)
1193             except vimconn.vimconnException as e:
1194                 self.logger.error("Exception getting vm status: %s", str(e))
1195                 vm['status'] = "VIM_ERROR"
1196                 vm['error_msg'] = str(e)
1197             vm_dict[vm_id] = vm
1198         return vm_dict
1199
1200     def action_vminstance(self, vm_id, action_dict):
1201         '''Send and action over a VM instance from VIM
1202         Returns the vm_id if the action was successfully sent to the VIM'''
1203         self.logger.debug("Action over VM '%s': %s", vm_id, str(action_dict))
1204         try:
1205             self._reload_connection()
1206             server = self.nova.servers.find(id=vm_id)
1207             if "start" in action_dict:
1208                 if action_dict["start"]=="rebuild":
1209                     server.rebuild()
1210                 else:
1211                     if server.status=="PAUSED":
1212                         server.unpause()
1213                     elif server.status=="SUSPENDED":
1214                         server.resume()
1215                     elif server.status=="SHUTOFF":
1216                         server.start()
1217             elif "pause" in action_dict:
1218                 server.pause()
1219             elif "resume" in action_dict:
1220                 server.resume()
1221             elif "shutoff" in action_dict or "shutdown" in action_dict:
1222                 server.stop()
1223             elif "forceOff" in action_dict:
1224                 server.stop() #TODO
1225             elif "terminate" in action_dict:
1226                 server.delete()
1227             elif "createImage" in action_dict:
1228                 server.create_image()
1229                 #"path":path_schema,
1230                 #"description":description_schema,
1231                 #"name":name_schema,
1232                 #"metadata":metadata_schema,
1233                 #"imageRef": id_schema,
1234                 #"disk": {"oneOf":[{"type": "null"}, {"type":"string"}] },
1235             elif "rebuild" in action_dict:
1236                 server.rebuild(server.image['id'])
1237             elif "reboot" in action_dict:
1238                 server.reboot() #reboot_type='SOFT'
1239             elif "console" in action_dict:
1240                 console_type = action_dict["console"]
1241                 if console_type == None or console_type == "novnc":
1242                     console_dict = server.get_vnc_console("novnc")
1243                 elif console_type == "xvpvnc":
1244                     console_dict = server.get_vnc_console(console_type)
1245                 elif console_type == "rdp-html5":
1246                     console_dict = server.get_rdp_console(console_type)
1247                 elif console_type == "spice-html5":
1248                     console_dict = server.get_spice_console(console_type)
1249                 else:
1250                     raise vimconn.vimconnException("console type '{}' not allowed".format(console_type),
1251                                                    http_code=vimconn.HTTP_Bad_Request)
1252                 try:
1253                     console_url = console_dict["console"]["url"]
1254                     #parse console_url
1255                     protocol_index = console_url.find("//")
1256                     suffix_index = console_url[protocol_index+2:].find("/") + protocol_index+2
1257                     port_index = console_url[protocol_index+2:suffix_index].find(":") + protocol_index+2
1258                     if protocol_index < 0 or port_index<0 or suffix_index<0:
1259                         raise vimconn.vimconnException("Unexpected response from VIM " + str(console_dict))
1260                     console_dict2={"protocol": console_url[0:protocol_index],
1261                                   "server":   console_url[protocol_index+2 : port_index],
1262                                   "port":     int(console_url[port_index+1 : suffix_index]),
1263                                   "suffix":   console_url[suffix_index+1:]
1264                                   }
1265                     return console_dict2
1266                 except Exception as e:
1267                     raise vimconn.vimconnException("Unexpected response from VIM " + str(console_dict))
1268
1269             return vm_id
1270         except (ksExceptions.ClientException, nvExceptions.ClientException, nvExceptions.NotFound, ConnectionError) as e:
1271             self._format_exception(e)
1272         #TODO insert exception vimconn.HTTP_Unauthorized
1273
1274 #NOT USED FUNCTIONS
1275
1276     def new_external_port(self, port_data):
1277         #TODO openstack if needed
1278         '''Adds a external port to VIM'''
1279         '''Returns the port identifier'''
1280         return -vimconn.HTTP_Internal_Server_Error, "osconnector.new_external_port() not implemented"
1281
1282     def connect_port_network(self, port_id, network_id, admin=False):
1283         #TODO openstack if needed
1284         '''Connects a external port to a network'''
1285         '''Returns status code of the VIM response'''
1286         return -vimconn.HTTP_Internal_Server_Error, "osconnector.connect_port_network() not implemented"
1287
1288     def new_user(self, user_name, user_passwd, tenant_id=None):
1289         '''Adds a new user to openstack VIM'''
1290         '''Returns the user identifier'''
1291         self.logger.debug("osconnector: Adding a new user to VIM")
1292         try:
1293             self._reload_connection()
1294             user=self.keystone.users.create(user_name, user_passwd, tenant_id=tenant_id)
1295             #self.keystone.tenants.add_user(self.k_creds["username"], #role)
1296             return user.id
1297         except ksExceptions.ConnectionError as e:
1298             error_value=-vimconn.HTTP_Bad_Request
1299             error_text= type(e).__name__ + ": "+  (str(e) if len(e.args)==0 else str(e.args[0]))
1300         except ksExceptions.ClientException as e: #TODO remove
1301             error_value=-vimconn.HTTP_Bad_Request
1302             error_text= type(e).__name__ + ": "+  (str(e) if len(e.args)==0 else str(e.args[0]))
1303         #TODO insert exception vimconn.HTTP_Unauthorized
1304         #if reaching here is because an exception
1305         if self.debug:
1306             self.logger.debug("new_user " + error_text)
1307         return error_value, error_text
1308
1309     def delete_user(self, user_id):
1310         '''Delete a user from openstack VIM'''
1311         '''Returns the user identifier'''
1312         if self.debug:
1313             print "osconnector: Deleting  a  user from VIM"
1314         try:
1315             self._reload_connection()
1316             self.keystone.users.delete(user_id)
1317             return 1, user_id
1318         except ksExceptions.ConnectionError as e:
1319             error_value=-vimconn.HTTP_Bad_Request
1320             error_text= type(e).__name__ + ": "+  (str(e) if len(e.args)==0 else str(e.args[0]))
1321         except ksExceptions.NotFound as e:
1322             error_value=-vimconn.HTTP_Not_Found
1323             error_text= type(e).__name__ + ": "+  (str(e) if len(e.args)==0 else str(e.args[0]))
1324         except ksExceptions.ClientException as e: #TODO remove
1325             error_value=-vimconn.HTTP_Bad_Request
1326             error_text= type(e).__name__ + ": "+  (str(e) if len(e.args)==0 else str(e.args[0]))
1327         #TODO insert exception vimconn.HTTP_Unauthorized
1328         #if reaching here is because an exception
1329         if self.debug:
1330             print "delete_tenant " + error_text
1331         return error_value, error_text
1332
1333     def get_hosts_info(self):
1334         '''Get the information of deployed hosts
1335         Returns the hosts content'''
1336         if self.debug:
1337             print "osconnector: Getting Host info from VIM"
1338         try:
1339             h_list=[]
1340             self._reload_connection()
1341             hypervisors = self.nova.hypervisors.list()
1342             for hype in hypervisors:
1343                 h_list.append( hype.to_dict() )
1344             return 1, {"hosts":h_list}
1345         except nvExceptions.NotFound as e:
1346             error_value=-vimconn.HTTP_Not_Found
1347             error_text= (str(e) if len(e.args)==0 else str(e.args[0]))
1348         except (ksExceptions.ClientException, nvExceptions.ClientException) as e:
1349             error_value=-vimconn.HTTP_Bad_Request
1350             error_text= type(e).__name__ + ": "+  (str(e) if len(e.args)==0 else str(e.args[0]))
1351         #TODO insert exception vimconn.HTTP_Unauthorized
1352         #if reaching here is because an exception
1353         if self.debug:
1354             print "get_hosts_info " + error_text
1355         return error_value, error_text
1356
1357     def get_hosts(self, vim_tenant):
1358         '''Get the hosts and deployed instances
1359         Returns the hosts content'''
1360         r, hype_dict = self.get_hosts_info()
1361         if r<0:
1362             return r, hype_dict
1363         hypervisors = hype_dict["hosts"]
1364         try:
1365             servers = self.nova.servers.list()
1366             for hype in hypervisors:
1367                 for server in servers:
1368                     if server.to_dict()['OS-EXT-SRV-ATTR:hypervisor_hostname']==hype['hypervisor_hostname']:
1369                         if 'vm' in hype:
1370                             hype['vm'].append(server.id)
1371                         else:
1372                             hype['vm'] = [server.id]
1373             return 1, hype_dict
1374         except nvExceptions.NotFound as e:
1375             error_value=-vimconn.HTTP_Not_Found
1376             error_text= (str(e) if len(e.args)==0 else str(e.args[0]))
1377         except (ksExceptions.ClientException, nvExceptions.ClientException) as e:
1378             error_value=-vimconn.HTTP_Bad_Request
1379             error_text= type(e).__name__ + ": "+  (str(e) if len(e.args)==0 else str(e.args[0]))
1380         #TODO insert exception vimconn.HTTP_Unauthorized
1381         #if reaching here is because an exception
1382         if self.debug:
1383             print "get_hosts " + error_text
1384         return error_value, error_text
1385
1386