-# Copyright (c) 2016 Cable Television Laboratories, Inc. ("CableLabs")
+# Copyright (c) 2017 Cable Television Laboratories, Inc. ("CableLabs")
# and others. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
-import os
+
import logging
-import keystone_utils
+import os
+from cryptography.hazmat.backends import default_backend
+from cryptography.hazmat.primitives import serialization
+from cryptography.hazmat.primitives.asymmetric import rsa
from novaclient.client import Client
from novaclient.exceptions import NotFound
+from snaps.domain.flavor import Flavor
+from snaps.domain.keypair import Keypair
+from snaps.domain.vm_inst import VmInst
+from snaps.openstack.utils import keystone_utils, glance_utils, neutron_utils
+
__author__ = 'spisarski'
logger = logging.getLogger('nova_utils')
def nova_client(os_creds):
"""
- Instantiates and returns a client for communications with OpenStack's Nova server
+ Instantiates and returns a client for communications with OpenStack's Nova
+ server
:param os_creds: The connection credentials to the OpenStack API
:return: the client object
"""
logger.debug('Retrieving Nova Client')
- return Client(os_creds.compute_api_version, session=keystone_utils.keystone_session(os_creds))
+ return Client(os_creds.compute_api_version,
+ session=keystone_utils.keystone_session(os_creds))
+
+
+def create_server(nova, neutron, glance, instance_settings, image_settings,
+ keypair_settings=None):
+ """
+ Creates a VM instance
+ :param nova: the nova client (required)
+ :param neutron: the neutron client for retrieving ports (required)
+ :param glance: the glance client (required)
+ :param instance_settings: the VM instance settings object (required)
+ :param image_settings: the VM's image settings object (required)
+ :param keypair_settings: the VM's keypair settings object (optional)
+ :return: a snaps.domain.VmInst object
+ """
+
+ ports = list()
+
+ for port_setting in instance_settings.port_settings:
+ ports.append(neutron_utils.get_port_by_name(
+ neutron, port_setting.name))
+ nics = []
+ for port in ports:
+ kv = dict()
+ kv['port-id'] = port['port']['id']
+ nics.append(kv)
+
+ logger.info('Creating VM with name - ' + instance_settings.name)
+ keypair_name = None
+ if keypair_settings:
+ keypair_name = keypair_settings.name
+
+ flavor = get_flavor_by_name(nova, instance_settings.flavor)
+ if not flavor:
+ raise Exception(
+ 'Flavor not found with name - %s',
+ instance_settings.flavor)
+
+ image = glance_utils.get_image(glance, image_settings.name)
+ if image:
+ args = {'name': instance_settings.name,
+ 'flavor': flavor,
+ 'image': image,
+ 'nics': nics,
+ 'key_name': keypair_name,
+ 'security_groups':
+ instance_settings.security_group_names,
+ 'userdata': instance_settings.userdata,
+ 'availability_zone':
+ instance_settings.availability_zone}
+ server = nova.servers.create(**args)
+ return VmInst(name=server.name, inst_id=server.id,
+ networks=server.networks)
+ else:
+ raise Exception(
+ 'Cannot create instance, image cannot be located with name %s',
+ image_settings.name)
def get_servers_by_name(nova, name):
:param name: the server name
:return: the list of servers
"""
- return nova.servers.list(search_opts={'name': name})
+ out = list()
+ servers = nova.servers.list(search_opts={'name': name})
+ for server in servers:
+ out.append(VmInst(name=server.name, inst_id=server.id,
+ networks=server.networks))
+ return out
+
+
+def get_latest_server_os_object(nova, server):
+ """
+ Returns a server with a given id
+ :param nova: the Nova client
+ :param server: the domain VmInst object
+ :return: the list of servers or None if not found
+ """
+ return nova.servers.get(server.id)
def get_latest_server_object(nova, server):
:param server: the old server object
:return: the list of servers or None if not found
"""
- return nova.servers.get(server)
+ server = get_latest_server_os_object(nova, server)
+ return VmInst(name=server.name, inst_id=server.id,
+ networks=server.networks)
+
+
+def create_keys(key_size=2048):
+ """
+ Generates public and private keys
+ :param key_size: the number of bytes for the key size
+ :return: the cryptography keys
+ """
+ return rsa.generate_private_key(backend=default_backend(),
+ public_exponent=65537,
+ key_size=key_size)
+
+
+def public_key_openssh(keys):
+ """
+ Returns the public key for OpenSSH
+ :param keys: the keys generated by create_keys() from cryptography
+ :return: the OpenSSH public key
+ """
+ return keys.public_key().public_bytes(serialization.Encoding.OpenSSH,
+ serialization.PublicFormat.OpenSSH)
def save_keys_to_files(keys=None, pub_file_path=None, priv_file_path=None):
"""
Saves the generated RSA generated keys to the filesystem
- :param keys: the keys to save
+ :param keys: the keys to save generated by cryptography
:param pub_file_path: the path to the public keys
:param priv_file_path: the path to the private keys
:return: None
"""
if keys:
if pub_file_path:
- pub_dir = os.path.dirname(pub_file_path)
+ # To support '~'
+ pub_expand_file = os.path.expanduser(pub_file_path)
+ pub_dir = os.path.dirname(pub_expand_file)
+
if not os.path.isdir(pub_dir):
os.mkdir(pub_dir)
- public_handle = open(pub_file_path, 'wb')
- public_handle.write(keys.publickey().exportKey('OpenSSH'))
+ public_handle = open(pub_expand_file, 'wb')
+ public_bytes = keys.public_key().public_bytes(
+ serialization.Encoding.OpenSSH,
+ serialization.PublicFormat.OpenSSH)
+ public_handle.write(public_bytes)
public_handle.close()
- os.chmod(pub_file_path, 0o400)
- logger.info("Saved public key to - " + pub_file_path)
+ os.chmod(pub_expand_file, 0o400)
+ logger.info("Saved public key to - " + pub_expand_file)
if priv_file_path:
- priv_dir = os.path.dirname(priv_file_path)
+ # To support '~'
+ priv_expand_file = os.path.expanduser(priv_file_path)
+ priv_dir = os.path.dirname(priv_expand_file)
if not os.path.isdir(priv_dir):
os.mkdir(priv_dir)
- private_handle = open(priv_file_path, 'wb')
- private_handle.write(keys.exportKey())
+ private_handle = open(priv_expand_file, 'wb')
+ private_handle.write(
+ keys.private_bytes(
+ encoding=serialization.Encoding.PEM,
+ format=serialization.PrivateFormat.TraditionalOpenSSL,
+ encryption_algorithm=serialization.NoEncryption()))
private_handle.close()
- os.chmod(priv_file_path, 0o400)
- logger.info("Saved private key to - " + priv_file_path)
+ os.chmod(priv_expand_file, 0o400)
+ logger.info("Saved private key to - " + priv_expand_file)
def upload_keypair_file(nova, name, file_path):
:param file_path: the path to the public key file
:return: the keypair object
"""
- with open(os.path.expanduser(file_path)) as fpubkey:
+ with open(os.path.expanduser(file_path), 'rb') as fpubkey:
logger.info('Saving keypair to - ' + file_path)
return upload_keypair(nova, name, fpubkey.read())
:return: the keypair object
"""
logger.info('Creating keypair with name - ' + name)
- return nova.keypairs.create(name=name, public_key=key)
+ os_kp = nova.keypairs.create(name=name, public_key=key.decode('utf-8'))
+ return Keypair(name=os_kp.name, id=os_kp.id, public_key=os_kp.public_key)
def keypair_exists(nova, keypair_obj):
:return: the keypair object or None if not found
"""
try:
- return nova.keypairs.get(keypair_obj)
+ os_kp = nova.keypairs.get(keypair_obj)
+ return Keypair(name=os_kp.name, id=os_kp.id,
+ public_key=os_kp.public_key)
except:
return None
for keypair in keypairs:
if keypair.name == name:
- return keypair
+ return Keypair(name=keypair.name, id=keypair.id,
+ public_key=keypair.public_key)
return None
"""
Deletes a keypair object from OpenStack
:param nova: the Nova client
- :param key: the keypair object to delete
+ :param key: the SNAPS-OO keypair domain object to delete
"""
logger.debug('Deleting keypair - ' + key.name)
- nova.keypairs.delete(key)
+ nova.keypairs.delete(key.id)
-def get_floating_ip_pools(nova):
+def get_nova_availability_zones(nova):
"""
- Returns all of the available floating IP pools
+ Returns the names of all nova active compute servers
:param nova: the Nova client
- :return: a list of pools
+ :return: a list of compute server names
"""
- return nova.floating_ip_pools.list()
-
+ out = list()
+ zones = nova.availability_zones.list()
+ for zone in zones:
+ if zone.zoneName == 'nova':
+ for key, host in zone.hosts.items():
+ if host['nova-compute']['available']:
+ out.append(zone.zoneName + ':' + key)
-def get_floating_ips(nova):
- """
- Returns all of the floating IPs
- :param nova: the Nova client
- :return: a list of floating IPs
- """
- return nova.floating_ips.list()
+ return out
-def create_floating_ip(nova, ext_net_name):
+def delete_vm_instance(nova, vm_inst):
"""
- Returns the floating IP object that was created with this call
- :param nova: the Nova client
- :param ext_net_name: the name of the external network on which to apply the floating IP address
- :return: the floating IP object
+ Deletes a VM instance
+ :param nova: the nova client
+ :param vm_inst: the snaps.domain.VmInst object
"""
- logger.info('Creating floating ip to external network - ' + ext_net_name)
- return nova.floating_ips.create(ext_net_name)
+ nova.servers.delete(vm_inst.id)
-def get_floating_ip(nova, floating_ip):
+def get_os_flavor(nova, flavor):
"""
- Returns a floating IP object that should be identical to the floating_ip parameter
+ Returns to OpenStack flavor object by name
:param nova: the Nova client
- :param floating_ip: the floating IP object to lookup
- :return: hopefully the same floating IP object input
+ :param flavor: the SNAPS flavor domain object
+ :return: the OpenStack Flavor object
"""
- logger.debug('Attempting to retrieve existing floating ip with IP - ' + floating_ip.ip)
- return nova.floating_ips.get(floating_ip)
+ try:
+ return nova.flavors.get(flavor.id)
+ except NotFound:
+ return None
-def delete_floating_ip(nova, floating_ip):
+def get_flavor(nova, flavor):
"""
- Responsible for deleting a floating IP
+ Returns to OpenStack flavor object by name
:param nova: the Nova client
- :param floating_ip: the floating IP object to delete
- :return:
- """
- logger.debug('Attempting to delete existing floating ip with IP - ' + floating_ip.ip)
- return nova.floating_ips.delete(floating_ip)
+ :param flavor: the SNAPS flavor domain object
+ :return: the SNAPS Flavor domain object
+ """
+ os_flavor = get_os_flavor(nova, flavor)
+ if os_flavor:
+ return Flavor(
+ name=os_flavor.name, id=os_flavor.id, ram=os_flavor.ram,
+ disk=os_flavor.disk, vcpus=os_flavor.vcpus,
+ ephemeral=os_flavor.ephemeral, swap=os_flavor.swap,
+ rxtx_factor=os_flavor.rxtx_factor, is_public=os_flavor.is_public)
+ try:
+ return nova.flavors.get(flavor.id)
+ except NotFound:
+ return None
-def get_nova_availability_zones(nova):
+def get_os_flavor_by_name(nova, name):
"""
- Returns the names of all nova compute servers
+ Returns to OpenStack flavor object by name
:param nova: the Nova client
- :return: a list of compute server names
- """
- out = list()
- zones = nova.availability_zones.list()
- for zone in zones:
- if zone.zoneName == 'nova':
- for key, host in zone.hosts.iteritems():
- out.append(zone.zoneName + ':' + key)
-
- return out
-
-
-def delete_vm_instance(nova, vm_inst):
- """
- Deletes a VM instance
- :param nova: the nova client
- :param vm_inst: the OpenStack instance object to delete
+ :param name: the name of the flavor to query
+ :return: OpenStack flavor object
"""
- nova.servers.delete(vm_inst)
+ try:
+ return nova.flavors.find(name=name)
+ except NotFound:
+ return None
def get_flavor_by_name(nova, name):
Returns a flavor by name
:param nova: the Nova client
:param name: the flavor name to return
- :return: the OpenStack flavor object or None if not exists
+ :return: the SNAPS flavor domain object or None if not exists
"""
- try:
- return nova.flavors.find(name=name)
- except NotFound:
- return None
+ os_flavor = get_os_flavor_by_name(nova, name)
+ if os_flavor:
+ return Flavor(
+ name=os_flavor.name, id=os_flavor.id, ram=os_flavor.ram,
+ disk=os_flavor.disk, vcpus=os_flavor.vcpus,
+ ephemeral=os_flavor.ephemeral, swap=os_flavor.swap,
+ rxtx_factor=os_flavor.rxtx_factor, is_public=os_flavor.is_public)
def create_flavor(nova, flavor_settings):
Creates and returns and OpenStack flavor object
:param nova: the Nova client
:param flavor_settings: the flavor settings
- :return: the Flavor
+ :return: the SNAPS flavor domain object
"""
- return nova.flavors.create(name=flavor_settings.name, flavorid=flavor_settings.flavor_id, ram=flavor_settings.ram,
- vcpus=flavor_settings.vcpus, disk=flavor_settings.disk,
- ephemeral=flavor_settings.ephemeral, swap=flavor_settings.swap,
- rxtx_factor=flavor_settings.rxtx_factor, is_public=flavor_settings.is_public)
+ os_flavor = nova.flavors.create(
+ name=flavor_settings.name, flavorid=flavor_settings.flavor_id,
+ ram=flavor_settings.ram, vcpus=flavor_settings.vcpus,
+ disk=flavor_settings.disk, ephemeral=flavor_settings.ephemeral,
+ swap=flavor_settings.swap, rxtx_factor=flavor_settings.rxtx_factor,
+ is_public=flavor_settings.is_public)
+ return Flavor(
+ name=os_flavor.name, id=os_flavor.id, ram=os_flavor.ram,
+ disk=os_flavor.disk, vcpus=os_flavor.vcpus,
+ ephemeral=os_flavor.ephemeral, swap=os_flavor.swap,
+ rxtx_factor=os_flavor.rxtx_factor, is_public=os_flavor.is_public)
def delete_flavor(nova, flavor):
"""
Deletes a flavor
:param nova: the Nova client
- :param flavor: the OpenStack flavor object
+ :param flavor: the SNAPS flavor domain object
"""
- nova.flavors.delete(flavor)
+ nova.flavors.delete(flavor.id)
+
+
+def set_flavor_keys(nova, flavor, metadata):
+ """
+ Sets metadata on the flavor
+ :param nova: the Nova client
+ :param flavor: the SNAPS flavor domain object
+ :param metadata: the metadata to set
+ """
+ os_flavor = get_os_flavor(nova, flavor)
+ if os_flavor:
+ os_flavor.set_keys(metadata)
def add_security_group(nova, vm, security_group_name):
Removes a security group from an existing VM
:param nova: the nova client
:param vm: the OpenStack server object (VM) to alter
- :param security_group: the OpenStack security group object to add
+ :param security_group: the SNAPS SecurityGroup domain object to add
+ """
+ nova.servers.remove_security_group(str(vm.id), security_group.name)
+
+
+def add_floating_ip_to_server(nova, vm, floating_ip, ip_addr):
+ """
+ Adds a floating IP to a server instance
+ :param nova: the nova client
+ :param vm: VmInst domain object
+ :param floating_ip: FloatingIp domain object
+ :param ip_addr: the IP to which to bind the floating IP to
"""
- nova.servers.remove_security_group(str(vm.id), security_group['security_group']['name'])
+ vm = get_latest_server_os_object(nova, vm)
+ vm.add_floating_ip(floating_ip.ip, ip_addr)