1 # Copyright (c) 2017 Cable Television Laboratories, Inc. ("CableLabs")
2 # and others. All rights reserved.
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:
8 # http://www.apache.org/licenses/LICENSE-2.0
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.
18 from novaclient.exceptions import NotFound
20 from snaps.config.vm_inst import VmInstanceConfig, FloatingIpConfig
21 from snaps.openstack.openstack_creator import OpenStackComputeObject
22 from snaps.openstack.utils import (
23 glance_utils, cinder_utils, settings_utils, keystone_utils)
24 from snaps.openstack.utils import neutron_utils
25 from snaps.openstack.utils import nova_utils
26 from snaps.openstack.utils.nova_utils import RebootType
27 from snaps.provisioning import ansible_utils
29 __author__ = 'spisarski'
31 logger = logging.getLogger('create_instance')
34 STATUS_ACTIVE = 'ACTIVE'
35 STATUS_DELETED = 'DELETED'
38 class OpenStackVmInstance(OpenStackComputeObject):
40 Class responsible for managing a VM instance in OpenStack
43 def __init__(self, os_creds, instance_settings, image_settings,
44 keypair_settings=None):
47 :param os_creds: The connection credentials to the OpenStack API
48 :param instance_settings: Contains the settings for this VM
49 :param image_settings: The OpenStack image object settings
50 :param keypair_settings: The keypair metadata (Optional)
53 super(self.__class__, self).__init__(os_creds)
57 self.instance_settings = instance_settings
58 self.image_settings = image_settings
59 self.keypair_settings = keypair_settings
61 self.__floating_ip_dict = dict()
63 # Instantiated in self.create()
66 # Note: this object does not change after the VM becomes active
71 Loads the existing VMInst, Port, FloatingIps
72 :return: VMInst domain object
74 super(self.__class__, self).initialize()
76 self.__neutron = neutron_utils.neutron_client(self._os_creds)
77 self.__keystone = keystone_utils.keystone_client(self._os_creds)
79 self.__ports = self.__query_ports(self.instance_settings.port_settings)
80 self.__lookup_existing_vm_by_name()
82 def create(self, block=False):
84 Creates a VM instance and associated objects unless they already exist
85 :param block: Thread will block until instance has either become
86 active, error, or timeout waiting.
87 Additionally, when True, floating IPs will not be applied
89 :return: VMInst domain object
93 if len(self.__ports) == 0:
94 self.__ports = self.__create_ports(
95 self.instance_settings.port_settings)
97 self.__create_vm(block)
101 def __lookup_existing_vm_by_name(self):
103 Populates the member variables 'self.vm' and 'self.floating_ips' if a
104 VM with the same name already exists
107 server = nova_utils.get_server(
108 self._nova, self.__neutron, self.__keystone,
109 vm_inst_settings=self.instance_settings)
111 if server.name == self.instance_settings.name:
114 'Found existing machine with name - %s',
115 self.instance_settings.name)
117 fips = neutron_utils.get_port_floating_ips(
118 self.__neutron, self.__ports)
119 for port_id, fip in fips:
120 settings = self.instance_settings.floating_ip_settings
121 for fip_setting in settings:
122 if port_id == fip_setting.port_id:
123 self.__floating_ip_dict[fip_setting.name] = fip
125 port = neutron_utils.get_port_by_id(
126 self.__neutron, port_id)
127 if port and port.name == fip_setting.port_name:
128 self.__floating_ip_dict[fip_setting.name] = fip
130 def __create_vm(self, block=False):
132 Responsible for creating the VM instance
133 :param block: Thread will block until instance has either become
134 active, error, or timeout waiting. Floating IPs will be
135 assigned after active when block=True
137 glance = glance_utils.glance_client(self._os_creds)
138 self.__vm = nova_utils.create_server(
139 self._nova, self.__keystone, self.__neutron, glance,
140 self.instance_settings, self.image_settings,
141 self._os_creds.project_name, self.keypair_settings)
142 logger.info('Created instance with name - %s',
143 self.instance_settings.name)
146 if not self.vm_active(block=True):
147 raise VmInstanceCreationError(
148 'Fatal error, VM did not become ACTIVE within the alloted '
151 # Create server should do this but found it needed to occur here
152 for sec_grp_name in self.instance_settings.security_group_names:
153 if self.vm_active(block=True):
154 nova_utils.add_security_group(self._nova, self.__vm,
157 raise VmInstanceCreationError(
158 'Cannot applying security group with name ' +
160 ' to VM that did not activate with name - ' +
161 self.instance_settings.name)
163 if self.instance_settings.volume_names:
164 for volume_name in self.instance_settings.volume_names:
165 cinder = cinder_utils.cinder_client(self._os_creds)
166 volume = cinder_utils.get_volume(
167 cinder, self.__keystone, volume_name=volume_name,
168 project_name=self._os_creds.project_name)
170 if volume and self.vm_active(block=True):
171 vm = nova_utils.attach_volume(
172 self._nova, self.__neutron, self.__keystone, self.__vm,
173 volume, self._os_creds.project_name)
179 'Volume [%s] attachment timeout ', volume.name)
181 logger.warn('Unable to attach volume named [%s]',
184 self.__apply_floating_ips()
186 def __apply_floating_ips(self):
188 Applies the configured floating IPs to the necessary ports
191 for key, port in self.__ports:
192 port_dict[key] = port
195 for floating_ip_setting in self.instance_settings.floating_ip_settings:
196 self.add_floating_ip(floating_ip_setting)
198 def add_floating_ip(self, floating_ip_setting):
200 Adds a floating IP to a running instance
201 :param floating_ip_setting - the floating IP configuration
202 :return: the floating ip object
205 for key, port in self.__ports:
206 port_dict[key] = port
209 port = port_dict.get(floating_ip_setting.port_name)
212 raise VmInstanceCreationError(
213 'Cannot find port object with name - ' +
214 floating_ip_setting.port_name)
216 # Setup Floating IP only if there is a router with an external
218 ext_gateway = self.__ext_gateway_by_router(
219 floating_ip_setting.router_name)
220 if ext_gateway and self.vm_active(block=True):
221 floating_ip = neutron_utils.create_floating_ip(
222 self.__neutron, self.__keystone, ext_gateway, port.id)
223 self.__floating_ip_dict[floating_ip_setting.name] = floating_ip
226 'Created floating IP %s via router - %s', floating_ip.ip,
227 floating_ip_setting.router_name)
231 raise VmInstanceCreationError(
232 'Unable to add floating IP to port, cannot locate router '
233 'with an external gateway ')
235 def __ext_gateway_by_router(self, router_name):
237 Returns network name for the external network attached to a router or
239 :param router_name: The name of the router to lookup
240 :return: the external network name or None
242 router = neutron_utils.get_router(
243 self.__neutron, self.__keystone, router_name=router_name,
244 project_name=self._os_creds.project_name)
245 if router and router.external_network_id:
246 network = neutron_utils.get_network_by_id(
247 self.__neutron, router.external_network_id)
254 Destroys the VM instance
257 # Cleanup floating IPs
258 for name, floating_ip in self.__floating_ip_dict.items():
259 logger.info('Deleting Floating IP - ' + floating_ip.ip)
260 neutron_utils.delete_floating_ip(self.__neutron, floating_ip)
262 self.__floating_ip_dict = dict()
265 for name, port in self.__ports:
266 logger.info('Deleting Port with ID - %s ', port.id)
267 neutron_utils.delete_port(self.__neutron, port)
269 self.__ports = list()
273 for volume_rec in self.__vm.volume_ids:
274 cinder = cinder_utils.cinder_client(self._os_creds)
275 volume = cinder_utils.get_volume_by_id(
276 cinder, volume_rec['id'])
278 vm = nova_utils.detach_volume(
279 self._nova, self.__neutron, self.__keystone, self.__vm,
280 volume, self._os_creds.project_name)
285 'Timeout waiting to detach volume %s', volume.name)
287 logger.warn('Unable to detach volume with ID - [%s]',
292 'Deleting VM instance - ' + self.instance_settings.name)
295 nova_utils.delete_vm_instance(self._nova, self.__vm)
296 except NotFound as e:
297 logger.warn('Instance already deleted - %s', e)
299 # Block until instance cannot be found or returns the status of
301 logger.info('Checking deletion status')
303 if self.vm_deleted(block=True):
305 'VM has been properly deleted VM with name - %s',
306 self.instance_settings.name)
310 'VM not deleted within the timeout period of %s '
311 'seconds', self.instance_settings.vm_delete_timeout)
313 def __query_ports(self, port_settings):
315 Returns the previously configured ports or an empty list if none
317 :param port_settings: A list of PortSetting objects
318 :return: a list of OpenStack port tuples where the first member is the
319 port name and the second is the port object
323 for port_setting in port_settings:
324 port = neutron_utils.get_port(
325 self.__neutron, self.__keystone, port_settings=port_setting,
326 project_name=self._os_creds.project_name)
328 ports.append((port_setting.name, port))
332 def __create_ports(self, port_settings):
334 Returns the previously configured ports or creates them if they do not
336 :param port_settings: A list of PortSetting objects
337 :return: a list of OpenStack port tuples where the first member is the
338 port name and the second is the port object
342 for port_setting in port_settings:
343 port = neutron_utils.get_port(
344 self.__neutron, self.__keystone, port_settings=port_setting)
346 port = neutron_utils.create_port(
347 self.__neutron, self._os_creds, port_setting)
349 ports.append((port_setting.name, port))
353 def get_os_creds(self):
355 Returns the OpenStack credentials used to create these objects
356 :return: the credentials
358 return self._os_creds
360 def get_vm_inst(self):
362 Returns the latest version of this server object from OpenStack
363 :return: Server object
365 return nova_utils.get_server_object_by_id(
366 self._nova, self.__neutron, self.__keystone, self.__vm.id,
367 self._os_creds.project_name)
369 def get_console_output(self):
371 Returns the vm console object for parsing logs
372 :return: the console output object
374 return nova_utils.get_server_console_output(self._nova, self.__vm)
376 def get_port_ip(self, port_name, subnet_name=None):
378 Returns the first IP for the port corresponding with the port_name
379 parameter when subnet_name is None else returns the IP address that
380 corresponds to the subnet_name parameter
381 :param port_name: the name of the port from which to return the IP
382 :param subnet_name: the name of the subnet attached to this IP
383 :return: the IP or None if not found
385 port = self.get_port_by_name(port_name)
388 subnet = neutron_utils.get_subnet(
389 self.__neutron, subnet_name=subnet_name)
391 logger.warning('Cannot retrieve port IP as subnet could '
392 'not be located with name - %s',
395 for fixed_ip in port.ips:
396 if fixed_ip['subnet_id'] == subnet.id:
397 return fixed_ip['ip_address']
399 if port.ips and len(port.ips) > 0:
400 return port.ips[0]['ip_address']
403 def get_port_mac(self, port_name):
405 Returns the first IP for the port corresponding with the port_name
407 TODO - Add in the subnet as an additional parameter as a port may have
409 :param port_name: the name of the port from which to return the IP
410 :return: the IP or None if not found
412 port = self.get_port_by_name(port_name)
414 return port.mac_address
417 def get_port_by_name(self, port_name):
419 Retrieves the OpenStack port object by its given name
420 :param port_name: the name of the port
421 :return: the OpenStack port object or None if not exists
423 for key, port in self.__ports:
426 logger.warning('Cannot find port with name - ' + port_name)
429 def get_vm_info(self):
431 Returns a dictionary of a VMs info as returned by OpenStack
434 from warnings import warn
435 warn('Do not use the returned dict() structure',
438 return nova_utils.get_server_info(self._nova, self.__vm)
440 def __get_first_provisioning_floating_ip(self):
442 Returns the first floating IP tagged with the Floating IP name if
443 exists else the first one found
446 for floating_ip_setting in self.instance_settings.floating_ip_settings:
447 if floating_ip_setting.provisioning:
448 fip = self.__floating_ip_dict.get(floating_ip_setting.name)
451 elif len(self.__floating_ip_dict) > 0:
452 for key, fip in self.__floating_ip_dict.items():
455 # When cannot be found above
456 if len(self.__floating_ip_dict) > 0:
457 for key, fip in self.__floating_ip_dict.items():
460 def apply_ansible_playbook(self, pb_file_loc, variables=None,
463 Applies a playbook to a VM
464 :param pb_file_loc: the file location of the playbook to be applied
465 :param variables: a dict() of substitution values required by the
467 :param fip_name: the name of the floating IP to use for applying the
468 playbook (default - will take the first)
469 :return: the return value from ansible
471 return ansible_utils.apply_playbook(
472 pb_file_loc, [self.get_floating_ip(fip_name=fip_name).ip],
473 self.get_image_user(),
474 ssh_priv_key_file_path=self.keypair_settings.private_filepath,
475 variables=variables, proxy_setting=self._os_creds.proxy_settings)
477 def get_image_user(self):
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
482 if self.instance_settings.sudo_user:
483 return self.instance_settings.sudo_user
485 return self.image_settings.image_user
487 def vm_deleted(self, block=False, poll_interval=POLL_INTERVAL):
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
497 return self.__vm_status_check(
498 STATUS_DELETED, block,
499 self.instance_settings.vm_delete_timeout, poll_interval)
500 except NotFound as e:
502 "Instance not found when querying status for %s with message "
503 "%s", STATUS_DELETED, e)
506 def vm_active(self, block=False, poll_interval=POLL_INTERVAL):
508 Returns true when the VM status returns the value of the constant
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
515 if self.__vm_status_check(
516 STATUS_ACTIVE, block, self.instance_settings.vm_boot_timeout,
518 self.__vm = nova_utils.get_server_object_by_id(
519 self._nova, self.__neutron, self.__keystone, self.__vm.id,
520 self._os_creds.project_name)
524 def __vm_status_check(self, expected_status_code, block, timeout,
527 Returns true when the VM status returns the value of
529 :param expected_status_code: instance status evaluated with this
531 :param block: When true, thread will block until active or timeout
532 value in seconds has been exceeded (False)
533 :param timeout: The timeout value
534 :param poll_interval: The polling interval in seconds
537 # sleep and wait for VM status change
541 return self.__status(expected_status_code)
543 while timeout > time.time() - start:
544 status = self.__status(expected_status_code)
546 logger.info('VM is - ' + expected_status_code)
549 logger.debug('Retry querying VM status in ' + str(
550 poll_interval) + ' seconds')
551 time.sleep(poll_interval)
552 logger.debug('VM status query timeout in ' + str(
553 timeout - (time.time() - start)))
556 'Timeout checking for VM status for ' + expected_status_code)
559 def __status(self, expected_status_code):
561 Returns True when active else False
562 :param expected_status_code: instance status evaluated with this string
567 if expected_status_code == STATUS_DELETED:
572 status = nova_utils.get_server_status(self._nova, self.__vm)
574 logger.warning('Cannot find instance with id - ' + self.__vm.id)
577 if status == 'ERROR':
578 raise VmInstanceCreationError(
579 'Instance had an error during deployment')
581 'Instance status [%s] is - %s', self.instance_settings.name,
583 return status == expected_status_code
585 def vm_ssh_active(self, user_override=None, password=None, block=False,
586 timeout=None, poll_interval=POLL_INTERVAL):
588 Returns true when the VM can be accessed via SSH
589 :param user_override: overrides the user with which to create the
591 :param password: overrides the use of a password instead of a private
592 key with which to create the connection
593 :param block: When true, thread will block until active or timeout
594 value in seconds has been exceeded (False)
595 :param timeout: the number of seconds to retry obtaining the connection
596 and overrides the ssh_connect_timeout member of the
597 self.instance_settings object
598 :param poll_interval: The polling interval
601 # sleep and wait for VM status change
602 logger.info('Checking if VM is active')
605 timeout = self.instance_settings.ssh_connect_timeout
607 if self.vm_active(block=True):
611 start = time.time() - timeout
613 while timeout > time.time() - start:
614 status = self.__ssh_active(
615 user_override=user_override, password=password)
617 logger.info('SSH is active for VM instance')
620 logger.debug('Retry SSH connection in ' + str(
621 poll_interval) + ' seconds')
622 time.sleep(poll_interval)
623 logger.debug('SSH connection timeout in ' + str(
624 timeout - (time.time() - start)))
626 logger.error('Timeout attempting to connect with VM via SSH')
629 def __ssh_active(self, user_override=None, password=None):
631 Returns True when can create a SSH session else False
634 if len(self.__floating_ip_dict) > 0:
635 ssh = self.ssh_client(
636 user_override=user_override, password=password)
642 def cloud_init_complete(self, block=False, poll_interval=POLL_INTERVAL):
644 Returns true when the VM's cloud-init routine has completed.
645 Note: this is currently done via SSH, therefore, if this instance does
646 not have a Floating IP or a running SSH server, this routine
647 will always return False or raise an Exception
648 :param block: When true, thread will block until active or timeout
649 value in seconds has been exceeded (False)
650 :param poll_interval: The polling interval
653 # sleep and wait for VM status change
654 logger.info('Checking if cloud-init has completed')
656 timeout = self.instance_settings.cloud_init_timeout
658 if self.vm_active(block=True) and self.vm_ssh_active(block=True):
662 start = time.time() - timeout
664 while timeout > time.time() - start:
665 status = self.__cloud_init_complete()
667 logger.info('cloud-init complete for VM instance')
670 logger.debug('Retry cloud-init query in ' + str(
671 poll_interval) + ' seconds')
672 time.sleep(poll_interval)
673 logger.debug('cloud-init complete timeout in ' + str(
674 timeout - (time.time() - start)))
676 logger.error('Timeout waiting for cloud-init to complete')
679 def __cloud_init_complete(self):
681 Returns True when can create a SSH session else False
684 if len(self.__floating_ip_dict) > 0:
685 ssh = self.ssh_client()
687 stdin1, stdout1, sterr1 = ssh.exec_command(
688 'ls -l /var/lib/cloud/instance/boot-finished')
689 return stdout1.channel.recv_exit_status() == 0
692 def get_floating_ip(self, fip_name=None):
694 Returns the floating IP object byt name if found, else the first known,
696 :param fip_name: the name of the floating IP to return
697 :return: the SSH client or None
699 if fip_name and self.__floating_ip_dict.get(fip_name):
700 return self.__floating_ip_dict.get(fip_name)
702 return self.__get_first_provisioning_floating_ip()
704 def ssh_client(self, fip_name=None, user_override=None, password=None):
706 Returns an SSH client using the name or the first known floating IP if
708 :param fip_name: the name of the floating IP to return
709 :param user_override: the username to use instead of the default
710 :param password: the password to use instead of the private key
711 :return: the SSH client or None
713 fip = self.get_floating_ip(fip_name)
715 ansible_user = self.get_image_user()
717 ansible_user = user_override
722 private_key = self.keypair_settings.private_filepath
725 return ansible_utils.ssh_client(
726 self.__get_first_provisioning_floating_ip().ip,
728 private_key_filepath=private_key,
730 proxy_settings=self._os_creds.proxy_settings)
732 FloatingIPAllocationError(
733 'Cannot return an SSH client. No Floating IP configured')
735 def add_security_group(self, security_group):
737 Adds a security group to this VM. Call will block until VM is active.
738 :param security_group: the SNAPS SecurityGroup domain object
739 :return True if successful else False
741 self.vm_active(block=True)
743 if not security_group:
744 logger.warning('Security group object is None, cannot add')
748 nova_utils.add_security_group(self._nova, self.get_vm_inst(),
751 except NotFound as e:
752 logger.warning('Security group not added - ' + str(e))
755 def remove_security_group(self, security_group):
757 Removes a security group to this VM. Call will block until VM is active
758 :param security_group: the OpenStack security group object
759 :return True if successful else False
761 self.vm_active(block=True)
763 if not security_group:
764 logger.warning('Security group object is None, cannot remove')
768 nova_utils.remove_security_group(self._nova, self.get_vm_inst(),
771 except NotFound as e:
772 logger.warning('Security group not removed - ' + str(e))
775 def reboot(self, reboot_type=RebootType.soft):
778 :param reboot_type: instance of
779 snaps.openstack.utils.nova_utils.RebootType
783 nova_utils.reboot_server(
784 self._nova, self.__vm, reboot_type=reboot_type)
787 def generate_creator(os_creds, vm_inst, image_config, project_name,
788 keypair_config=None):
790 Initializes an OpenStackVmInstance object
791 :param os_creds: the OpenStack credentials
792 :param vm_inst: the SNAPS-OO VmInst domain object
793 :param image_config: the associated ImageConfig object
794 :param project_name: the associated project ID
795 :param keypair_config: the associated KeypairConfig object (optional)
796 :return: an initialized OpenStackVmInstance object
798 nova = nova_utils.nova_client(os_creds)
799 keystone = keystone_utils.keystone_client(os_creds)
800 neutron = neutron_utils.neutron_client(os_creds)
801 derived_inst_config = settings_utils.create_vm_inst_config(
802 nova, keystone, neutron, vm_inst, project_name)
804 derived_inst_creator = OpenStackVmInstance(
805 os_creds, derived_inst_config, image_config, keypair_config)
806 derived_inst_creator.initialize()
807 return derived_inst_creator
810 class VmInstanceSettings(VmInstanceConfig):
812 Deprecated, use snaps.config.vm_inst.VmInstanceConfig instead
814 def __init__(self, **kwargs):
815 from warnings import warn
816 warn('Use snaps.config.vm_inst.VmInstanceConfig instead',
818 super(self.__class__, self).__init__(**kwargs)
821 class FloatingIpSettings(FloatingIpConfig):
823 Deprecated, use snaps.config.vm_inst.FloatingIpConfig instead
825 def __init__(self, **kwargs):
826 from warnings import warn
827 warn('Use snaps.config.vm_inst.FloatingIpConfig instead',
829 super(self.__class__, self).__init__(**kwargs)
832 class VmInstanceCreationError(Exception):
834 Exception to be thrown when an VM instance cannot be created
838 class FloatingIPAllocationError(Exception):
840 Exception to be thrown when an VM instance cannot allocate a floating IP