Newer
Older
from sjrpc.core import RpcError
from cloudcontrol.common.datastructures.orderedset import OrderedSet
from cloudcontrol.server.conf import CCConf
from cloudcontrol.server.exceptions import (ReservedTagError, BadObjectError,
CloneError, RightError)
from cloudcontrol.server.election import Elector
from cloudcontrol.server.handlers import listed, Reporter
from cloudcontrol.server.clients import Client, RegisteredCCHandler
from cloudcontrol.server.jobs import (ColdMigrationJob, HotMigrationJob,
CloneJob)
from cloudcontrol.common.tql.db.tag import StaticTag
MIGRATION_TYPES = {'cold': ColdMigrationJob,
'hot': HotMigrationJob,}
class CliHandler(RegisteredCCHandler):
""" Handler binded to the 'cli' role.
.. currentmodule:: cloudcontrol.server.clients.cli
.. autosummary::
CliHandler.list
CliHandler.start
CliHandler.stop
CliHandler.destroy
CliHandler.pause
CliHandler.resume
CliHandler.passwd
CliHandler.addaccount
CliHandler.copyaccount
CliHandler.addtag
CliHandler.deltag
CliHandler.tags
CliHandler.delaccount
CliHandler.close
CliHandler.declose
CliHandler.kill
CliHandler.rights
CliHandler.addright
CliHandler.delright
CliHandler.execute
CliHandler.shutdown
CliHandler.jobs
CliHandler.cancel
CliHandler.purge
CliHandler.attachment
CliHandler.rshell
CliHandler.rshell_resize
CliHandler.rshell_wait
CliHandler.forward
"""
@listed
def list(self, query):
""" List all objects registered on this instance.
:param query: the query to select objects to show
"""
self.logger.debug('Executed list function with query %s', query)
objects = self.client.list(query, method='list')
order = OrderedSet(['id'])
#if tags is not None:
# order |= OrderedSet(tags)
return {'objects': objects, 'order': list(order)}
def _vm_action(self, query, method, *args, **kwargs):
""" Do an action on a virtual machine.
"""
errs = Reporter()
# Search all hypervisors of selected vms:
for vm in self.client.list(query, show=('r', 'h', 'p'), method=method):
if vm['r'] != 'vm':
errs.error(vm['id'], 'not a vm')
else:
hvclient = self.server.get_client(vm['p'])
if hvclient is None:
errs.error(vm['id'], 'offline hypervisor')
else:
try:
hvclient.vm_action(method, vm['h'], *args, **kwargs)
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
except Exception as err:
errs.error(vm['id'], str(err))
else:
errs.success(vm['id'], 'ok')
return errs.get_dict()
@listed
def start(self, query):
""" Start a virtual machine.
"""
return self._vm_action(query, 'vm_start')
@listed
def stop(self, query):
""" Stop a virtual machine.
"""
return self._vm_action(query, 'vm_stop')
@listed
def destroy(self, query):
""" Destroy (hard shutdown) a virtual machine.
"""
return self._vm_action(query, 'vm_destroy')
@listed
def pause(self, query):
""" Pause a virtual machine.
"""
return self._vm_action(query, 'vm_suspend')
@listed
def resume(self, query):
""" Resume a virtual machine.
"""
return self._vm_action(query, 'vm_resume')
@listed
def disablevirtiocache(self, query):
""" Set virtio cache to none on VMs disk devices.
:param query: tql query
"""
return self._vm_action(query, 'vm_disable_virtio_cache')
@listed
def autostart(self, query, flag):
""" Set autostart flag on VMs.
:param query: tql query
:param bool flag: autostart value to set
"""
return self._vm_action(query, 'vm_set_autostart', flag)
@listed
def undefine(self, query, delete_storage=True):
""" Undefine selected virtual machines.
:param query: the tql query to select objects.
:param delete_storage: delete storage of vm.
:return: a dict where key is the id of a selected object, and the value
a tuple (errcode, message) where errcode is (success|error|warn) and
message an error message or the output of the command in case of
success.
"""
objects = self.client.list(query, show=('r', 'p', 'h', 'disk*',), method='undefine')
errs = Reporter()
for obj in objects:
if obj['r'] != 'vm':
errs.error(obj['id'], 'bad role')
continue
try:
hvcon = self.server.get_client(obj['p'])
except KeyError:
errs.error(obj['id'], 'hypervisor not connected')
else:
if delete_storage:
for disk in obj.get('disk', '').split():
pool = obj.get('disk%s_pool' % disk)
name = obj.get('disk%s_vol' % disk)
hvcon.proxy.vol_delete(pool, name)
hvcon.proxy.vm_undefine(obj['h'])
errs.success(obj['id'], 'vm undefined')
return errs.get_dict()
@listed
def passwd(self, query, password, method='ssha'):
""" Define a new password for selected users.
:param query: the query to select the objects to change
:param password: the password to set (None to remove password)
:param method: the hash method (sha, ssha, md5, smd5 or plain)
:return: a standard report output
"""
objects = self.client.list(query, show=('a',), method='passwd')
errs = Reporter()
with self.conf:
for obj in objects:
if 'a' not in obj:
errs.error(obj['id'], 'not an account')
continue
self.conf.set_password(obj['a'], password, method)
errs.success(obj['id'], 'password updated')
return errs.get_dict()
@listed
def addaccount(self, login, role, password=None):
""" Create a new account with specified login.
:param login: the login of the new account
:param role: the role of the new account
:param password: the password of the new account (None = not set)
"""
self.client.check('addaccount')
if role in Client.roles:
self.conf.create_account(login, role, password)
else:
raise BadRoleError('%r is not a legal role.' % role)
@listed
def copyaccount(self, copy_login, login, password=None):
""" Create a new account with specified login.
:param copy_login: the login of the account to copy
:param login: the login of the new account
:param password: the password of the new account (default None)
"""
self.client.check('addaccount')
self.conf.copy_account(copy_login, login, password)
@listed
def addtag(self, query, tag_name, tag_value):
""" Add a tag to the accounts which match the specified query.
:param query: the query to select objects
:param tag_name: the name of the tag to add
:param tag_value: the value of the tag
"""
if tag_name in self.server.RESERVED_TAGS:
raise ReservedTagError('Tag %r is read-only' % tag_name)
objects = self.client.list(query, show=('a',), method='addtag')
errs = Reporter()
with self.conf:
for obj in objects:
if 'a' not in obj:
errs.error(obj['id'], 'not an account')
continue
# Update the configuration for this account:
tags = self.conf.show(obj['a'])['tags']
if tag_name in tags:
errs.warn(obj['id'], 'tag already exists, changed from %s'
' to %s' % (tags[tag_name], tag_value))
# Update the object db (update the tag value):
dbobj = self.server.db.get(obj['id'])
else:
errs.success(obj['id'], 'tag created')
# Update the object db (create the tag):
dbobj = self.server.db.get(obj['id'])
dbobj.register(StaticTag(tag_name, tag_value), override=True)
self.conf.add_tag(obj['a'], tag_name, tag_value)
return errs.get_dict()
@listed
def deltag(self, query, tag_name):
""" Remove a tag of the selected accounts.
:param query: the query to select objects
:param tag_name: the name of the tag to remove
"""
if tag_name in self.server.RESERVED_TAGS:
raise ReservedTagError('Tag %r is read-only' % tag_name)
objects = self.client.list(query, show=('a',), method='deltag')
errs = Reporter()
with self.conf:
for obj in objects:
if 'a' not in obj:
errs.error(obj['id'], 'not an account')
continue
tags = self.conf.show(obj['a'])['tags']
if tag_name in tags:
errs.success(obj['id'], 'tag deleted')
dbobj = self.server.db.get(obj['id'])
dbobj.unregister(tag_name, override=True)
else:
errs.warn(obj['id'], 'unknown tag')
self.server.conf.remove_tag(obj['a'], tag_name)
return errs.get_dict()
@listed
def tags(self, query):
""" Return all static tags attached to the selected accounts.
:param query: the query to select objects
"""
objects = self.client.list(query, show=('a',), method='tags')
tags = []
for obj in objects:
o = {'id': obj['id']}
if 'a' in obj:
otags = self.server.conf.show(obj['a'])['tags']
otags.update({'id': obj['id']})
o.update(otags)
tags.append(o)
return {'objects': tags, 'order': ['id']}
@listed
def delaccount(self, query):
""" Delete the accounts selected by query.
:param query: the query to select objects
"""
objects = self.client.list(query, show=('a',), method='delaccount')
errs = Reporter()
with self.server.conf:
for obj in objects:
if 'a' not in obj:
errs.error(obj['id'], 'not an account')
continue
try:
self.server.conf.remove_account(obj['a'])
except CCConf.UnknownAccount:
errs.error(obj['id'], 'unknown account')
else:
errs.success(obj['id'], 'account deleted')
self.server.jobs.create('kill', author=self.client.login,
account=obj['a'], gracetime=1)
return errs.get_dict()
@listed
def close(self, query):
""" Close selected account an account without deleting them.
:param query: the query to select objects
"""
objects = self.client.list(query, show=('a',), method='close')
errs = Reporter()
with self.server.conf:
for obj in objects:
if 'a' not in obj:
errs.error(obj['id'], 'not an account')
continue
tags = self.server.conf.show(obj['a'])['tags']
if 'close' in tags:
errs.warn(obj['id'], 'account already closed')
continue
errs.success(obj['id'], 'closed')
self.server.conf.add_tag(obj['a'], 'close', 'yes')
dbobj = self.server.db.get(obj['id'])
dbobj.register(StaticTag('close', 'yes'), override=True)
self.server.jobs.create('kill', author=self.client.login,
account=obj['a'], gracetime=1)
return errs.get_dict()
@listed
def declose(self, query):
""" Re-open selected closed accounts.
:param query: the query to select objects
"""
objects = self.client.list(query, show=('a',), method='declose')
errs = Reporter()
with self.server.conf:
for obj in objects:
if 'a' not in obj:
errs.error(obj['id'], 'not an account')
continue
tags = self.conf.show(obj['a'])['tags']
if 'close' in tags:
errs.success(obj['id'], 'account declosed')
self.conf.remove_tag(obj['a'], 'close')
dbobj = self.server.db.get(obj['id'])
dbobj.unregister('close', override=True)
else:
errs.warn(obj['id'], 'account not closed')
return errs.get_dict()
@listed
def kill(self, query):
""" Disconnect all connected accounts selected by query.
:param query: the query to select objects
"""
objects = self.client.list(query, show=set(('a',)), method='kill')
errs = Reporter()
with self.server.conf:
for obj in objects:
if 'a' not in obj:
errs.error(obj['id'], 'not an account')
continue
try:
self.server.kill(obj['a'])
except NotConnectedAccountError:
errs.error(obj['id'], 'account is not connected')
else:
errs.success(obj['id'], 'account killed')
return errs.get_dict()
@listed
def loadrights(self):
""" Get the current ruleset.
self.client.check('rights')
return self.server.rights.export()
def saverights(self, ruleset):
""" Set the current ruleset.
:param ruleset: the ruleset to load.
self.client.check('rights')
self.server.rights.load(ruleset)
@listed
def execute(self, query, command):
""" Execute command on matched objects (must be roles hv or host).
:param query: the tql query to select objects.
:param command: the command to execute on each object
:return: a dict where key is the id of a selected object, and the value
a tuple (errcode, message) where errcode is (success|error|warn) and
message an error message or the output of the command in case of
success.
"""
objects = self.client.list(query, show=('r',), method='execute')
errs = Reporter()
for obj in objects:
if obj['r'] not in ('hv', 'host'):
errs.error(obj['id'], 'bad role')
continue
try:
client = self.server.get_client(obj['id'])
except KeyError:
errs.error(obj['id'], 'node not connected')
else:
returned = client.execute(command)
errs.success(obj['id'], 'command executed', output=returned)
return errs.get_dict()
@listed
def shutdown(self, query, reboot=True, gracefull=True):
""" Execute a shutdown on selected objects (must be roles hv or host).
:param query: the tql query to select objects.
:param reboot: reboot the host instead of just shut it off
:param gracefull: properly shutdown the host
:return: a dict where key is the id of a selected object, and the value
a tuple (errcode, message) where errcode is (success|error|warn) and
message an error message.
"""
objects = self.client.list(query, show=set(('r',)), method='execute')
errs = Reporter()
for obj in objects:
if obj['r'] not in ('hv', 'host'):
errs.error(obj['id'], 'bad role')
continue
try:
node = self.server.get_client(obj['id'])
except KeyError:
errs.error(obj['id'], 'node not connected')
else:
try:
except RpcError as err:
errs.error(obj['id'], '%s (exc: %s)' % (err.message,
err.exception))
else:
errs.success(obj['id'], 'ok')
return errs.get_dict()
@listed
def cancel(self, query):
""" Cancel a job.
:param query: the tql query used to select jobs to cancel
objects = self.client.list(query, show=('r', 'p'), method='cancel')
errs = Reporter()
for obj in objects:
if obj['r'] != 'job':
errs.error(obj['id'], 'not a job')
elif 'p' in obj:
errs.error(obj['id'], 'cancel on remote jobs not implemented')
else:
try:
self.server.jobs.get(obj['id']).cancel()
except KeyError:
errs.error(obj['id'], 'unknown job')
else:
errs.success(obj['id'], 'job cancelled')
def purge(self, query):
""" Purge matching jobs from server.
:param query: the tql query used to select jobs to purge
.. note::
Purge only work for job with state done.
objects = self.client.list(query, show=('r', 'p', 'state'), method='purge')
errs = Reporter()
for obj in objects:
if obj['r'] != 'job':
errs.error(obj['id'], 'not a job')
elif obj['state'] != 'done':
errs.error(obj['id'], 'job must be done')
elif 'p' in obj:
errs.error(obj['id'], 'purge on remote jobs not implemented')
else:
try:
self.server.jobs.purge(obj['id'])
except KeyError:
raise
errs.warn(obj['id'], 'job already purged')
else:
errs.success(obj['id'], 'job purged')
def attachment(self, query, name):
""" Get the specified attachment for jobs matching query.
:param query: the tql query used to select jobs
objects = self.server.list(query, show=('r', 'p'), method='attachment')
errs = Reporter()
for obj in objects:
if obj['r'] != 'job':
errs.error(obj['id'], 'not a job')
elif 'p' in obj:
errs.error(obj['id'], 'purge on remote jobs not implemented')
else:
try:
output = self.server.jobs.get(obj['id']).read_attachment(name)
except KeyError:
errs.error(obj['id'], 'unknown attachment')
else:
errs.success(obj['id'], 'job purged', output=output)
return errs.get_dict()
@listed
def electiontypes(self):
return Elector.ALGO_BY_TYPES
@listed
def election(self, query_vm, query_dest, mtype='cold', algo='fair', **kwargs):
""" Consult the server for the migration of specified vm on
an hypervisor pool.
:param query_vm: the tql query to select VMs to migrate
:param query_dest: the tql query to select destination hypervisors
candidates
:param mtype: type of migration
:param algo: algo used for distribution
"""
elector = Elector(self.server, query_vm, query_dest, self.client)
return elector.election(mtype, algo, **kwargs)
@listed
def migrate(self, migration_plan):
""" Launch the provided migration plan.
:param migration_plan: the plan of the migration.
:return: a standard error report
"""
errs = Reporter()
for migration in migration_plan:
# Check if the migration type is know:
if migration['type'] in MIGRATION_TYPES:
mtype = MIGRATION_TYPES[migration['type']]
else:
errmsg = '%r unknown migration type' % migration['type']
errs.error(migration['sid'], errmsg)
continue
vm = self.server.db.get_by_id(migration['sid'], ('h', 'hv', 'p'))
# Construct the migration properties:
migration_properties = {
'client': self.client,
'vm_name': vm['h'],
'hv_source': vm['p'],
'hv_dest': migration['did']
}
# Create the job:
self.client.spawn_job(mtype, settings=migration_properties)
errs.success(migration['sid'], 'migration launched')
return errs.get_dict()
@listed
def clone(self, tql_vm, tql_dest, name):
""" Create and launch a clone job.
:param tql_vm: a tql matching one vm object (the cloned vm)
:param tql_dest: a tql matching one hypervisor object (the destination
hypervisor)
:param name: the new name of the VM
"""
vm = self.clone.list(tql_vm, show=('r', 'h', 'p'), method='clone')
if len(vm) != 1:
raise CloneError('VM Tql must select ONE vm')
elif vm[0]['r'] != 'vm':
raise CloneError('Destination Tql must select a vm')
else:
vm = vm[0]
dest = self.clone.list(tql_dest, show=('r',), method='clone')
if len(dest) != 1:
raise CloneError('Destination Tql must select ONE hypervisor')
elif dest[0]['r'] != 'hv':
raise CloneError('Destination Tql must select an hypervisor')
else:
dest = dest[0]
self.client.spawn_job(CloneJob, settings={'server': self.server,
'vm_name': vm['h'],
'new_vm_name': name,
'hv_source': vm['p'],
'hv_dest': dest['id']})
@listed
def console(self, tql):
""" Start a remote console on object matching the provided tql.
:param tql: tql matching only one object on which start the console
:return: the label of the created tunnel
"""
objects = self.server.list(tql, show=('r', 'p', 'h'), method='console')
if len(objects) != 1:
raise NotImplementedError('Console only support one tunnel at time for now')
errs = Reporter()
for obj in objects:
if obj['r'] in ('vm',):
client = self.server.get_client(obj['p'])
srv_to_host_tun = client.console(obj['h'])
cli_tun = self.client.register_tunnel('console', client, srv_to_host_tun)
errs.success(obj['id'], 'tunnel started.', output=cli_tun.label)
else:
errs.error(obj['id'], 'bad role')
return errs.get_dict()
@listed
def rshell(self, tql):
""" Start a remote shell on object matching the provided tql.
:param tql: tql matching only one object on which start the rshell
:return: the label of the created tunnel
objects = self.server.list(tql, show=('r', 'p'), method='rshell')
if len(objects) != 1:
raise NotImplementedError('Rshell only support one tunnel at time for now')
errs = Reporter()
for obj in objects:
if obj['r'] in ('host', 'hv'):
client = self.server.get_client(obj['id'])
srv_to_host_tun = client.rshell()
cli_tun = self.client.register_tunnel('rshell', client, srv_to_host_tun)
errs.success(obj['id'], 'tunnel started.', output=cli_tun.label)
else:
errs.error(obj['id'], 'bad role')
return errs.get_dict()
@listed
def rshell_resize(self, label, row, col, xpixel, ypixel):
""" Send a resize event to the remote shell's tty.
:param label: label of the rshell tunnel to resize
:param row: number of rows
:param col: number of columns
:param xpixel: unused
:param ypixel: unused
"""
ttype, client, ctun, stun = self.client.get_tunnel(label)
if ttype != 'rshell':
raise ValueError('Label does not refers on a rshell')
client.rshell_resize(stun.label, row, col, xpixel, ypixel)
@listed
def rshell_wait(self, label):
""" Wait for a remote shell termination.
"""
ttype, client, ctun, stun = self.client.get_tunnel(label)
if ttype != 'rshell':
raise ValueError('Label does not refers on a rshell')
try:
rcode = client.rshell_wait(stun.label)
except Exception as err:
rcode = -1
self.logger.warning('Unexpected exit of tunnel: %s', err)
self.client.unregister_tunnel(ctun.label)
ctun.close()
stun.close()
return rcode
@listed
def forward(self, label, login, port, destination='127.0.0.1'):
""" Forward a TCP port to the client.
:param label: label of the tunnel created by the client (cli side)
:param login: login of the remote client on which establish the tunnel
:param port: port on which establish the tunnel on destination
:param destination: tunnel destination (from the remote client side)
self.client.check('forward', query='id=%s' % login)
# Create the tunnel to the node:
try:
host_client = self.server.get_client(login)
except KeyError:
raise KeyError('Specified client is not connected')
s2n_tun = host_client.forward(port, destination)
# Create tunnel to the CLI
self.client.register_tunnel('forward', host_client, s2n_tun)
@listed
def dbstats(self):
""" Get statistics about tql database.
"""
return self.server.db.stats()
def forward_call(self, login, func, *args, **kwargs):
""" Forward a call to a connected client and return result.
:param login: login of the connected client
:param func: function to execute on the client
:param \*args, \*\*kwargs: arguments of the call
"""
self.client.check('forward_call')
client = self.server.get_client(login)
return client.conn.call(func, *args, **kwargs)
class CliClient(Client):
""" A cli client connected to the cc-server.
"""
ROLE = 'cli'
RPC_HANDLER = CliHandler
KILL_ALREADY_CONNECTED = True
def __init__(self, *args, **kwargs):
super(CliClient, self).__init__(*args, **kwargs)
self._tunnels = {} # Running tunnels for this client (as client)
def spawn_job(self, job_class, **kwargs):
self._server.jobs.spawn(job_class, self.login, **kwargs)
def register_tunnel(self, ttype, client, tun, label=None):
""" Create and register a tunnel for this client.
:param ttype: type of tunnel
:param client: client where the tunnel go
:param tun: the tunnel of this client
:param label: label of the tunnel to create
"""
def cb_on_close(tun):
# Call the default callback:
tun.cb_default_on_close(tun)
# Delete the tunnel from the current running tunnels:
self.unregister_tunnel(tun.label)
ctun = self.conn.create_tunnel(label=label, endpoint=tun.socket,
on_close=cb_on_close)
self._tunnels[ctun.label] = (ttype, client, ctun, tun)
return ctun
def get_tunnel(self, label):
""" Get the tunnel binded to the provided label.
:return: a tuple (type, remote_client, tunnel, remote_client_tunnel)
where: **type** is a string provided on tunnel creation,
**remote_client** the client object of the remote client on which
the tunnel is established, **tunnel** the cli-to-server tunnel
object from the sjRpc, **remote_client_tunnel** the
server-to-remote-client tunnel object from the sjRpc.
"""
return self._tunnels[label]
def unregister_tunnel(self, label):
try:
del self._tunnels[label]
except KeyError:
pass
Client.register_client_class(CliClient)