snaps/openstack/create_instance.py

   1 # Copyright (c) 2017 Cable Television Laboratories, Inc. ("CableLabs")
   2 #                    and others.  All rights reserved.
   3 #
   4 # Licensed under the Apache License, Version 2.0 (the "License");
   5 # you may not use this file except in compliance with the License.
   6 # You may obtain a copy of the License at:
   7 #
   8 #     http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 # Unless required by applicable law or agreed to in writing, software
  11 # distributed under the License is distributed on an "AS IS" BASIS,
  12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 # See the License for the specific language governing permissions and
  14 # limitations under the License.
  15 import logging
  16 import time
  17
  18 from neutronclient.common.exceptions import PortNotFoundClient
  19 from novaclient.exceptions import NotFound
  20
  21 from snaps.openstack.create_network import PortSettings
  22 from snaps.openstack.utils import glance_utils
  23 from snaps.openstack.utils import neutron_utils
  24 from snaps.openstack.utils import nova_utils
  25 from snaps.provisioning import ansible_utils
  26
  27 __author__ = 'spisarski'
  28
  29 logger = logging.getLogger('create_instance')
  30
  31 POLL_INTERVAL = 3
  32 STATUS_ACTIVE = 'ACTIVE'
  33 STATUS_DELETED = 'DELETED'
  34
  35
  36 class OpenStackVmInstance:
  37     """
  38     Class responsible for creating a VM instance in OpenStack
  39     """
  40
  41     def __init__(self, os_creds, instance_settings, image_settings,
  42                  keypair_settings=None):
  43         """
  44         Constructor
  45         :param os_creds: The connection credentials to the OpenStack API
  46         :param instance_settings: Contains the settings for this VM
  47         :param image_settings: The OpenStack image object settings
  48         :param keypair_settings: The keypair metadata (Optional)
  49         :raises Exception
  50         """
  51         self.__os_creds = os_creds
  52
  53         self.__nova = None
  54         self.__neutron = None
  55
  56         self.instance_settings = instance_settings
  57         self.image_settings = image_settings
  58         self.keypair_settings = keypair_settings
  59
  60         # TODO - get rid of FIP list and only use the dict(). Need to fix
  61         # populating this object when already exists
  62         self.__floating_ips = list()
  63         self.__floating_ip_dict = dict()
  64
  65         # Instantiated in self.create()
  66         self.__ports = list()
  67
  68         # Note: this object does not change after the VM becomes active
  69         self.__vm = None
  70
  71     def create(self, cleanup=False, block=False):
  72         """
  73         Creates a VM instance
  74         :param cleanup: When true, only perform lookups for OpenStack objects.
  75         :param block: Thread will block until instance has either become
  76                       active, error, or timeout waiting.
  77                       Additionally, when True, floating IPs will not be applied
  78                       until VM is active.
  79         :return: The VM reference object
  80         """
  81         self.__nova = nova_utils.nova_client(self.__os_creds)
  82         self.__neutron = neutron_utils.neutron_client(self.__os_creds)
  83
  84         self.__ports = self.__setup_ports(self.instance_settings.port_settings,
  85                                           cleanup)
  86         self.__lookup_existing_vm_by_name()
  87         if not self.__vm and not cleanup:
  88             self.__create_vm(block)
  89         return self.__vm
  90
  91     def __lookup_existing_vm_by_name(self):
  92         """
  93         Populates the member variables 'self.vm' and 'self.floating_ips' if a
  94         VM with the same name already exists
  95         within the project
  96         """
  97         servers = nova_utils.get_servers_by_name(self.__nova,
  98                                                  self.instance_settings.name)
  99         for server in servers:
 100             if server.name == self.instance_settings.name:
 101                 self.__vm = server
 102                 logger.info(
 103                     'Found existing machine with name - %s',
 104                     self.instance_settings.name)
 105                 fips = neutron_utils.get_floating_ips(self.__neutron)
 106                 for fip in fips:
 107                     for subnet_name, ips in server.networks.items():
 108                         if fip.ip in ips:
 109                             self.__floating_ips.append(fip)
 110                             # TODO - Determine a means to associate to the FIP
 111                             # configuration and add to FIP map
 112
 113     def __create_vm(self, block=False):
 114         """
 115         Responsible for creating the VM instance
 116         :param block: Thread will block until instance has either become
 117                       active, error, or timeout waiting. Floating IPs will be
 118                       assigned after active when block=True
 119         """
 120         glance = glance_utils.glance_client(self.__os_creds)
 121         self.__vm = nova_utils.create_server(
 122             self.__nova, self.__neutron, glance, self.instance_settings,
 123             self.image_settings, self.keypair_settings)
 124         logger.info('Created instance with name - %s',
 125                     self.instance_settings.name)
 126
 127         if block:
 128             if not self.vm_active(block=True):
 129                 raise Exception(
 130                     'Fatal error, VM did not become ACTIVE within the alloted '
 131                     'time')
 132
 133         # Create server should do this but found it needed to occur here
 134         for sec_grp_name in self.instance_settings.security_group_names:
 135             if self.vm_active(block=True):
 136                 nova_utils.add_security_group(self.__nova, self.__vm,
 137                                               sec_grp_name)
 138             else:
 139                 raise Exception(
 140                     'Cannot applying security group with name ' +
 141                     sec_grp_name +
 142                     ' to VM that did not activate with name - ' +
 143                     self.instance_settings.name)
 144
 145         self.__apply_floating_ips()
 146
 147     def __apply_floating_ips(self):
 148         """
 149         Applies the configured floating IPs to the necessary ports
 150         """
 151         port_dict = dict()
 152         for key, port in self.__ports:
 153             port_dict[key] = port
 154
 155         # Apply floating IPs
 156         for floating_ip_setting in self.instance_settings.floating_ip_settings:
 157             port = port_dict.get(floating_ip_setting.port_name)
 158
 159             if not port:
 160                 raise Exception(
 161                     'Cannot find port object with name - ' +
 162                     floating_ip_setting.port_name)
 163
 164             # Setup Floating IP only if there is a router with an external
 165             # gateway
 166             ext_gateway = self.__ext_gateway_by_router(
 167                 floating_ip_setting.router_name)
 168             if ext_gateway:
 169                 subnet = neutron_utils.get_subnet_by_name(
 170                     self.__neutron, floating_ip_setting.subnet_name)
 171                 floating_ip = neutron_utils.create_floating_ip(
 172                     self.__neutron, ext_gateway)
 173                 self.__floating_ips.append(floating_ip)
 174                 self.__floating_ip_dict[floating_ip_setting.name] = floating_ip
 175
 176                 logger.info(
 177                     'Created floating IP %s via router - %s', floating_ip.ip,
 178                     floating_ip_setting.router_name)
 179                 self.__add_floating_ip(floating_ip, port, subnet)
 180             else:
 181                 raise Exception('Unable to add floating IP to port,'
 182                                 ' cannot locate router with an external '
 183                                 'gateway ')
 184
 185     def __ext_gateway_by_router(self, router_name):
 186         """
 187         Returns network name for the external network attached to a router or
 188         None if not found
 189         :param router_name: The name of the router to lookup
 190         :return: the external network name or None
 191         """
 192         router = neutron_utils.get_router_by_name(self.__neutron, router_name)
 193         if router and router.external_gateway_info:
 194             network = neutron_utils.get_network_by_id(
 195                 self.__neutron,
 196                 router.external_gateway_info['network_id'])
 197             if network:
 198                 return network.name
 199         return None
 200
 201     def clean(self):
 202         """
 203         Destroys the VM instance
 204         """
 205
 206         # Cleanup floating IPs
 207         for floating_ip in self.__floating_ips:
 208             try:
 209                 logger.info('Deleting Floating IP - ' + floating_ip.ip)
 210                 neutron_utils.delete_floating_ip(self.__neutron, floating_ip)
 211             except Exception as e:
 212                 logger.error('Error deleting Floating IP - ' + str(e))
 213         self.__floating_ips = list()
 214         self.__floating_ip_dict = dict()
 215
 216         # Cleanup ports
 217         for name, port in self.__ports:
 218             logger.info('Deleting Port - ' + name)
 219             try:
 220                 neutron_utils.delete_port(self.__neutron, port)
 221             except PortNotFoundClient as e:
 222                 logger.warning('Unexpected error deleting port - %s', e)
 223                 pass
 224         self.__ports = list()
 225
 226         # Cleanup VM
 227         if self.__vm:
 228             try:
 229                 logger.info(
 230                     'Deleting VM instance - ' + self.instance_settings.name)
 231                 nova_utils.delete_vm_instance(self.__nova, self.__vm)
 232             except Exception as e:
 233                 logger.error('Error deleting VM - %s', e)
 234
 235             # Block until instance cannot be found or returns the status of
 236             # DELETED
 237             logger.info('Checking deletion status')
 238
 239             try:
 240                 if self.vm_deleted(block=True):
 241                     logger.info(
 242                         'VM has been properly deleted VM with name - %s',
 243                         self.instance_settings.name)
 244                     self.__vm = None
 245                 else:
 246                     logger.error(
 247                         'VM not deleted within the timeout period of %s '
 248                         'seconds', self.instance_settings.vm_delete_timeout)
 249             except Exception as e:
 250                 logger.error(
 251                     'Unexpected error while checking VM instance status - %s',
 252                     e)
 253
 254     def __setup_ports(self, port_settings, cleanup):
 255         """
 256         Returns the previously configured ports or creates them if they do not
 257         exist
 258         :param port_settings: A list of PortSetting objects
 259         :param cleanup: When true, only perform lookups for OpenStack objects.
 260         :return: a list of OpenStack port tuples where the first member is the
 261                  port name and the second is the port object
 262         """
 263         ports = list()
 264
 265         for port_setting in port_settings:
 266             port = neutron_utils.get_port_by_name(self.__neutron,
 267                                                   port_setting.name)
 268             if port:
 269                 ports.append((port_setting.name, {'port': port}))
 270             elif not cleanup:
 271                 # Exception will be raised when port with same name already
 272                 # exists
 273                 ports.append(
 274                     (port_setting.name, neutron_utils.create_port(
 275                         self.__neutron, self.__os_creds, port_setting)))
 276
 277         return ports
 278
 279     def __add_floating_ip(self, floating_ip, port, subnet, timeout=30,
 280                           poll_interval=POLL_INTERVAL):
 281         """
 282         Returns True when active else False
 283         TODO - Make timeout and poll_interval configurable...
 284         """
 285         ip = None
 286
 287         if subnet:
 288             # Take IP of subnet if there is one configured on which to place
 289             # the floating IP
 290             for fixed_ip in port.fixed_ips:
 291                 if fixed_ip['subnet_id'] == subnet['subnet']['id']:
 292                     ip = fixed_ip['ip_address']
 293                     break
 294         else:
 295             # Simply take the first
 296             ip = port.ips[0]['ip_address']
 297
 298         if ip:
 299             count = timeout / poll_interval
 300             while count > 0:
 301                 logger.debug('Attempting to add floating IP to instance')
 302                 try:
 303                     nova_utils.add_floating_ip_to_server(
 304                         self.__nova, self.__vm, floating_ip, ip)
 305                     logger.info(
 306                         'Added floating IP %s to port IP %s on instance %s',
 307                         floating_ip.ip, ip, self.instance_settings.name)
 308                     return
 309                 except Exception as e:
 310                     logger.debug(
 311                         'Retry adding floating IP to instance. Last attempt '
 312                         'failed with - %s', e)
 313                     time.sleep(poll_interval)
 314                     count -= 1
 315                     pass
 316         else:
 317             raise Exception(
 318                 'Unable find IP address on which to place the floating IP')
 319
 320         logger.error('Timeout attempting to add the floating IP to instance.')
 321         raise Exception('Timeout while attempting add floating IP to instance')
 322
 323     def get_os_creds(self):
 324         """
 325         Returns the OpenStack credentials used to create these objects
 326         :return: the credentials
 327         """
 328         return self.__os_creds
 329
 330     def get_vm_inst(self):
 331         """
 332         Returns the latest version of this server object from OpenStack
 333         :return: Server object
 334         """
 335         return self.__vm
 336
 337     def get_console_output(self):
 338         """
 339         Returns the vm console object for parsing logs
 340         :return: the console output object
 341         """
 342         return nova_utils.get_server_console_output(self.__nova, self.__vm)
 343
 344     def get_port_ip(self, port_name, subnet_name=None):
 345         """
 346         Returns the first IP for the port corresponding with the port_name
 347         parameter when subnet_name is None else returns the IP address that
 348         corresponds to the subnet_name parameter
 349         :param port_name: the name of the port from which to return the IP
 350         :param subnet_name: the name of the subnet attached to this IP
 351         :return: the IP or None if not found
 352         """
 353         port = self.get_port_by_name(port_name)
 354         if port:
 355             if subnet_name:
 356                 subnet = neutron_utils.get_subnet_by_name(self.__neutron,
 357                                                           subnet_name)
 358                 if not subnet:
 359                     logger.warning('Cannot retrieve port IP as subnet could '
 360                                    'not be located with name - %s',
 361                                    subnet_name)
 362                     return None
 363                 for fixed_ip in port.ips:
 364                     if fixed_ip['subnet_id'] == subnet.id:
 365                         return fixed_ip['ip_address']
 366             else:
 367                 if port.ips and len(port.ips) > 0:
 368                     return port.ips[0]['ip_address']
 369         return None
 370
 371     def get_port_mac(self, port_name):
 372         """
 373         Returns the first IP for the port corresponding with the port_name
 374         parameter
 375         TODO - Add in the subnet as an additional parameter as a port may have
 376         multiple fixed_ips
 377         :param port_name: the name of the port from which to return the IP
 378         :return: the IP or None if not found
 379         """
 380         port = self.get_port_by_name(port_name)
 381         if port:
 382             return port.mac_address
 383         return None
 384
 385     def get_port_by_name(self, port_name):
 386         """
 387         Retrieves the OpenStack port object by its given name
 388         :param port_name: the name of the port
 389         :return: the OpenStack port object or None if not exists
 390         """
 391         for key, port in self.__ports:
 392             if key == port_name:
 393                 return port
 394         logger.warning('Cannot find port with name - ' + port_name)
 395         return None
 396
 397     def get_vm_info(self):
 398         """
 399         Returns a dictionary of a VMs info as returned by OpenStack
 400         :return: a dict()
 401         """
 402         return nova_utils.get_server_info(self.__nova, self.__vm)
 403
 404     def config_nics(self):
 405         """
 406         Responsible for configuring NICs on RPM systems where the instance has
 407         more than one configured port
 408         :return: None
 409         """
 410         if len(self.__ports) > 1 and len(self.__floating_ips) > 0:
 411             if self.vm_active(block=True) and self.vm_ssh_active(block=True):
 412                 for key, port in self.__ports:
 413                     port_index = self.__ports.index((key, port))
 414                     if port_index > 0:
 415                         nic_name = 'eth' + repr(port_index)
 416                         self.__config_nic(
 417                             nic_name, port,
 418                             self.__get_first_provisioning_floating_ip().ip)
 419                         logger.info('Configured NIC - %s on VM - %s',
 420                                     nic_name, self.instance_settings.name)
 421
 422     def __get_first_provisioning_floating_ip(self):
 423         """
 424         Returns the first floating IP tagged with the Floating IP name if
 425         exists else the first one found
 426         :return:
 427         """
 428         for floating_ip_setting in self.instance_settings.floating_ip_settings:
 429             if floating_ip_setting.provisioning:
 430                 fip = self.__floating_ip_dict.get(floating_ip_setting.name)
 431                 if fip:
 432                     return fip
 433                 elif len(self.__floating_ips) > 0:
 434                     return self.__floating_ips[0]
 435
 436     def __config_nic(self, nic_name, port, ip):
 437         """
 438         Although ports/NICs can contain multiple IPs, this code currently only
 439         supports the first.
 440
 441         :param nic_name: Name of the interface
 442         :param port: The port information containing the expected IP values.
 443         :param ip: The IP on which to apply the playbook.
 444         :return: the return value from ansible
 445         """
 446         port_ip = port.ips[0]['ip_address']
 447         variables = {
 448             'floating_ip': ip,
 449             'nic_name': nic_name,
 450             'nic_ip': port_ip
 451         }
 452
 453         if self.image_settings.nic_config_pb_loc and self.keypair_settings:
 454             return self.apply_ansible_playbook(
 455                 self.image_settings.nic_config_pb_loc, variables)
 456         else:
 457             logger.warning(
 458                 'VM %s cannot self configure NICs eth1++. No playbook or '
 459                 'keypairs found.', self.instance_settings.name)
 460
 461     def apply_ansible_playbook(self, pb_file_loc, variables=None,
 462                                fip_name=None):
 463         """
 464         Applies a playbook to a VM
 465         :param pb_file_loc: the file location of the playbook to be applied
 466         :param variables: a dict() of substitution values required by the
 467                           playbook
 468         :param fip_name: the name of the floating IP to use for applying the
 469                          playbook (default - will take the first)
 470         :return: the return value from ansible
 471         """
 472         return ansible_utils.apply_playbook(
 473             pb_file_loc, [self.get_floating_ip(fip_name=fip_name).ip],
 474             self.get_image_user(), self.keypair_settings.private_filepath,
 475             variables, self.__os_creds.proxy_settings)
 476
 477     def get_image_user(self):
 478         """
 479         Returns the instance sudo_user if it has been configured in the
 480         instance_settings else it returns the image_settings.image_user value
 481         """
 482         if self.instance_settings.sudo_user:
 483             return self.instance_settings.sudo_user
 484         else:
 485             return self.image_settings.image_user
 486
 487     def vm_deleted(self, block=False, poll_interval=POLL_INTERVAL):
 488         """
 489         Returns true when the VM status returns the value of
 490         expected_status_code or instance retrieval throws a NotFound exception.
 491         :param block: When true, thread will block until active or timeout
 492                       value in seconds has been exceeded (False)
 493         :param poll_interval: The polling interval in seconds
 494         :return: T/F
 495         """
 496         try:
 497             return self.__vm_status_check(
 498                 STATUS_DELETED, block,
 499                 self.instance_settings.vm_delete_timeout, poll_interval)
 500         except NotFound as e:
 501             logger.debug(
 502                 "Instance not found when querying status for %s with message "
 503                 "%s", STATUS_DELETED, e)
 504             return True
 505
 506     def vm_active(self, block=False, poll_interval=POLL_INTERVAL):
 507         """
 508         Returns true when the VM status returns the value of
 509         expected_status_code
 510         :param block: When true, thread will block until active or timeout
 511                       value in seconds has been exceeded (False)
 512         :param poll_interval: The polling interval in seconds
 513         :return: T/F
 514         """
 515         return self.__vm_status_check(STATUS_ACTIVE, block,
 516                                       self.instance_settings.vm_boot_timeout,
 517                                       poll_interval)
 518
 519     def __vm_status_check(self, expected_status_code, block, timeout,
 520                           poll_interval):
 521         """
 522         Returns true when the VM status returns the value of
 523         expected_status_code
 524         :param expected_status_code: instance status evaluated with this
 525                                      string value
 526         :param block: When true, thread will block until active or timeout
 527                       value in seconds has been exceeded (False)
 528         :param timeout: The timeout value
 529         :param poll_interval: The polling interval in seconds
 530         :return: T/F
 531         """
 532         # sleep and wait for VM status change
 533         if block:
 534             start = time.time()
 535         else:
 536             return self.__status(expected_status_code)
 537
 538         while timeout > time.time() - start:
 539             status = self.__status(expected_status_code)
 540             if status:
 541                 logger.info('VM is - ' + expected_status_code)
 542                 return True
 543
 544             logger.debug('Retry querying VM status in ' + str(
 545                 poll_interval) + ' seconds')
 546             time.sleep(poll_interval)
 547             logger.debug('VM status query timeout in ' + str(
 548                 timeout - (time.time() - start)))
 549
 550         logger.error(
 551             'Timeout checking for VM status for ' + expected_status_code)
 552         return False
 553
 554     def __status(self, expected_status_code):
 555         """
 556         Returns True when active else False
 557         :param expected_status_code: instance status evaluated with this string
 558                                      value
 559         :return: T/F
 560         """
 561         if not self.__vm:
 562             return False
 563
 564         status = nova_utils.get_server_status(self.__nova, self.__vm)
 565         if not status:
 566             logger.warning('Cannot find instance with id - ' + self.__vm.id)
 567             return False
 568
 569         if status == 'ERROR':
 570             raise Exception('Instance had an error during deployment')
 571         logger.debug(
 572             'Instance status [%s] is - %s', self.instance_settings.name,
 573             status)
 574         return status == expected_status_code
 575
 576     def vm_ssh_active(self, block=False, poll_interval=POLL_INTERVAL):
 577         """
 578         Returns true when the VM can be accessed via SSH
 579         :param block: When true, thread will block until active or timeout
 580                       value in seconds has been exceeded (False)
 581         :param poll_interval: The polling interval
 582         :return: T/F
 583         """
 584         # sleep and wait for VM status change
 585         logger.info('Checking if VM is active')
 586
 587         timeout = self.instance_settings.ssh_connect_timeout
 588
 589         if self.vm_active(block=True):
 590             if block:
 591                 start = time.time()
 592             else:
 593                 start = time.time() - timeout
 594
 595             while timeout > time.time() - start:
 596                 status = self.__ssh_active()
 597                 if status:
 598                     logger.info('SSH is active for VM instance')
 599                     return True
 600
 601                 logger.debug('Retry SSH connection in ' + str(
 602                     poll_interval) + ' seconds')
 603                 time.sleep(poll_interval)
 604                 logger.debug('SSH connection timeout in ' + str(
 605                     timeout - (time.time() - start)))
 606
 607         logger.error('Timeout attempting to connect with VM via SSH')
 608         return False
 609
 610     def __ssh_active(self):
 611         """
 612         Returns True when can create a SSH session else False
 613         :return: T/F
 614         """
 615         if len(self.__floating_ips) > 0:
 616             ssh = self.ssh_client()
 617             if ssh:
 618                 return True
 619         return False
 620
 621     def get_floating_ip(self, fip_name=None):
 622         """
 623         Returns the floating IP object byt name if found, else the first known,
 624         else None
 625         :param fip_name: the name of the floating IP to return
 626         :return: the SSH client or None
 627         """
 628         fip = None
 629         if fip_name and self.__floating_ip_dict.get(fip_name):
 630             return self.__floating_ip_dict.get(fip_name)
 631         if not fip and len(self.__floating_ips) > 0:
 632             return self.__floating_ips[0]
 633         return None
 634
 635     def ssh_client(self, fip_name=None):
 636         """
 637         Returns an SSH client using the name or the first known floating IP if
 638         exists, else None
 639         :param fip_name: the name of the floating IP to return
 640         :return: the SSH client or None
 641         """
 642         fip = self.get_floating_ip(fip_name)
 643         if fip:
 644             return ansible_utils.ssh_client(
 645                 self.__floating_ips[0].ip, self.get_image_user(),
 646                 self.keypair_settings.private_filepath,
 647                 proxy_settings=self.__os_creds.proxy_settings)
 648         else:
 649             logger.warning(
 650                 'Cannot return an SSH client. No Floating IP configured')
 651
 652     def add_security_group(self, security_group):
 653         """
 654         Adds a security group to this VM. Call will block until VM is active.
 655         :param security_group: the SNAPS SecurityGroup domain object
 656         :return True if successful else False
 657         """
 658         self.vm_active(block=True)
 659
 660         if not security_group:
 661             logger.warning('Security group object is None, cannot add')
 662             return False
 663
 664         try:
 665             nova_utils.add_security_group(self.__nova, self.get_vm_inst(),
 666                                           security_group.name)
 667             return True
 668         except NotFound as e:
 669             logger.warning('Security group not added - ' + str(e))
 670             return False
 671
 672     def remove_security_group(self, security_group):
 673         """
 674         Removes a security group to this VM. Call will block until VM is active
 675         :param security_group: the OpenStack security group object
 676         :return True if successful else False
 677         """
 678         self.vm_active(block=True)
 679
 680         if not security_group:
 681             logger.warning('Security group object is None, cannot remove')
 682             return False
 683
 684         try:
 685             nova_utils.remove_security_group(self.__nova, self.get_vm_inst(),
 686                                              security_group)
 687             return True
 688         except NotFound as e:
 689             logger.warning('Security group not removed - ' + str(e))
 690             return False
 691
 692
 693 class VmInstanceSettings:
 694     """
 695     Class responsible for holding configuration setting for a VM Instance
 696     """
 697
 698     def __init__(self, **kwargs):
 699         """
 700         Constructor
 701         :param name: the name of the VM
 702         :param flavor: the VM's flavor
 703         :param port_settings: the port configuration settings (required)
 704         :param security_group_names: a set of names of the security groups to
 705                                      add to the VM
 706         :param floating_ip_settings: the floating IP configuration settings
 707         :param sudo_user: the sudo user of the VM that will override the
 708                           instance_settings.image_user when trying to
 709                           connect to the VM
 710         :param vm_boot_timeout: the amount of time a thread will sleep waiting
 711                                 for an instance to boot
 712         :param vm_delete_timeout: the amount of time a thread will sleep
 713                                   waiting for an instance to be deleted
 714         :param ssh_connect_timeout: the amount of time a thread will sleep
 715                                     waiting obtaining an SSH connection to a VM
 716         :param availability_zone: the name of the compute server on which to
 717                                   deploy the VM (optional)
 718         :param userdata: the cloud-init script to run after the VM has been
 719                          started
 720         """
 721         self.name = kwargs.get('name')
 722         self.flavor = kwargs.get('flavor')
 723         self.sudo_user = kwargs.get('sudo_user')
 724         self.userdata = kwargs.get('userdata')
 725
 726         self.port_settings = list()
 727         port_settings = kwargs.get('ports')
 728         if not port_settings:
 729             port_settings = kwargs.get('port_settings')
 730         if port_settings:
 731             for port_setting in port_settings:
 732                 if isinstance(port_setting, dict):
 733                     self.port_settings.append(PortSettings(**port_setting))
 734                 elif isinstance(port_setting, PortSettings):
 735                     self.port_settings.append(port_setting)
 736
 737         if kwargs.get('security_group_names'):
 738             if isinstance(kwargs['security_group_names'], list):
 739                 self.security_group_names = kwargs['security_group_names']
 740             elif isinstance(kwargs['security_group_names'], set):
 741                 self.security_group_names = kwargs['security_group_names']
 742             elif isinstance(kwargs['security_group_names'], str):
 743                 self.security_group_names = [kwargs['security_group_names']]
 744             else:
 745                 raise Exception(
 746                     'Invalid data type for security_group_names attribute')
 747         else:
 748             self.security_group_names = set()
 749
 750         self.floating_ip_settings = list()
 751         floating_ip_settings = kwargs.get('floating_ips')
 752         if not floating_ip_settings:
 753             floating_ip_settings = kwargs.get('floating_ip_settings')
 754         if floating_ip_settings:
 755             for floating_ip_config in floating_ip_settings:
 756                 if isinstance(floating_ip_config, FloatingIpSettings):
 757                     self.floating_ip_settings.append(floating_ip_config)
 758                 else:
 759                     self.floating_ip_settings.append(FloatingIpSettings(
 760                         **floating_ip_config['floating_ip']))
 761
 762         if kwargs.get('vm_boot_timeout'):
 763             self.vm_boot_timeout = kwargs['vm_boot_timeout']
 764         else:
 765             self.vm_boot_timeout = 900
 766
 767         if kwargs.get('vm_delete_timeout'):
 768             self.vm_delete_timeout = kwargs['vm_delete_timeout']
 769         else:
 770             self.vm_delete_timeout = 300
 771
 772         if kwargs.get('ssh_connect_timeout'):
 773             self.ssh_connect_timeout = kwargs['ssh_connect_timeout']
 774         else:
 775             self.ssh_connect_timeout = 180
 776
 777         if kwargs.get('availability_zone'):
 778             self.availability_zone = kwargs['availability_zone']
 779         else:
 780             self.availability_zone = None
 781
 782         if not self.name or not self.flavor:
 783             raise Exception(
 784                 'Instance configuration requires the attributes: name, flavor')
 785
 786         if len(self.port_settings) == 0:
 787             raise Exception(
 788                 'Instance configuration requires port settings (aka. NICS)')
 789
 790
 791 class FloatingIpSettings:
 792     """
 793     Class responsible for holding configuration settings for a floating IP
 794     """
 795
 796     def __init__(self, **kwargs):
 797         """
 798         Constructor
 799         :param name: the name of the floating IP
 800         :param port_name: the name of the router to the external network
 801         :param router_name: the name of the router to the external network
 802         :param subnet_name: the name of the subnet on which to attach the
 803                             floating IP
 804         :param provisioning: when true, this floating IP can be used for
 805                              provisioning
 806
 807         TODO - provisioning flag is a hack as I have only observed a single
 808         Floating IPs that actually works on an instance. Multiple floating IPs
 809         placed on different subnets from the same port are especially
 810         troublesome as you cannot predict which one will actually connect.
 811         For now, it is recommended not to setup multiple floating IPs on an
 812         instance unless absolutely necessary.
 813         """
 814         self.name = kwargs.get('name')
 815         self.port_name = kwargs.get('port_name')
 816         self.router_name = kwargs.get('router_name')
 817         self.subnet_name = kwargs.get('subnet_name')
 818         if kwargs.get('provisioning') is not None:
 819             self.provisioning = kwargs['provisioning']
 820         else:
 821             self.provisioning = True
 822
 823         if not self.name or not self.port_name or not self.router_name:
 824             raise Exception(
 825                 'The attributes name, port_name and router_name are required '
 826                 'for FloatingIPSettings')