dynamicweb/opennebula_api/models.py

691 lines
24 KiB
Python
Raw Normal View History

2017-05-12 17:13:18 +00:00
import logging
import socket
2017-05-12 17:13:18 +00:00
import oca
from django.conf import settings
from oca.exceptions import OpenNebulaException
from oca.pool import WrongNameError, WrongIdError
from hosting.models import HostingOrder
from utils.models import CustomUser
2017-08-31 21:03:31 +00:00
from utils.tasks import save_ssh_key, save_ssh_key_error_handler
from .exceptions import KeyExistsError, UserExistsError, UserCredentialError
2017-05-31 16:01:54 +00:00
2017-05-12 17:13:18 +00:00
logger = logging.getLogger(__name__)
2017-05-10 02:06:12 +00:00
class OpenNebulaManager():
"""This class represents an opennebula manager."""
def __init__(self, email=None, password=None):
self.email = email
self.password = password
# Get oneadmin client
self.oneadmin_client = self._get_opennebula_client(
settings.OPENNEBULA_USERNAME,
settings.OPENNEBULA_PASSWORD
)
# Get or create oppenebula user using given credentials
try:
self.opennebula_user = self._get_or_create_user(
email,
password
)
# If opennebula user was created/obtained, get his client
self.client = self._get_opennebula_client(
email,
password
)
except:
pass
2017-05-31 16:01:54 +00:00
def _get_client(self, user):
"""Get a opennebula client object for a CustomUser object
2017-05-31 16:01:54 +00:00
Args:
user (CustomUser): dynamicweb CustomUser object
Returns:
oca.Client: Opennebula client object
Raise:
ConnectionError: If the connection to the opennebula server can't be
established
2017-05-31 16:01:54 +00:00
"""
2018-07-01 09:17:45 +00:00
return self._get_opennebula_client(user.email, user.password)
def _get_opennebula_client(self, username, password):
2018-07-01 09:17:45 +00:00
return oca.Client(
"{0}:{1}".format(username, password),
"{protocol}://{domain}:{port}{endpoint}".format(
protocol=settings.OPENNEBULA_PROTOCOL,
domain=settings.OPENNEBULA_DOMAIN,
port=settings.OPENNEBULA_PORT,
endpoint=settings.OPENNEBULA_ENDPOINT
2018-07-01 09:17:45 +00:00
)
)
2017-05-31 16:01:54 +00:00
def _get_user(self, user):
"""Get the corresponding opennebula user for a CustomUser object
2017-05-31 16:01:54 +00:00
Args:
user (CustomUser): dynamicweb CustomUser object
Returns:
oca.User: Opennebula user object
Raise:
WrongNameError: If no openebula user with this credentials exists
ConnectionError: If the connection to the opennebula server can't be
established
2017-05-31 16:01:54 +00:00
"""
user_pool = self._get_user_pool()
return user_pool.get_by_name(user.email)
def create_user(self, user: CustomUser):
"""Create a new opennebula user or a corresponding CustomUser object
2017-05-31 16:01:54 +00:00
Args:
user (CustomUser): dynamicweb CustomUser object
Returns:
int: Return the opennebula user id
2017-05-31 16:01:54 +00:00
Raises:
ConnectionError: If the connection to the opennebula server can't be
established
2017-05-31 16:01:54 +00:00
UserExistsError: If a user with this credeintals already exits on the
server
UserCredentialError: If a user with this email exists but the
password is worng
"""
try:
self._get_user(user)
try:
2017-05-31 16:01:54 +00:00
self._get_client(self, user)
logger.debug('User already exists')
raise UserExistsError()
except OpenNebulaException as err:
logger.error('OpenNebulaException error: {0}'.format(err))
logger.error('User exists but password is wrong')
2017-05-31 16:01:54 +00:00
raise UserCredentialError()
except WrongNameError:
user_id = self.oneadmin_client.call(oca.User.METHODS['allocate'],
user.email, user.password,
'core')
logger.debug(
'Created a user for CustomObject: {user} with user id = {u_id}',
user=user,
u_id=user_id
)
return user_id
2017-05-31 16:01:54 +00:00
except ConnectionRefusedError:
logger.error(
'Could not connect to host: {host} via protocol {protocol}'.format(
host=settings.OPENNEBULA_DOMAIN,
protocol=settings.OPENNEBULA_PROTOCOL)
2017-05-31 16:01:54 +00:00
)
raise ConnectionRefusedError
def _get_or_create_user(self, email, password):
try:
2017-05-09 22:39:41 +00:00
user_pool = self._get_user_pool()
opennebula_user = user_pool.get_by_name(email)
return opennebula_user
except WrongNameError as wrong_name_err:
opennebula_user = self.oneadmin_client.call(
oca.User.METHODS['allocate'], email,
password, 'core')
logger.debug(
2017-09-23 20:33:48 +00:00
"User {} does not exist. Created the user. User id = {}".format(
2017-09-27 23:27:40 +00:00
email,
opennebula_user
)
)
2017-05-10 00:49:03 +00:00
return opennebula_user
2017-05-09 22:39:41 +00:00
except ConnectionRefusedError:
logger.error(
'Could not connect to host: {host} via protocol {protocol}'.format(
host=settings.OPENNEBULA_DOMAIN,
protocol=settings.OPENNEBULA_PROTOCOL)
)
raise ConnectionRefusedError
2017-05-09 15:15:12 +00:00
def _get_user_pool(self):
2017-05-09 22:39:41 +00:00
try:
user_pool = oca.UserPool(self.oneadmin_client)
user_pool.info()
except ConnectionRefusedError:
logger.error(
'Could not connect to host: {host} via protocol {protocol}'.format(
host=settings.OPENNEBULA_DOMAIN,
protocol=settings.OPENNEBULA_PROTOCOL)
)
raise
2017-05-09 15:15:12 +00:00
return user_pool
2017-05-09 23:31:27 +00:00
2019-05-11 07:15:08 +00:00
def _get_vm_pool(self, infoextended=True):
2019-05-08 22:06:22 +00:00
"""
# filter:
# -4: Resources belonging to the users primary group
# -3: Resources belonging to the user
# -2: All resources
# -1: Resources belonging to the user and any of his groups
# >= 0: UID Users Resources
# vm states:
# *-2 Any state, including DONE
# *-1 Any state, except DONE (Default)
# *0 INIT
# *1 PENDING
# *2 HOLD
# *3 ACTIVE
# *4 STOPPED
# *5 SUSPENDED
# *6 DONE
# *7 FAILED
# *8 POWEROFF
# *9 UNDEPLOYED
:param infoextended: When True calls infoextended api method introduced
2019-05-08 22:06:57 +00:00
in OpenNebula 5.8 else falls back to info which has limited attributes
2019-05-08 22:06:22 +00:00
of a VM
:return: the oca VirtualMachinePool object
"""
try:
2017-05-11 10:45:09 +00:00
vm_pool = oca.VirtualMachinePool(self.client)
if infoextended:
vm_pool.infoextended(
2019-05-11 07:15:08 +00:00
filter=-1, # User's resources and any of his groups
vm_state=-1 # Look for VMs in any state, except DONE
)
else:
vm_pool.info()
return vm_pool
2019-05-11 07:15:08 +00:00
except AttributeError as ae:
logger.error("AttributeError : %s" % str(ae))
except ConnectionRefusedError:
logger.error(
'Could not connect to host: {host} via protocol {protocol}'.format(
host=settings.OPENNEBULA_DOMAIN,
protocol=settings.OPENNEBULA_PROTOCOL)
)
raise ConnectionRefusedError
2017-05-14 10:22:10 +00:00
# For now we'll just handle all other errors as connection errors
except:
raise ConnectionRefusedError
2019-05-11 07:15:08 +00:00
def get_vms(self):
try:
2019-05-11 07:15:08 +00:00
return self._get_vm_pool()
except ConnectionRefusedError:
2017-05-14 10:22:10 +00:00
raise ConnectionRefusedError
def get_vm(self, vm_id):
2017-05-13 04:59:57 +00:00
vm_id = int(vm_id)
try:
2019-05-08 22:06:22 +00:00
vm_pool = self._get_vm_pool()
2017-05-13 04:59:57 +00:00
return vm_pool.get_by_id(vm_id)
except WrongIdError:
raise WrongIdError
except:
2017-05-14 10:22:10 +00:00
raise ConnectionRefusedError
2017-05-09 23:31:27 +00:00
def get_ipv6(self, vm_id):
"""
Returns the first IPv6 of the given vm.
:return: An IPv6 address string, if it exists else returns None
"""
ipv6_list = self.get_all_ipv6_addresses(vm_id)
2018-07-01 05:57:15 +00:00
if len(ipv6_list) > 0:
return ipv6_list[0]
else:
return None
def get_all_ipv6_addresses(self, vm_id):
"""
Returns a list of IPv6 addresses of the given vm
:param vm_id: The ID of the vm
:return:
"""
2018-07-01 05:57:15 +00:00
ipv6_list = []
vm = self.get_vm(vm_id)
for nic in vm.template.nics:
if hasattr(nic, 'ip6_global'):
2018-07-01 05:57:15 +00:00
ipv6_list.append(nic.ip6_global)
return ipv6_list
2017-06-29 16:23:25 +00:00
def create_vm(self, template_id, specs, ssh_key=None, vm_name=None):
2017-05-13 04:59:57 +00:00
2017-05-13 11:47:53 +00:00
template = self.get_template(template_id)
vm_specs_formatter = """<TEMPLATE>
<MEMORY>{memory}</MEMORY>
<VCPU>{vcpu}</VCPU>
<CPU>{cpu}</CPU>
"""
2017-05-14 00:18:16 +00:00
try:
disk = template.template.disks[0]
image_id = disk.image_id
vm_specs = vm_specs_formatter.format(
vcpu=int(specs['cpu']),
cpu=0.1 * int(specs['cpu']),
2018-10-01 06:54:22 +00:00
memory=(512 if specs['memory'] == 0.5 else
1024 * int(specs['memory'])),
)
2017-05-14 00:18:16 +00:00
vm_specs += """<DISK>
<TYPE>fs</TYPE>
<SIZE>{size}</SIZE>
<DEV_PREFIX>vd</DEV_PREFIX>
<IMAGE_ID>{image_id}</IMAGE_ID>
</DISK>
""".format(size=1024 * int(specs['disk_size']),
image_id=image_id)
except:
disk = template.template.disks[0]
image = disk.image
image_uname = disk.image_uname
vm_specs = vm_specs_formatter.format(
vcpu=int(specs['cpu']),
cpu=0.1 * int(specs['cpu']),
2018-10-01 06:54:22 +00:00
memory=(512 if specs['memory'] == 0.5 else
1024 * int(specs['memory'])),
)
2017-05-14 00:18:16 +00:00
vm_specs += """<DISK>
<TYPE>fs</TYPE>
<SIZE>{size}</SIZE>
<DEV_PREFIX>vd</DEV_PREFIX>
<IMAGE>{image}</IMAGE>
<IMAGE_UNAME>{image_uname}</IMAGE_UNAME>
</DISK>
""".format(size=1024 * int(specs['disk_size']),
image=image,
image_uname=image_uname)
2017-06-21 07:43:10 +00:00
vm_specs += "<CONTEXT>"
if ssh_key:
vm_specs += "<SSH_PUBLIC_KEY>{ssh}</SSH_PUBLIC_KEY>".format(
ssh=ssh_key)
2017-06-21 07:43:10 +00:00
vm_specs += """<NETWORK>YES</NETWORK>
</CONTEXT>
2017-06-21 07:43:10 +00:00
</TEMPLATE>
"""
2017-11-29 05:45:09 +00:00
try:
vm_id = self.client.call(
oca.VmTemplate.METHODS['instantiate'], template.id, '', True,
vm_specs, False
)
except OpenNebulaException as err:
logger.error("OpenNebulaException: {0}".format(err))
return None
2017-05-13 04:59:57 +00:00
self.oneadmin_client.call(
oca.VirtualMachine.METHODS['action'],
'release',
vm_id
)
2017-06-29 16:23:25 +00:00
if vm_name is not None:
self.oneadmin_client.call(
'vm.rename',
vm_id,
vm_name
)
2017-05-09 23:31:27 +00:00
return vm_id
def delete_vm(self, vm_id):
TERMINATE_ACTION = 'terminate-hard'
2017-05-12 17:13:18 +00:00
vm_terminated = False
try:
self.oneadmin_client.call(
oca.VirtualMachine.METHODS['action'],
TERMINATE_ACTION,
int(vm_id),
)
vm_terminated = True
except socket.timeout as socket_err:
logger.error("Socket timeout error: {0}".format(socket_err))
2017-05-12 17:13:18 +00:00
except OpenNebulaException as opennebula_err:
logger.error(
"OpenNebulaException error: {0}".format(opennebula_err))
2017-05-12 17:13:18 +00:00
except OSError as os_err:
logger.error("OSError : {0}".format(os_err))
2017-05-12 17:13:18 +00:00
except ValueError as value_err:
logger.error("ValueError : {0}".format(value_err))
2017-05-12 17:13:18 +00:00
return vm_terminated
2019-05-12 17:21:52 +00:00
def power_off_vm(self, vm_id):
vm = None
try:
vm = self.get_vm(vm_id)
vm.poweroff()
except socket.timeout as socket_err:
logger.error("Socket timeout error: {0}".format(socket_err))
except OpenNebulaException as opennebula_err:
logger.error(
"OpenNebulaException error: {0}".format(opennebula_err))
except OSError as os_err:
logger.error("OSError : {0}".format(os_err))
except ValueError as value_err:
logger.error("ValueError : {0}".format(value_err))
return vm
def resume(self, vm_id):
vm = None
try:
vm = self.get_vm(vm_id)
vm.resume()
except socket.timeout as socket_err:
logger.error("Socket timeout error: {0}".format(socket_err))
except OpenNebulaException as opennebula_err:
logger.error(
"OpenNebulaException error: {0}".format(opennebula_err))
except OSError as os_err:
logger.error("OSError : {0}".format(os_err))
except ValueError as value_err:
logger.error("ValueError : {0}".format(value_err))
return vm
def save_key_in_vm_template(self, vm_id, ssh_key):
"""
Update the template of a given VM and set the ssh key of the user
:param vm_id: the identifier of the VM object
:param ssh_key: a newline(\n) separated ssh key string that needs to be
set in the VM template
:return:
"""
UPDATE_TYPE = 1
return_value = self.client.call(
'vm.updateconf',
vm_id,
'<CONTEXT><SSH_PUBLIC_KEY>%s</SSH_PUBLIC_KEY></CONTEXT>' % ssh_key,
UPDATE_TYPE
)
if type(return_value) == int:
logger.debug(
"Saved the key in VM Template success : %s" % return_value)
else:
logger.error(
"Could not save the key in VM Template. %s" % return_value)
2019-05-12 17:21:52 +00:00
return return_value
def save_key_in_opennebula_user(self, ssh_key, update_type=1):
2019-05-10 07:19:31 +00:00
"""
Save the given ssh key in OpenNebula user
# Update type: 0: Replace the whole template.
1: Merge new template with the existing one.
:param ssh_key: The ssh key to be saved
:param update_type: The update type as explained above
2019-05-10 07:19:31 +00:00
:return:
"""
return_value = self.client.call(
2019-05-10 21:51:05 +00:00
'user.update',
self.opennebula_user.id,
2019-05-10 22:31:25 +00:00
'<CONTEXT><SSH_PUBLIC_KEY>%s</SSH_PUBLIC_KEY></CONTEXT>' % ssh_key,
update_type
2019-05-10 07:19:31 +00:00
)
if type(return_value) == int:
logger.debug(
"Saved the key in opennebula successfully : %s" % return_value)
else:
logger.error(
"Could not save the key in opennebula. %s" % return_value)
return
def _get_template_pool(self):
try:
template_pool = oca.VmTemplatePool(self.oneadmin_client)
template_pool.info()
return template_pool
except ConnectionRefusedError:
logger.error(
2017-09-14 13:27:25 +00:00
"""Could not connect to host: {host} via protocol
{protocol}""".format(
host=settings.OPENNEBULA_DOMAIN,
protocol=settings.OPENNEBULA_PROTOCOL)
)
raise ConnectionRefusedError
2017-05-14 10:22:10 +00:00
except:
raise ConnectionRefusedError
2018-05-23 22:27:01 +00:00
def get_templates(self, prefix='public-'):
try:
public_templates = [
template
for template in self._get_template_pool()
2018-05-23 22:27:01 +00:00
if template.name.startswith(prefix)
]
return public_templates
except ConnectionRefusedError:
2017-05-14 10:22:10 +00:00
raise ConnectionRefusedError
except:
raise ConnectionRefusedError
def try_get_templates(self):
try:
return self.get_templates()
except:
return []
def get_template(self, template_id):
2017-05-13 04:59:57 +00:00
template_id = int(template_id)
try:
template_pool = self._get_template_pool()
return template_pool.get_by_id(template_id)
except:
2017-05-14 10:22:10 +00:00
raise ConnectionRefusedError
def create_template(self, name, cores, memory, disk_size, core_price,
memory_price,
disk_size_price, ssh=''):
2017-05-10 00:49:03 +00:00
"""Create and add a new template to opennebula.
:param name: A string representation describing the template.
Used as label in view.
:param cores: Amount of virtual cpu cores for the VM.
:param memory: Amount of RAM for the VM (GB)
:param disk_size: Amount of disk space for VM (GB)
:param core_price: Price of virtual cpu for the VM per core.
:param memory_price: Price of RAM for the VM per GB
:param disk_size_price: Price of disk space for VM per GB
:param ssh: User public ssh key
2017-05-10 00:49:03 +00:00
"""
2017-05-09 23:11:49 +00:00
template_string_formatter = """<TEMPLATE>
<NAME>{name}</NAME>
<MEMORY>{memory}</MEMORY>
<VCPU>{vcpu}</VCPU>
<CPU>{cpu}</CPU>
<DISK>
<TYPE>fs</TYPE>
<SIZE>{size}</SIZE>
<DEV_PREFIX>vd</DEV_PREFIX>
</DISK>
<CPU_COST>{cpu_cost}</CPU_COST>
<MEMORY_COST>{memory_cost}</MEMORY_COST>
<DISK_COST>{disk_cost}</DISK_COST>
<SSH_PUBLIC_KEY>{ssh}</SSH_PUBLIC_KEY>
2017-05-09 23:11:49 +00:00
</TEMPLATE>
"""
template_id = oca.VmTemplate.allocate(
self.oneadmin_client,
template_string_formatter.format(
name=name,
vcpu=cores,
cpu=0.1 * cores,
2017-05-09 23:11:49 +00:00
size=1024 * disk_size,
memory=1024 * memory,
# * 10 because we set cpu to *0.1
cpu_cost=10 * core_price,
memory_cost=memory_price,
disk_cost=disk_size_price,
ssh=ssh
2017-05-09 23:11:49 +00:00
)
)
return template_id
def delete_template(self, template_id):
2018-07-01 09:17:45 +00:00
self.oneadmin_client.call(
oca.VmTemplate.METHODS['delete'], template_id, False
)
2017-09-25 07:35:18 +00:00
def change_user_password(self, passwd_hash):
self.oneadmin_client.call(
oca.User.METHODS['passwd'],
self.opennebula_user.id,
2017-09-25 07:35:18 +00:00
passwd_hash
)
2017-05-31 16:01:54 +00:00
def add_public_key(self, user, public_key='', merge=False):
"""
2017-05-31 16:01:54 +00:00
Args:
user (CustomUser): Dynamicweb user
2017-05-31 16:01:54 +00:00
public_key (string): Public key to add to the user
merge (bool): Optional if True the new public key replaces the old
2017-05-31 16:01:54 +00:00
Raises:
KeyExistsError: If replace is False and the user already has a
public key
2017-05-31 16:01:54 +00:00
WrongNameError: If no openebula user with this credentials exists
ConnectionError: If the connection to the opennebula server can't be
established
2017-05-31 16:01:54 +00:00
Returns:
True if public_key was added
"""
# TODO: Check if we can remove this first try because we basically just
# raise the possible Errors
2017-05-31 16:01:54 +00:00
try:
open_user = self._get_user(user)
try:
old_key = open_user.template.ssh_public_key
if not merge:
2017-05-31 16:01:54 +00:00
raise KeyExistsError()
public_key += '\n{key}'.format(key=old_key)
2017-05-31 16:01:54 +00:00
except AttributeError:
pass
self.oneadmin_client.call('user.update', open_user.id,
'<CONTEXT><SSH_PUBLIC_KEY>{key}</SSH_PUBLIC_KEY></CONTEXT>'
.format(key=public_key))
2017-05-31 16:01:54 +00:00
return True
except WrongNameError:
raise
except ConnectionError:
raise
def remove_public_key(self, user, public_key=''):
"""
Args:
user (CustomUser): Dynamicweb user
public_key (string): Public key to be removed to the user
Raises:
KeyDoesNotExistsError: If replace is False and the user already has a
public key
WrongNameError: If no openebula user with this credentials exists
ConnectionError: If the connection to the opennebula server can't be
established
Returns:
True if public_key was removed
"""
try:
open_user = self._get_user(user)
try:
old_key = open_user.template.ssh_public_key
if public_key not in old_key:
2017-06-11 16:44:14 +00:00
return False
# raise KeyDoesNotExistsError()
if '\n{}'.format(public_key) in old_key:
public_key = old_key.replace('\n{}'.format(public_key), '')
else:
public_key = old_key.replace(public_key, '')
except AttributeError:
2017-06-11 17:59:57 +00:00
return False
# raise KeyDoesNotExistsError()
self.oneadmin_client.call('user.update', open_user.id,
'<CONTEXT><SSH_PUBLIC_KEY>{key}</SSH_PUBLIC_KEY></CONTEXT>'
.format(key=public_key))
return True
except WrongNameError:
raise
except ConnectionError:
raise
2017-08-31 16:33:07 +00:00
def manage_public_key(self, keys, hosts=None, countdown=0):
"""
2017-08-31 16:33:07 +00:00
A function that manages the supplied keys in the
authorized_keys file of the given list of hosts. If hosts
parameter is not supplied, all hosts of this customer
will be configured with the supplied keys
2017-08-30 07:43:54 +00:00
2017-08-31 16:33:07 +00:00
:param keys: A list of ssh keys that are to be added/removed
2017-08-30 07:43:54 +00:00
A key should be a dict of the form
{
'value': 'sha-.....', # public key as string
'state': True # whether key is to be added or
} # removed
:param hosts: A list of hosts IPv6 addresses
2017-08-31 16:33:07 +00:00
:param countdown: Parameter to be passed to celery apply_async
Allows to delay a task by `countdown` number of seconds
:return:
"""
2017-08-31 16:33:07 +00:00
if hosts is None:
hosts = self.get_all_hosts()
if len(hosts) > 0 and len(keys) > 0:
2017-08-31 21:03:31 +00:00
save_ssh_key.apply_async((hosts, keys), countdown=countdown,
link_error=save_ssh_key_error_handler.s())
2017-08-31 16:33:07 +00:00
else:
2017-09-13 10:24:08 +00:00
logger.debug(
"Keys and/or hosts are empty, so not managing any keys"
)
2017-08-31 16:33:07 +00:00
def get_all_hosts(self):
"""
A utility function to obtain all hosts of this owner
:return: A list of IPv6 addresses of all the hosts of this customer or
an empty list if none exist
2017-08-31 16:33:07 +00:00
"""
owner = CustomUser.objects.filter(
email=self.email).first()
all_orders = HostingOrder.objects.filter(customer__user=owner)
2017-08-31 16:33:07 +00:00
hosts = []
if len(all_orders) > 0:
logger.debug("The user {} has 1 or more VMs. We need to configure "
"the ssh keys.".format(self.email))
for order in all_orders:
try:
ip = self.get_ipv6(order.vm_id)
2018-06-26 23:06:10 +00:00
hosts.append(ip)
except WrongIdError:
logger.debug(
"VM with ID {} does not exist".format(order.vm_id))
else:
logger.debug("The user {} has no VMs. We don't need to configure "
"the ssh keys.".format(self.email))
2017-08-31 16:33:07 +00:00
return hosts