RO-VIM-aws/osm_rovim_aws/vimconn_aws.py

   1 # -*- coding: utf-8 -*-
   2
   3 ##
   4 # Copyright 2017 xFlow Research Pvt. Ltd
   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: saboor.ahmad@xflowresearch.com
  22 ##
  23
  24 '''
  25 AWS-connector implements all the methods to interact with AWS using the BOTO client
  26 '''
  27
  28 __author__ = "Saboor Ahmad"
  29 __date__ = "10-Apr-2017"
  30
  31 from osm_ro import vimconn
  32 import yaml
  33 import logging
  34 import netaddr
  35 import time
  36
  37 import boto
  38 import boto.ec2
  39 import boto.vpc
  40
  41
  42 class vimconnector(vimconn.vimconnector):
  43     def __init__(self, uuid, name, tenant_id, tenant_name, url, url_admin=None, user=None, passwd=None, log_level=None,
  44                  config={}, persistent_info={}):
  45         """ Params: uuid - id asigned to this VIM
  46                 name - name assigned to this VIM, can be used for logging
  47                 tenant_id - ID to be used for tenant
  48                 tenant_name - name of tenant to be used VIM tenant to be used
  49                 url_admin - optional, url used for administrative tasks
  50                 user - credentials of the VIM user
  51                 passwd - credentials of the VIM user
  52                 log_level - if must use a different log_level than the general one
  53                 config - dictionary with misc VIM information
  54                     region_name - name of region to deploy the instances
  55                     vpc_cidr_block - default CIDR block for VPC
  56                     security_groups - default security group to specify this instance
  57                 persistent_info - dict where the class can store information that will be available among class
  58                     destroy/creation cycles. This info is unique per VIM/credential. At first call it will contain an
  59                     empty dict. Useful to store login/tokens information for speed up communication
  60         """
  61
  62         vimconn.vimconnector.__init__(self, uuid, name, tenant_id, tenant_name, url, url_admin, user, passwd, log_level,
  63                                       config, persistent_info)
  64
  65         self.persistent_info = persistent_info
  66         self.a_creds = {}
  67         if user:
  68             self.a_creds['aws_access_key_id'] = user
  69         else:
  70             raise vimconn.vimconnAuthException("Username is not specified")
  71         if passwd:
  72             self.a_creds['aws_secret_access_key'] = passwd
  73         else:
  74             raise vimconn.vimconnAuthException("Password is not specified")
  75         if 'region_name' in config:
  76             self.region = config.get('region_name')
  77         else:
  78             raise vimconn.vimconnException("AWS region_name is not specified at config")
  79
  80         self.vpc_data = {}
  81         self.subnet_data = {}
  82         self.conn = None
  83         self.conn_vpc = None
  84         self.account_id = None
  85
  86         self.vpc_id = self.get_tenant_list()[0]['id']
  87         # we take VPC CIDR block if specified, otherwise we use the default CIDR
  88         # block suggested by AWS while creating instance
  89         self.vpc_cidr_block = '10.0.0.0/24'
  90
  91         if tenant_id:
  92             self.vpc_id = tenant_id
  93         if 'vpc_cidr_block' in config:
  94             self.vpc_cidr_block = config['vpc_cidr_block']
  95
  96         self.security_groups = None
  97         if 'security_groups' in config:
  98             self.security_groups = config['security_groups']
  99
 100         self.key_pair = None
 101         if 'key_pair' in config:
 102             self.key_pair = config['key_pair']
 103
 104         self.flavor_info = None
 105         if 'flavor_info' in config:
 106             flavor_data = config.get('flavor_info')
 107             if isinstance(flavor_data, str):
 108                 try:
 109                     if flavor_data[0] == "@":  # read from a file
 110                         with open(flavor_data[1:], 'r') as stream:
 111                             self.flavor_info = yaml.load(stream, Loader=yaml.Loader)
 112                     else:
 113                         self.flavor_info = yaml.load(flavor_data, Loader=yaml.Loader)
 114                 except yaml.YAMLError as e:
 115                     self.flavor_info = None
 116                     raise vimconn.vimconnException("Bad format at file '{}': {}".format(flavor_data[1:], e))
 117                 except IOError as e:
 118                     raise vimconn.vimconnException("Error reading file '{}': {}".format(flavor_data[1:], e))
 119             elif isinstance(flavor_data, dict):
 120                 self.flavor_info = flavor_data
 121
 122         self.logger = logging.getLogger('openmano.vim.aws')
 123         if log_level:
 124             self.logger.setLevel(getattr(logging, log_level))
 125
 126     def __setitem__(self, index, value):
 127         """Params: index - name of value of set
 128                    value - value to set
 129         """
 130         if index == 'user':
 131             self.a_creds['aws_access_key_id'] = value
 132         elif index == 'passwd':
 133             self.a_creds['aws_secret_access_key'] = value
 134         elif index == 'region':
 135             self.region = value
 136         else:
 137             vimconn.vimconnector.__setitem__(self, index, value)
 138
 139     def _reload_connection(self):
 140         """Returns: sets boto.EC2 and boto.VPC connection to work with AWS services
 141         """
 142
 143         try:
 144             self.conn = boto.ec2.connect_to_region(self.region, aws_access_key_id=self.a_creds['aws_access_key_id'],
 145                                                    aws_secret_access_key=self.a_creds['aws_secret_access_key'])
 146             self.conn_vpc = boto.vpc.connect_to_region(self.region, aws_access_key_id=self.a_creds['aws_access_key_id'],
 147                                                        aws_secret_access_key=self.a_creds['aws_secret_access_key'])
 148             # client = boto3.client("sts", aws_access_key_id=self.a_creds['aws_access_key_id'], aws_secret_access_key=self.a_creds['aws_secret_access_key'])
 149             # self.account_id = client.get_caller_identity()["Account"]
 150         except Exception as e:
 151             self.format_vimconn_exception(e)
 152
 153     def format_vimconn_exception(self, e):
 154         """Params: an Exception object
 155         Returns: Raises the exception 'e' passed in mehtod parameters
 156         """
 157
 158         self.conn = None
 159         self.conn_vpc = None
 160         raise vimconn.vimconnConnectionException(type(e).__name__ + ": " + str(e))
 161
 162     def get_availability_zones_list(self):
 163         """Obtain AvailabilityZones from AWS
 164         """
 165
 166         try:
 167             self._reload_connection()
 168             az_list = []
 169             for az in self.conn.get_all_zones():
 170                 az_list.append(az.name)
 171             return az_list
 172         except Exception as e:
 173             self.format_vimconn_exception(e)
 174
 175     def get_tenant_list(self, filter_dict={}):
 176         """Obtain tenants of VIM
 177         filter_dict dictionary that can contain the following keys:
 178             name: filter by tenant name
 179             id: filter by tenant uuid/id
 180             <other VIM specific>
 181         Returns the tenant list of dictionaries, and empty list if no tenant match all the filers:
 182             [{'name':'<name>, 'id':'<id>, ...}, ...]
 183         """
 184
 185         try:
 186             self._reload_connection()
 187             vpc_ids = []
 188             tfilters = {}
 189             if filter_dict != {}:
 190                 if 'id' in filter_dict:
 191                     vpc_ids.append(filter_dict['id'])
 192                     tfilters['name'] = filter_dict['id']
 193             tenants = self.conn_vpc.get_all_vpcs(vpc_ids, tfilters)
 194             tenant_list = []
 195             for tenant in tenants:
 196                 tenant_list.append({'id': str(tenant.id), 'name': str(tenant.id), 'status': str(tenant.state),
 197                                     'cidr_block': str(tenant.cidr_block)})
 198             return tenant_list
 199         except Exception as e:
 200             self.format_vimconn_exception(e)
 201
 202     def new_tenant(self, tenant_name, tenant_description):
 203         """Adds a new tenant to VIM with this name and description, this is done using admin_url if provided
 204         "tenant_name": string max lenght 64
 205         "tenant_description": string max length 256
 206         returns the tenant identifier or raise exception
 207         """
 208
 209         self.logger.debug("Adding a new VPC")
 210         try:
 211             self._reload_connection()
 212             vpc = self.conn_vpc.create_vpc(self.vpc_cidr_block)
 213             self.conn_vpc.modify_vpc_attribute(vpc.id, enable_dns_support=True)
 214             self.conn_vpc.modify_vpc_attribute(vpc.id, enable_dns_hostnames=True)
 215
 216             gateway = self.conn_vpc.create_internet_gateway()
 217             self.conn_vpc.attach_internet_gateway(gateway.id, vpc.id)
 218             route_table = self.conn_vpc.create_route_table(vpc.id)
 219             self.conn_vpc.create_route(route_table.id, '0.0.0.0/0', gateway.id)
 220
 221             self.vpc_data[vpc.id] = {'gateway': gateway.id, 'route_table': route_table.id,
 222                                      'subnets': self.subnet_sizes(len(self.get_availability_zones_list()),
 223                                                                   self.vpc_cidr_block)}
 224             return vpc.id
 225         except Exception as e:
 226             self.format_vimconn_exception(e)
 227
 228     def delete_tenant(self, tenant_id):
 229         """Delete a tenant from VIM
 230         tenant_id: returned VIM tenant_id on "new_tenant"
 231         Returns None on success. Raises and exception of failure. If tenant is not found raises vimconnNotFoundException
 232         """
 233
 234         self.logger.debug("Deleting specified VPC")
 235         try:
 236             self._reload_connection()
 237             vpc = self.vpc_data.get(tenant_id)
 238             if 'gateway' in vpc and 'route_table' in vpc:
 239                 gateway_id, route_table_id = vpc['gateway'], vpc['route_table']
 240                 self.conn_vpc.detach_internet_gateway(gateway_id, tenant_id)
 241                 self.conn_vpc.delete_vpc(tenant_id)
 242                 self.conn_vpc.delete_route(route_table_id, '0.0.0.0/0')
 243             else:
 244                 self.conn_vpc.delete_vpc(tenant_id)
 245         except Exception as e:
 246             self.format_vimconn_exception(e)
 247
 248     def subnet_sizes(self, availability_zones, cidr):
 249         """Calcualtes possible subnets given CIDR value of VPC
 250         """
 251
 252         if availability_zones != 2 and availability_zones != 3:
 253             self.logger.debug("Number of AZs should be 2 or 3")
 254             raise vimconn.vimconnNotSupportedException("Number of AZs should be 2 or 3")
 255
 256         netmasks = ('255.255.252.0', '255.255.254.0', '255.255.255.0', '255.255.255.128')
 257         ip = netaddr.IPNetwork(cidr)
 258         mask = ip.netmask
 259
 260         if str(mask) not in netmasks:
 261             self.logger.debug("Netmask " + str(mask) + " not found")
 262             raise vimconn.vimconnNotFoundException("Netmask " + str(mask) + " not found")
 263
 264         if availability_zones == 2:
 265             for n, netmask in enumerate(netmasks):
 266                 if str(mask) == netmask:
 267                     subnets = list(ip.subnet(n + 24))
 268         else:
 269             for n, netmask in enumerate(netmasks):
 270                 if str(mask) == netmask:
 271                     pub_net = list(ip.subnet(n + 24))
 272                     pri_subs = pub_net[1:]
 273                     pub_mask = pub_net[0].netmask
 274             pub_split = list(ip.subnet(26)) if (str(pub_mask) == '255.255.255.0') else list(ip.subnet(27))
 275             pub_subs = pub_split[:3]
 276             subnets = pub_subs + pri_subs
 277
 278         return map(str, subnets)
 279
 280     def new_network(self, net_name, net_type, ip_profile=None, shared=False, vlan=None):
 281         """Adds a tenant network to VIM
 282         Params:
 283             'net_name': name of the network
 284             'net_type': one of:
 285                 'bridge': overlay isolated network
 286                 'data':   underlay E-LAN network for Passthrough and SRIOV interfaces
 287                 'ptp':    underlay E-LINE network for Passthrough and SRIOV interfaces.
 288             'ip_profile': is a dict containing the IP parameters of the network (Currently only IPv4 is implemented)
 289                 'ip-version': can be one of ["IPv4","IPv6"]
 290                 'subnet-address': ip_prefix_schema, that is X.X.X.X/Y
 291                 'gateway-address': (Optional) ip_schema, that is X.X.X.X
 292                 'dns-address': (Optional) ip_schema,
 293                 'dhcp': (Optional) dict containing
 294                     'enabled': {"type": "boolean"},
 295                     'start-address': ip_schema, first IP to grant
 296                     'count': number of IPs to grant.
 297             'shared': if this network can be seen/use by other tenants/organization
 298             'vlan': in case of a data or ptp net_type, the intended vlan tag to be used for the network
 299         Returns a tuple with the network identifier and created_items, or raises an exception on error
 300             created_items can be None or a dictionary where this method can include key-values that will be passed to
 301             the method delete_network. Can be used to store created segments, created l2gw connections, etc.
 302             Format is vimconnector dependent, but do not use nested dictionaries and a value of None should be the same
 303             as not present.
 304         """
 305
 306         self.logger.debug("Adding a subnet to VPC")
 307         try:
 308             created_items = {}
 309             self._reload_connection()
 310             subnet = None
 311             vpc_id = self.vpc_id
 312             if self.vpc_data.get(vpc_id, None):
 313                 cidr_block = list(set(self.vpc_data[vpc_id]['subnets']) - set(self.get_network_details({'tenant_id': vpc_id}, detail='cidr_block')))[0]
 314             else:
 315                 vpc = self.get_tenant_list({'id': vpc_id})[0]
 316                 subnet_list = self.subnet_sizes(len(self.get_availability_zones_list()), vpc['cidr_block'])
 317                 cidr_block = list(set(subnet_list) - set(self.get_network_details({'tenant_id': vpc['id']}, detail='cidr_block')))[0]
 318             subnet = self.conn_vpc.create_subnet(vpc_id, cidr_block)
 319             return subnet.id, created_items
 320         except Exception as e:
 321             self.format_vimconn_exception(e)
 322
 323     def get_network_details(self, filters, detail):
 324         """Get specified details related to a subnet
 325         """
 326         detail_list = []
 327         subnet_list = self.get_network_list(filters)
 328         for net in subnet_list:
 329             detail_list.append(net[detail])
 330         return detail_list
 331
 332     def get_network_list(self, filter_dict={}):
 333         """Obtain tenant networks of VIM
 334         Params:
 335             'filter_dict' (optional) contains entries to return only networks that matches ALL entries:
 336                 name: string  => returns only networks with this name
 337                 id:   string  => returns networks with this VIM id, this imply returns one network at most
 338                 shared: boolean >= returns only networks that are (or are not) shared
 339                 tenant_id: sting => returns only networks that belong to this tenant/project
 340                 ,#(not used yet) admin_state_up: boolean => returns only networks that are (or are not) in admin state active
 341                 #(not used yet) status: 'ACTIVE','ERROR',... => filter networks that are on this status
 342         Returns the network list of dictionaries. each dictionary contains:
 343             'id': (mandatory) VIM network id
 344             'name': (mandatory) VIM network name
 345             'status': (mandatory) can be 'ACTIVE', 'INACTIVE', 'DOWN', 'BUILD', 'ERROR', 'VIM_ERROR', 'OTHER'
 346             'error_msg': (optional) text that explains the ERROR status
 347             other VIM specific fields: (optional) whenever possible using the same naming of filter_dict param
 348         List can be empty if no network map the filter_dict. Raise an exception only upon VIM connectivity,
 349             authorization, or some other unspecific error
 350         """
 351
 352         self.logger.debug("Getting all subnets from VIM")
 353         try:
 354             self._reload_connection()
 355             tfilters = {}
 356             if filter_dict != {}:
 357                 if 'tenant_id' in filter_dict:
 358                     tfilters['vpcId'] = filter_dict['tenant_id']
 359             subnets = self.conn_vpc.get_all_subnets(subnet_ids=filter_dict.get('name', None), filters=tfilters)
 360             net_list = []
 361             for net in subnets:
 362                 net_list.append(
 363                     {'id': str(net.id), 'name': str(net.id), 'status': str(net.state), 'vpc_id': str(net.vpc_id),
 364                      'cidr_block': str(net.cidr_block), 'type': 'bridge'})
 365             return net_list
 366         except Exception as e:
 367             self.format_vimconn_exception(e)
 368
 369     def get_network(self, net_id):
 370         """Obtain network details from the 'net_id' VIM network
 371         Return a dict that contains:
 372             'id': (mandatory) VIM network id, that is, net_id
 373             'name': (mandatory) VIM network name
 374             'status': (mandatory) can be 'ACTIVE', 'INACTIVE', 'DOWN', 'BUILD', 'ERROR', 'VIM_ERROR', 'OTHER'
 375             'error_msg': (optional) text that explains the ERROR status
 376             other VIM specific fields: (optional) whenever possible using the same naming of filter_dict param
 377         Raises an exception upon error or when network is not found
 378         """
 379
 380         self.logger.debug("Getting Subnet from VIM")
 381         try:
 382             self._reload_connection()
 383             subnet = self.conn_vpc.get_all_subnets(net_id)[0]
 384             return {'id': str(subnet.id), 'name': str(subnet.id), 'status': str(subnet.state),
 385                     'vpc_id': str(subnet.vpc_id), 'cidr_block': str(subnet.cidr_block)}
 386         except Exception as e:
 387             self.format_vimconn_exception(e)
 388
 389     def delete_network(self, net_id, created_items=None):
 390         """
 391         Removes a tenant network from VIM and its associated elements
 392         :param net_id: VIM identifier of the network, provided by method new_network
 393         :param created_items: dictionary with extra items to be deleted. provided by method new_network
 394         Returns the network identifier or raises an exception upon error or when network is not found
 395         """
 396
 397         self.logger.debug("Deleting subnet from VIM")
 398         try:
 399             self._reload_connection()
 400             self.logger.debug("DELETING NET_ID: " + str(net_id))
 401             self.conn_vpc.delete_subnet(net_id)
 402             return net_id
 403         except Exception as e:
 404             self.format_vimconn_exception(e)
 405
 406     def refresh_nets_status(self, net_list):
 407         """Get the status of the networks
 408         Params:
 409             'net_list': a list with the VIM network id to be get the status
 410         Returns a dictionary with:
 411             'net_id':         #VIM id of this network
 412                 status:     #Mandatory. Text with one of:
 413                     #  DELETED (not found at vim)
 414                     #  VIM_ERROR (Cannot connect to VIM, authentication problems, VIM response error, ...)
 415                     #  OTHER (Vim reported other status not understood)
 416                     #  ERROR (VIM indicates an ERROR status)
 417                     #  ACTIVE, INACTIVE, DOWN (admin down),
 418                     #  BUILD (on building process)
 419                 error_msg:  #Text with VIM error message, if any. Or the VIM connection ERROR
 420                 vim_info:   #Text with plain information obtained from vim (yaml.safe_dump)
 421             'net_id2': ...
 422         """
 423
 424         self._reload_connection()
 425         try:
 426             dict_entry = {}
 427             for net_id in net_list:
 428                 subnet_dict = {}
 429                 subnet = None
 430                 try:
 431                     subnet = self.conn_vpc.get_all_subnets(net_id)[0]
 432                     if subnet.state == "pending":
 433                         subnet_dict['status'] = "BUILD"
 434                     elif subnet.state == "available":
 435                         subnet_dict['status'] = 'ACTIVE'
 436                     else:
 437                         subnet_dict['status'] = 'ERROR'
 438                     subnet_dict['error_msg'] = ''
 439                 except Exception as e:
 440                     subnet_dict['status'] = 'DELETED'
 441                     subnet_dict['error_msg'] = 'Network not found'
 442                 finally:
 443                     try:
 444                         subnet_dict['vim_info'] = yaml.safe_dump(subnet, default_flow_style=True, width=256)
 445                     except yaml.YAMLError as e:
 446                         subnet_dict['vim_info'] = str(subnet)
 447                 dict_entry[net_id] = subnet_dict
 448             return dict_entry
 449         except Exception as e:
 450             self.format_vimconn_exception(e)
 451
 452     def get_flavor(self, flavor_id):
 453         """Obtain flavor details from the VIM
 454         Returns the flavor dict details {'id':<>, 'name':<>, other vim specific }
 455         Raises an exception upon error or if not found
 456         """
 457
 458         self.logger.debug("Getting instance type")
 459         try:
 460             if flavor_id in self.flavor_info:
 461                 return self.flavor_info[flavor_id]
 462             else:
 463                 raise vimconn.vimconnNotFoundException("Cannot find flavor with this flavor ID/Name")
 464         except Exception as e:
 465             self.format_vimconn_exception(e)
 466
 467     def get_flavor_id_from_data(self, flavor_dict):
 468         """Obtain flavor id that match the flavor description
 469         Params:
 470             'flavor_dict': dictionary that contains:
 471                 'disk': main hard disk in GB
 472                 'ram': memory in MB
 473                 'vcpus': number of virtual cpus
 474                 #todo: complete parameters for EPA
 475         Returns the flavor_id or raises a vimconnNotFoundException
 476         """
 477
 478         self.logger.debug("Getting flavor id from data")
 479         try:
 480             flavor = None
 481             for key, values in self.flavor_info.items():
 482                 if (values["ram"], values["cpus"], values["disk"]) == (
 483                 flavor_dict["ram"], flavor_dict["vcpus"], flavor_dict["disk"]):
 484                     flavor = (key, values)
 485                     break
 486                 elif (values["ram"], values["cpus"], values["disk"]) >= (
 487                 flavor_dict["ram"], flavor_dict["vcpus"], flavor_dict["disk"]):
 488                     if not flavor:
 489                         flavor = (key, values)
 490                     else:
 491                         if (flavor[1]["ram"], flavor[1]["cpus"], flavor[1]["disk"]) >= (
 492                         values["ram"], values["cpus"], values["disk"]):
 493                             flavor = (key, values)
 494             if flavor:
 495                 return flavor[0]
 496             raise vimconn.vimconnNotFoundException("Cannot find flavor with this flavor ID/Name")
 497         except Exception as e:
 498             self.format_vimconn_exception(e)
 499
 500     def new_image(self, image_dict):
 501         """ Adds a tenant image to VIM
 502         Params: image_dict
 503                     name (string) - The name of the AMI. Valid only for EBS-based images.
 504                     description (string) - The description of the AMI.
 505                     image_location (string) - Full path to your AMI manifest in Amazon S3 storage. Only used for S3-based AMI’s.
 506                     architecture (string) - The architecture of the AMI. Valid choices are: * i386 * x86_64
 507                     kernel_id (string) -  The ID of the kernel with which to launch the instances
 508                     root_device_name (string) - The root device name (e.g. /dev/sdh)
 509                     block_device_map (boto.ec2.blockdevicemapping.BlockDeviceMapping) - A BlockDeviceMapping data structure describing the EBS volumes associated with the Image.
 510                     virtualization_type (string) - The virutalization_type of the image. Valid choices are: * paravirtual * hvm
 511                     sriov_net_support (string) - Advanced networking support. Valid choices are: * simple
 512                     snapshot_id (string) - A snapshot ID for the snapshot to be used as root device for the image. Mutually exclusive with block_device_map, requires root_device_name
 513                     delete_root_volume_on_termination (bool) - Whether to delete the root volume of the image after instance termination. Only applies when creating image from snapshot_id. Defaults to False. Note that leaving volumes behind after instance termination is not free
 514         Returns: image_id - image ID of the newly created image
 515         """
 516
 517         try:
 518             self._reload_connection()
 519             image_location = image_dict.get('image_location', None)
 520             if image_location:
 521                 image_location = str(self.account_id) + str(image_location)
 522
 523             image_id = self.conn.register_image(image_dict.get('name', None), image_dict.get('description', None),
 524                                                 image_location, image_dict.get('architecture', None),
 525                                                 image_dict.get('kernel_id', None),
 526                                                 image_dict.get('root_device_name', None),
 527                                                 image_dict.get('block_device_map', None),
 528                                                 image_dict.get('virtualization_type', None),
 529                                                 image_dict.get('sriov_net_support', None),
 530                                                 image_dict.get('snapshot_id', None),
 531                                                 image_dict.get('delete_root_volume_on_termination', None))
 532             return image_id
 533         except Exception as e:
 534             self.format_vimconn_exception(e)
 535
 536     def delete_image(self, image_id):
 537         """Deletes a tenant image from VIM
 538         Returns the image_id if image is deleted or raises an exception on error"""
 539
 540         try:
 541             self._reload_connection()
 542             self.conn.deregister_image(image_id)
 543             return image_id
 544         except Exception as e:
 545             self.format_vimconn_exception(e)
 546
 547     def get_image_id_from_path(self, path):
 548         '''
 549         Params: path - location of the image
 550         Returns: image_id - ID of the matching image
 551         '''
 552         self._reload_connection()
 553         try:
 554             filters = {}
 555             if path:
 556                 tokens = path.split('/')
 557                 filters['owner_id'] = tokens[0]
 558                 filters['name'] = '/'.join(tokens[1:])
 559             image = self.conn.get_all_images(filters=filters)[0]
 560             return image.id
 561         except Exception as e:
 562             self.format_vimconn_exception(e)
 563
 564     def get_image_list(self, filter_dict={}):
 565         """Obtain tenant images from VIM
 566         Filter_dict can be:
 567             name: image name
 568             id: image uuid
 569             checksum: image checksum
 570             location: image path
 571         Returns the image list of dictionaries:
 572             [{<the fields at Filter_dict plus some VIM specific>}, ...]
 573             List can be empty
 574         """
 575
 576         self.logger.debug("Getting image list from VIM")
 577         try:
 578             self._reload_connection()
 579             image_id = None
 580             filters = {}
 581             if 'id' in filter_dict:
 582                 image_id = filter_dict['id']
 583             if 'name' in filter_dict:
 584                 filters['name'] = filter_dict['name']
 585             if 'location' in filter_dict:
 586                 filters['location'] = filter_dict['location']
 587             # filters['image_type'] = 'machine'
 588             # filter_dict['owner_id'] = self.account_id
 589             images = self.conn.get_all_images(image_id, filters=filters)
 590             image_list = []
 591             for image in images:
 592                 image_list.append({'id': str(image.id), 'name': str(image.name), 'status': str(image.state),
 593                                    'owner': str(image.owner_id), 'location': str(image.location),
 594                                    'is_public': str(image.is_public), 'architecture': str(image.architecture),
 595                                    'platform': str(image.platform)})
 596             return image_list
 597         except Exception as e:
 598             self.format_vimconn_exception(e)
 599
 600     def new_vminstance(self, name, description, start, image_id, flavor_id, net_list, cloud_config=None,
 601                        disk_list=None, availability_zone_index=None, availability_zone_list=None):
 602         """Create a new VM/instance in AWS
 603         Params: name
 604                 decription
 605                 start: (boolean) indicates if VM must start or created in pause mode.
 606                 image_id - image ID in AWS
 607                 flavor_id - instance type ID in AWS
 608                 net_list
 609                     name
 610                     net_id - subnet_id from AWS
 611                     vpci - (optional) virtual vPCI address to assign at the VM. Can be ignored depending on VIM capabilities
 612                     model: (optional and only have sense for type==virtual) interface model: virtio, e1000, ...
 613                     mac_address: (optional) mac address to assign to this interface
 614                     type: (mandatory) can be one of:
 615                         virtual, in this case always connected to a network of type 'net_type=bridge'
 616                         'PCI-PASSTHROUGH' or 'PF' (passthrough): depending on VIM capabilities it can be connected to a data/ptp network ot it
 617                            can created unconnected
 618                         'SR-IOV' or 'VF' (SRIOV with VLAN tag): same as PF for network connectivity.
 619                         VFnotShared - (SRIOV without VLAN tag) same as PF for network connectivity. VF where no other VFs
 620                             are allocated on the same physical NIC
 621                     bw': (optional) only for PF/VF/VFnotShared. Minimal Bandwidth required for the interface in GBPS
 622                     port_security': (optional) If False it must avoid any traffic filtering at this interface. If missing or True, it must apply the default VIM behaviour
 623                     vim_id': must be filled/added by this method with the VIM identifier generated by the VIM for this interface. 'net_list' is modified
 624                     elastic_ip - True/False to define if an elastic_ip is required
 625                 cloud_config': (optional) dictionary with:
 626                     key-pairs': (optional) list of strings with the public key to be inserted to the default user
 627                     users': (optional) list of users to be inserted, each item is a dict with:
 628                         name': (mandatory) user name,
 629                         key-pairs': (optional) list of strings with the public key to be inserted to the user
 630                     user-data': (optional) string is a text script to be passed directly to cloud-init
 631                     config-files': (optional). List of files to be transferred. Each item is a dict with:
 632                         dest': (mandatory) string with the destination absolute path
 633                         encoding': (optional, by default text). Can be one of:
 634                             b64', 'base64', 'gz', 'gz+b64', 'gz+base64', 'gzip+b64', 'gzip+base64'
 635                         content' (mandatory): string with the content of the file
 636                         permissions': (optional) string with file permissions, typically octal notation '0644'
 637                         owner: (optional) file owner, string with the format 'owner:group'
 638                     boot-data-drive: boolean to indicate if user-data must be passed using a boot drive (hard disk)
 639                     security-groups:
 640                         subnet_id
 641                         security_group_id
 642                 disk_list': (optional) list with additional disks to the VM. Each item is a dict with:
 643                     image_id': (optional). VIM id of an existing image. If not provided an empty disk must be mounted
 644                     size': (mandatory) string with the size of the disk in GB
 645         Returns a tuple with the instance identifier and created_items or raises an exception on error
 646             created_items can be None or a dictionary where this method can include key-values that will be passed to
 647             the method delete_vminstance and action_vminstance. Can be used to store created ports, volumes, etc.
 648             Format is vimconnector dependent, but do not use nested dictionaries and a value of None should be the same
 649             as not present.
 650         """
 651
 652         self.logger.debug("Creating a new VM instance")
 653         try:
 654             self._reload_connection()
 655             instance = None
 656             _, userdata = self._create_user_data(cloud_config)
 657
 658             if not net_list:
 659                 reservation = self.conn.run_instances(
 660                     image_id,
 661                     key_name=self.key_pair,
 662                     instance_type=flavor_id,
 663                     security_groups=self.security_groups,
 664                     user_data=userdata
 665                 )
 666             else:
 667                 for index, subnet in enumerate(net_list):
 668                     net_intr = boto.ec2.networkinterface.NetworkInterfaceSpecification(subnet_id=subnet.get('net_id'),
 669                                                                                        groups=None,
 670                                                                                        associate_public_ip_address=True)
 671
 672                     if subnet.get('elastic_ip'):
 673                         eip = self.conn.allocate_address()
 674                         self.conn.associate_address(allocation_id=eip.allocation_id, network_interface_id=net_intr.id)
 675
 676                     if index == 0:
 677                         reservation = self.conn.run_instances(
 678                             image_id,
 679                             key_name=self.key_pair,
 680                             instance_type=flavor_id,
 681                             security_groups=self.security_groups,
 682                             network_interfaces=boto.ec2.networkinterface.NetworkInterfaceCollection(net_intr),
 683                             user_data=userdata
 684                         )
 685                     else:
 686                         while True:
 687                             try:
 688                                 self.conn.attach_network_interface(
 689                                     network_interface_id=boto.ec2.networkinterface.NetworkInterfaceCollection(net_intr),
 690                                     instance_id=instance.id, device_index=0)
 691                                 break
 692                             except:
 693                                 time.sleep(10)
 694                     net_list[index]['vim_id'] = reservation.instances[0].interfaces[index].id
 695
 696             instance = reservation.instances[0]
 697             return instance.id, None
 698         except Exception as e:
 699             self.format_vimconn_exception(e)
 700
 701     def get_vminstance(self, vm_id):
 702         """Returns the VM instance information from VIM"""
 703
 704         try:
 705             self._reload_connection()
 706             reservation = self.conn.get_all_instances(vm_id)
 707             return reservation[0].instances[0].__dict__
 708         except Exception as e:
 709             self.format_vimconn_exception(e)
 710
 711     def delete_vminstance(self, vm_id, created_items=None):
 712         """Removes a VM instance from VIM
 713         Returns the instance identifier"""
 714
 715         try:
 716             self._reload_connection()
 717             self.logger.debug("DELETING VM_ID: " + str(vm_id))
 718             self.conn.terminate_instances(vm_id)
 719             return vm_id
 720         except Exception as e:
 721             self.format_vimconn_exception(e)
 722
 723     def refresh_vms_status(self, vm_list):
 724         """ Get the status of the virtual machines and their interfaces/ports
 725         Params: the list of VM identifiers
 726         Returns a dictionary with:
 727             vm_id:          #VIM id of this Virtual Machine
 728                 status:     #Mandatory. Text with one of:
 729                             #  DELETED (not found at vim)
 730                             #  VIM_ERROR (Cannot connect to VIM, VIM response error, ...)
 731                             #  OTHER (Vim reported other status not understood)
 732                             #  ERROR (VIM indicates an ERROR status)
 733                             #  ACTIVE, PAUSED, SUSPENDED, INACTIVE (not running),
 734                             #  BUILD (on building process), ERROR
 735                             #  ACTIVE:NoMgmtIP (Active but any of its interface has an IP address
 736                             #
 737                 error_msg:  #Text with VIM error message, if any. Or the VIM connection ERROR
 738                 vim_info:   #Text with plain information obtained from vim (yaml.safe_dump)
 739                 interfaces: list with interface info. Each item a dictionary with:
 740                     vim_interface_id -  The ID of the ENI.
 741                     vim_net_id - The ID of the VPC subnet.
 742                     mac_address - The MAC address of the interface.
 743                     ip_address - The IP address of the interface within the subnet.
 744         """
 745         self.logger.debug("Getting VM instance information from VIM")
 746         try:
 747             self._reload_connection()
 748             reservation = self.conn.get_all_instances(vm_list)[0]
 749             instances = {}
 750             instance_dict = {}
 751             for instance in reservation.instances:
 752                 try:
 753                     if instance.state in ("pending"):
 754                         instance_dict['status'] = "BUILD"
 755                     elif instance.state in ("available", "running", "up"):
 756                         instance_dict['status'] = 'ACTIVE'
 757                     else:
 758                         instance_dict['status'] = 'ERROR'
 759                     instance_dict['error_msg'] = ""
 760                     instance_dict['interfaces'] = []
 761                     interface_dict = {}
 762                     for interface in instance.interfaces:
 763                         interface_dict['vim_interface_id'] = interface.id
 764                         interface_dict['vim_net_id'] = interface.subnet_id
 765                         interface_dict['mac_address'] = interface.mac_address
 766                         if hasattr(interface, 'publicIp') and interface.publicIp != None:
 767                             interface_dict['ip_address'] = interface.publicIp + ";" + interface.private_ip_address
 768                         else:
 769                             interface_dict['ip_address'] = interface.private_ip_address
 770                         instance_dict['interfaces'].append(interface_dict)
 771                 except Exception as e:
 772                     self.logger.error("Exception getting vm status: %s", str(e), exc_info=True)
 773                     instance_dict['status'] = "DELETED"
 774                     instance_dict['error_msg'] = str(e)
 775                 finally:
 776                     try:
 777                         instance_dict['vim_info'] = yaml.safe_dump(instance, default_flow_style=True, width=256)
 778                     except yaml.YAMLError as e:
 779                         # self.logger.error("Exception getting vm status: %s", str(e), exc_info=True)
 780                         instance_dict['vim_info'] = str(instance)
 781                 instances[instance.id] = instance_dict
 782             return instances
 783         except Exception as e:
 784             self.logger.error("Exception getting vm status: %s", str(e), exc_info=True)
 785             self.format_vimconn_exception(e)
 786
 787     def action_vminstance(self, vm_id, action_dict, created_items={}):
 788         """Send and action over a VM instance from VIM
 789         Returns the vm_id if the action was successfully sent to the VIM"""
 790
 791         self.logger.debug("Action over VM '%s': %s", vm_id, str(action_dict))
 792         try:
 793             self._reload_connection()
 794             if "start" in action_dict:
 795                 self.conn.start_instances(vm_id)
 796             elif "stop" in action_dict or "stop" in action_dict:
 797                 self.conn.stop_instances(vm_id)
 798             elif "terminate" in action_dict:
 799                 self.conn.terminate_instances(vm_id)
 800             elif "reboot" in action_dict:
 801                 self.conn.reboot_instances(vm_id)
 802             return None
 803         except Exception as e:
 804             self.format_vimconn_exception(e)