def load_computing_unit(self):
"""
Loads the external computing unit.
"""
for factory_method in iter_entry_points(
group="archipel.plugin.platform.computingunit",
name="factory"):
method = factory_method.load()
plugin_content = method()
self.computing_unit = plugin_content["plugin"]
self.entity.log.info("PLATFORMREQ: loading computing unit %s" %
plugin_content["info"]["common-name"])
break
if not self.computing_unit:
self.computing_unit = TNBasicPlatformScoreComputing()
self.entity.log.info("PLATFORMREQ: using default computing unit.")
def load_computing_unit(self):
"""
Loads the external computing unit.
"""
for factory_method in iter_entry_points(group="archipel.plugin.platform.computingunit", name="factory"):
method = factory_method.load()
plugin_content = method()
self.computing_unit = plugin_content["plugin"]
self.entity.log.info("PLATFORMREQ: loading computing unit %s" % plugin_content["info"]["common-name"])
break
if not self.computing_unit:
self.computing_unit = TNBasicPlatformScoreComputing()
self.entity.log.warning("PLATFORMREQ: using dummy computing unit. It returns random values !")
class TNPlatformRequests (TNArchipelPlugin):
def __init__(self, configuration, entity, entry_point_group):
"""
Initialize the plugin.
@type configuration: Configuration object
@param configuration: the configuration
@type entity: L{TNArchipelEntity}
@param entity: the entity that owns the plugin
@type entry_point_group: string
@param entry_point_group: the group name of plugin entry_point
"""
TNArchipelPlugin.__init__(self, configuration=configuration, entity=entity, entry_point_group=entry_point_group)
self.computing_unit = None
# get computing unit plugin if present
self.load_computing_unit()
### Plugin interface
def register_handlers(self):
"""
This method will be called by the plugin user when it will be
necessary to register module for listening to stanza.
"""
self.entity.log.debug("PLATFORMREQ: Registering handler for platform request")
self.entity.xmppclient.RegisterHandler('iq', self.process_iq, ns=ARCHIPEL_NS_PLATFORM)
def unregister_handlers(self):
"""
Unregister the handlers.
"""
self.entity.xmppclient.UnregisterHandler('iq', self.process_iq, ns=ARCHIPEL_NS_PLATFORM)
@staticmethod
def plugin_info():
"""
Return informations about the plugin.
@rtype: dict
@return: dictionary contaning plugin informations
"""
plugin_friendly_name = "Central Agent Platform Request"
plugin_identifier = "platformrequest"
plugin_configuration_section = None
plugin_configuration_tokens = []
return {"common-name": plugin_friendly_name,
"identifier": plugin_identifier,
"configuration-section": plugin_configuration_section,
"configuration-tokens": plugin_configuration_tokens}
### Plugin loading
def load_computing_unit(self):
"""
Loads the external computing unit.
"""
for factory_method in iter_entry_points(group="archipel.plugin.platform.computingunit", name="factory"):
method = factory_method.load()
plugin_content = method()
self.computing_unit = plugin_content["plugin"]
self.entity.log.info("PLATFORMREQ: loading computing unit %s" % plugin_content["info"]["common-name"])
break
if not self.computing_unit:
self.computing_unit = TNBasicPlatformScoreComputing()
self.entity.log.warning("PLATFORMREQ: using dummy computing unit. It returns random values !")
### XMPP Management
def process_iq(self, conn, iq):
"""
This method is invoked when a ARCHIPEL_NS_PLATFORM IQ is received.
It understands IQ of type:
- request
@type conn: xmpp.Dispatcher
@param conn: ths instance of the current connection that send the stanza
@type iq: xmpp.Protocol.Iq
@param iq: the received IQ
"""
reply = None
action = self.entity.check_acp(conn, iq)
if action == "request":
reply = self.iq_request(iq)
if reply:
conn.send(reply)
raise xmpp.protocol.NodeProcessed
def iq_request(self, iq):
"""
Process platform request.
@type iq: xmpp.Protocol.Iq
@param iq: the received IQ
@rtype: xmpp.Protocol.Iq
@return: a ready to send IQ containing the result of the action
"""
try:
reply = iq.buildReply("result")
limit = iq.getTag("query").getTag("archipel").getAttr("limit")
computed_items = self.computing_unit.score(self.entity.database, limit=limit)
self.entity.log.debug("PLATFORMREQ: computed items : %s" % computed_items)
for computed_item in computed_items:
reply.addChild("hypervisor", attrs=computed_item)
except Exception as ex:
reply = build_error_iq(self, ex, iq)
return reply
class TNPlatformRequests(TNArchipelPlugin):
def __init__(self, configuration, entity, entry_point_group):
"""
Initialize the plugin.
@type configuration: Configuration object
@param configuration: the configuration
@type entity: L{TNArchipelEntity}
@param entity: the entity that owns the plugin
@type entry_point_group: string
@param entry_point_group: the group name of plugin entry_point
"""
TNArchipelPlugin.__init__(self,
configuration=configuration,
entity=entity,
entry_point_group=entry_point_group)
self.pubsub_request_in_node = None
self.pubsub_request_out_node = None
self.computing_unit = None
# get eventual computing unit plugin
self.load_computing_unit()
# creates permissions
self.entity.permission_center.create_permission(
"platform_allocvm",
"Authorizes user to send cross platform request", True)
# register to the node vmrequest
self.entity.register_hook("HOOK_ARCHIPELENTITY_XMPP_AUTHENTICATED",
method=self.manage_platform_vm_request)
### Plugin interface
def register_handlers(self):
"""
This method will be called by the plugin user when it will be
necessary to register module for listening to stanza.
"""
self.entity.xmppclient.RegisterHandler('iq',
self.process_iq,
ns=ARCHIPEL_NS_PLATFORM)
def unregister_handlers(self):
"""
Unregister the handlers.
"""
self.entity.xmppclient.UnregisterHandler('iq',
self.process_iq,
ns=ARCHIPEL_NS_PLATFORM)
@staticmethod
def plugin_info():
"""
Return informations about the plugin.
@rtype: dict
@return: dictionary contaning plugin informations
"""
plugin_friendly_name = "Hypervisor Platform Request"
plugin_identifier = "platformrequest"
plugin_configuration_section = None
plugin_configuration_tokens = []
return {
"common-name": plugin_friendly_name,
"identifier": plugin_identifier,
"configuration-section": plugin_configuration_section,
"configuration-tokens": plugin_configuration_tokens
}
### Plugin loading
def load_computing_unit(self):
"""
Loads the external computing unit.
"""
for factory_method in iter_entry_points(
group="archipel.plugin.platform.computingunit",
name="factory"):
method = factory_method.load()
plugin_content = method()
self.computing_unit = plugin_content["plugin"]
self.entity.log.info("PLATFORMREQ: loading computing unit %s" %
plugin_content["info"]["common-name"])
break
if not self.computing_unit:
self.computing_unit = TNBasicPlatformScoreComputing()
self.entity.log.info("PLATFORMREQ: using default computing unit.")
### Performs platform actions
def perform_score_computing(self, request):
"""
Compute the score for the given request.
@type request: string
@param request: the requested action name
@rtype: float
@return: the score computed by the computing unit ([0.0, 1.0])
"""
return self.computing_unit.score(request)
### Pubsub management
def manage_platform_vm_request(self, origin, user_info, arguments):
"""
Register to pubsub event node /archipel/platform/requests/in
and /archipel/platform/requests/out
@type origin: L{TNArchipelEnity}
@param origin: the origin of the hook
@type user_info: object
@param user_info: random user information
@type arguments: object
@param arguments: runtime argument
"""
nodeVMRequestsInName = "/archipel/platform/requests/in"
self.entity.log.info("PLATFORMREQ: getting the pubsub node %s" %
nodeVMRequestsInName)
self.pubsub_request_in_node = TNPubSubNode(self.entity.xmppclient,
self.entity.pubsubserver,
nodeVMRequestsInName)
self.pubsub_request_in_node.recover()
self.entity.log.info("PLATFORMREQ: node %s recovered." %
nodeVMRequestsInName)
self.pubsub_request_in_node.subscribe(self.entity.jid,
self._handle_request_event)
self.entity.log.info(
"PLATFORMREQ: entity %s is now subscribed to events from node %s" %
(self.entity.jid, nodeVMRequestsInName))
nodeVMRequestsOutName = "/archipel/platform/requests/out"
self.entity.log.info("PLATFORMREQ: getting the pubsub node %s" %
nodeVMRequestsOutName)
self.pubsub_request_out_node = TNPubSubNode(self.entity.xmppclient,
self.entity.pubsubserver,
nodeVMRequestsOutName)
self.pubsub_request_out_node.recover()
self.entity.log.info("PLATFORMREQ: node %s recovered." %
nodeVMRequestsOutName)
def _handle_request_event(self, event):
"""
Triggered when a platform wide virtual machine request is received.
@type event: xmpp.Node
@param event: the push event
"""
items = event.getTag("event").getTag("items").getTags("item")
for item in items:
try:
item_publisher = xmpp.JID(item.getAttr("publisher"))
except Exception as ex:
self.entity.log.error(
"The pubsub node has not 'publisher' tag. This is a bug in ejabberd, not the fault of Archipel. You can find a patch here for ejabberd here https://support.process-one.net/browse/EJAB-1347"
)
continue
if not item_publisher.getStripped() == self.entity.jid.getStripped(
):
try:
self.entity.log.info(
"PLATFORMREQ: received a platform-wide virtual machine request from %s"
% item_publisher)
request_uuid = item.getTag("archipel").getAttr("uuid")
request_action = item.getTag("archipel").getAttr("action")
if not self.entity.permission_center.check_permission(
item_publisher.getStripped(),
"platform_%s" % request_action):
self.entity.log.warning(
"User %s have no permission to perform platform action %s"
% (item_publisher, request_action))
return
score = self.perform_score_computing(item)
if score:
answer_node = xmpp.Node("archipel",
attrs={
"uuid": request_uuid,
"score": score
})
self.pubsub_request_out_node.add_item(answer_node)
except Exception as ex:
self.entity.log.error(
"PLATFORMREQ: seems that request is not valid (%s) %s"
% (str(ex), str(item)))
### XMPP Management
def process_iq(self, conn, iq):
"""
This method is invoked when a ARCHIPEL_NS_PLATFORM IQ is received.
It understands IQ of type:
- allocvm
@type conn: xmpp.Dispatcher
@param conn: ths instance of the current connection that send the stanza
@type iq: xmpp.Protocol.Iq
@param iq: the received IQ
"""
reply = None
action = self.entity.check_acp(conn, iq)
self.entity.check_perm(conn, iq, action, -1, prefix="platform_")
if action == "allocvm":
reply = self.iq_allocvm(iq)
if reply:
conn.send(reply)
raise xmpp.protocol.NodeProcessed
def iq_allocvm(self, iq):
"""
Alloc a new VM on the hypervisor.
@type iq: xmpp.Protocol.Iq
@param iq: the received IQ
@rtype: xmpp.Protocol.Iq
@return: a ready to send IQ containing the result of the action
"""
try:
reply = iq.buildReply("result")
self.entity.alloc(requester=iq.getFrom(), requested_name=None)
except Exception as ex:
reply = build_error_iq(self, ex, iq)
return reply
class TNPlatformRequests (TNArchipelPlugin):
def __init__(self, configuration, entity, entry_point_group):
"""
Initialize the plugin.
@type configuration: Configuration object
@param configuration: the configuration
@type entity: L{TNArchipelEntity}
@param entity: the entity that owns the plugin
@type entry_point_group: string
@param entry_point_group: the group name of plugin entry_point
"""
TNArchipelPlugin.__init__(self, configuration=configuration, entity=entity, entry_point_group=entry_point_group)
self.pubsub_request_in_node = None
self.pubsub_request_out_node = None
self.computing_unit = None
# get eventual computing unit plugin
self.load_computing_unit()
# creates permissions
self.entity.permission_center.create_permission("platform_allocvm", "Authorizes user to send cross platform request", True)
# register to the node vmrequest
self.entity.register_hook("HOOK_ARCHIPELENTITY_XMPP_AUTHENTICATED", method=self.manage_platform_vm_request)
### Plugin interface
def register_handlers(self):
"""
This method will be called by the plugin user when it will be
necessary to register module for listening to stanza.
"""
self.entity.xmppclient.RegisterHandler('iq', self.process_iq, ns=ARCHIPEL_NS_PLATFORM)
def unregister_handlers(self):
"""
Unregister the handlers.
"""
self.entity.xmppclient.UnregisterHandler('iq', self.process_iq, ns=ARCHIPEL_NS_PLATFORM)
@staticmethod
def plugin_info():
"""
Return informations about the plugin.
@rtype: dict
@return: dictionary contaning plugin informations
"""
plugin_friendly_name = "Hypervisor Platform Request"
plugin_identifier = "platformrequest"
plugin_configuration_section = None
plugin_configuration_tokens = []
return { "common-name" : plugin_friendly_name,
"identifier" : plugin_identifier,
"configuration-section" : plugin_configuration_section,
"configuration-tokens" : plugin_configuration_tokens }
### Plugin loading
def load_computing_unit(self):
"""
Loads the external computing unit.
"""
for factory_method in iter_entry_points(group="archipel.plugin.platform.computingunit", name="factory"):
method = factory_method.load()
plugin_content = method()
self.computing_unit = plugin_content["plugin"]
self.entity.log.info("PLATFORMREQ: loading computing unit %s" % plugin_content["info"]["common-name"])
break
if not self.computing_unit:
self.computing_unit = TNBasicPlatformScoreComputing()
self.entity.log.info("PLATFORMREQ: using default computing unit.")
### Performs platform actions
def perform_score_computing(self, request):
"""
Compute the score for the given request.
@type request: string
@param request: the requested action name
@rtype: float
@return: the score computed by the computing unit ([0.0, 1.0])
"""
return self.computing_unit.score(request)
### Pubsub management
def manage_platform_vm_request(self, origin, user_info, arguments):
"""
Register to pubsub event node /archipel/platform/requests/in
and /archipel/platform/requests/out
@type origin: L{TNArchipelEnity}
@param origin: the origin of the hook
@type user_info: object
@param user_info: random user information
@type arguments: object
@param arguments: runtime argument
"""
nodeVMRequestsInName = "/archipel/platform/requests/in"
self.entity.log.info("PLATFORMREQ: getting the pubsub node %s" % nodeVMRequestsInName)
self.pubsub_request_in_node = TNPubSubNode(self.entity.xmppclient, self.entity.pubsubserver, nodeVMRequestsInName)
self.pubsub_request_in_node.recover()
self.entity.log.info("PLATFORMREQ: node %s recovered." % nodeVMRequestsInName)
self.pubsub_request_in_node.subscribe(self.entity.jid, self._handle_request_event)
self.entity.log.info("PLATFORMREQ: entity %s is now subscribed to events from node %s" % (self.entity.jid, nodeVMRequestsInName))
nodeVMRequestsOutName = "/archipel/platform/requests/out"
self.entity.log.info("PLATFORMREQ: getting the pubsub node %s" % nodeVMRequestsOutName)
self.pubsub_request_out_node = TNPubSubNode(self.entity.xmppclient, self.entity.pubsubserver, nodeVMRequestsOutName)
self.pubsub_request_out_node.recover()
self.entity.log.info("PLATFORMREQ: node %s recovered." % nodeVMRequestsOutName)
def _handle_request_event(self, event):
"""
Triggered when a platform wide virtual machine request is received.
@type event: xmpp.Node
@param event: the push event
"""
items = event.getTag("event").getTag("items").getTags("item")
for item in items:
try:
item_publisher = xmpp.JID(item.getAttr("publisher"))
except Exception as ex:
self.entity.log.error("The pubsub node has not 'publisher' tag. This is a bug in ejabberd, not the fault of Archipel. You can find a patch here for ejabberd here https://support.process-one.net/browse/EJAB-1347")
continue
if not item_publisher.getStripped() == self.entity.jid.getStripped():
try:
self.entity.log.info("PLATFORMREQ: received a platform-wide virtual machine request from %s" % item_publisher)
request_uuid = item.getTag("archipel").getAttr("uuid")
request_action = item.getTag("archipel").getAttr("action")
if not self.entity.permission_center.check_permission(item_publisher.getStripped(), "platform_%s" % request_action):
self.entity.log.warning("User %s have no permission to perform platform action %s" % (item_publisher, request_action))
return
score = self.perform_score_computing(item)
if score:
answer_node = xmpp.Node("archipel", attrs={"uuid": request_uuid, "score": score})
self.pubsub_request_out_node.add_item(answer_node)
except Exception as ex:
self.entity.log.error("PLATFORMREQ: seems that request is not valid (%s) %s" % (str(ex), str(item)))
### XMPP Management
def process_iq(self, conn, iq):
"""
This method is invoked when a ARCHIPEL_NS_PLATFORM IQ is received.
It understands IQ of type:
- allocvm
@type conn: xmpp.Dispatcher
@param conn: ths instance of the current connection that send the stanza
@type iq: xmpp.Protocol.Iq
@param iq: the received IQ
"""
reply = None
action = self.entity.check_acp(conn, iq)
self.entity.check_perm(conn, iq, action, -1, prefix="platform_")
if action == "allocvm":
reply = self.iq_allocvm(iq)
if reply:
conn.send(reply)
raise xmpp.protocol.NodeProcessed
def iq_allocvm(self, iq):
"""
Alloc a new VM on the hypervisor.
@type iq: xmpp.Protocol.Iq
@param iq: the received IQ
@rtype: xmpp.Protocol.Iq
@return: a ready to send IQ containing the result of the action
"""
try:
reply = iq.buildReply("result")
self.entity.alloc(requester=iq.getFrom(), requested_name=None)
except Exception as ex:
reply = build_error_iq(self, ex, iq)
return reply
class TNPlatformRequests(TNArchipelPlugin):
def __init__(self, configuration, entity, entry_point_group):
"""
Initialize the plugin.
@type configuration: Configuration object
@param configuration: the configuration
@type entity: L{TNArchipelEntity}
@param entity: the entity that owns the plugin
@type entry_point_group: string
@param entry_point_group: the group name of plugin entry_point
"""
TNArchipelPlugin.__init__(self,
configuration=configuration,
entity=entity,
entry_point_group=entry_point_group)
self.computing_unit = None
# get computing unit plugin if present
self.load_computing_unit()
### Plugin interface
def register_handlers(self):
"""
This method will be called by the plugin user when it will be
necessary to register module for listening to stanza.
"""
self.entity.log.debug(
"PLATFORMREQ: Registering handler for platform request")
self.entity.xmppclient.RegisterHandler('iq',
self.process_iq,
ns=ARCHIPEL_NS_PLATFORM)
def unregister_handlers(self):
"""
Unregister the handlers.
"""
self.entity.xmppclient.UnregisterHandler('iq',
self.process_iq,
ns=ARCHIPEL_NS_PLATFORM)
@staticmethod
def plugin_info():
"""
Return informations about the plugin.
@rtype: dict
@return: dictionary contaning plugin informations
"""
plugin_friendly_name = "Central Agent Platform Request"
plugin_identifier = "platformrequest"
plugin_configuration_section = None
plugin_configuration_tokens = []
return {
"common-name": plugin_friendly_name,
"identifier": plugin_identifier,
"configuration-section": plugin_configuration_section,
"configuration-tokens": plugin_configuration_tokens
}
### Plugin loading
def load_computing_unit(self):
"""
Loads the external computing unit.
"""
for factory_method in iter_entry_points(
group="archipel.plugin.platform.computingunit",
name="factory"):
method = factory_method.load()
plugin_content = method()
self.computing_unit = plugin_content["plugin"]
self.entity.log.info("PLATFORMREQ: loading computing unit %s" %
plugin_content["info"]["common-name"])
break
if not self.computing_unit:
self.computing_unit = TNBasicPlatformScoreComputing()
self.entity.log.warning(
"PLATFORMREQ: using dummy computing unit. It returns random values !"
)
### XMPP Management
def process_iq(self, conn, iq):
"""
This method is invoked when a ARCHIPEL_NS_PLATFORM IQ is received.
It understands IQ of type:
- request
@type conn: xmpp.Dispatcher
@param conn: ths instance of the current connection that send the stanza
@type iq: xmpp.Protocol.Iq
@param iq: the received IQ
"""
reply = None
action = self.entity.check_acp(conn, iq)
if action == "request":
reply = self.iq_request(iq)
if reply:
conn.send(reply)
raise xmpp.protocol.NodeProcessed
def iq_request(self, iq):
"""
Process platform request.
@type iq: xmpp.Protocol.Iq
@param iq: the received IQ
@rtype: xmpp.Protocol.Iq
@return: a ready to send IQ containing the result of the action
"""
try:
reply = iq.buildReply("result")
limit = iq.getTag("query").getTag("archipel").getAttr("limit")
computed_items = self.computing_unit.score(self.entity.database,
limit=limit)
self.entity.log.debug("PLATFORMREQ: computed items : %s" %
computed_items)
for computed_item in computed_items:
reply.addChild("hypervisor", attrs=computed_item)
except Exception as ex:
reply = build_error_iq(self, ex, iq)
return reply