-# $Id$
-# $URL$
-
+#
"""Sliver manager API.
This module exposes an XMLRPC interface that allows PlanetLab users to
import struct
import threading
import xmlrpclib
+import slivermanager
try:
from PLC.Parameter import Parameter, Mixed
def Mixed(a = None, b = None, c = None): pass
-import accounts
+import account
import logger
-# TODO: These try/excepts are a hack to allow doc/DocBookLocal.py to
-# import this file in order to extract the documentation from each
-# exported function.
+# TODO: These try/excepts are a hack to allow doc/DocBookLocal.py to
+# import this file in order to extract the documentation from each
+# exported function.
# A better approach will involve more extensive code splitting, I think.
try: import database
except: import logger as database
-try: import sliver_vs
-except: import logger as sliver_vs
import ticket as ticket_module
import tools
# accepts,
# returns
-@export_to_docbook(roles=['self'],
- accepts=[],
+@export_to_docbook(roles=['self'],
+ accepts=[],
returns=Parameter([], 'A list of supported functions'))
@export_to_api(0)
def Help():
"""Get a list of functions currently supported by the Node Manager API"""
names=api_method_dict.keys()
names.sort()
- return ''.join(['**** ' + api_method_dict[name].__name__ + '\n' + api_method_dict[name].__doc__ + '\n'
+ return ''.join(['**** ' + api_method_dict[name].__name__ + '\n' + api_method_dict[name].__doc__ + '\n'
for name in names])
-@export_to_docbook(roles=['self'],
- accepts=[Parameter(str, 'A ticket returned from GetSliceTicket()')],
+@export_to_docbook(roles=['self'],
+ accepts=[Parameter(str, 'A ticket returned from GetSliceTicket()')],
returns=Parameter(int, '1 if successful'))
@export_to_api(1)
def Ticket(ticket):
"""The Node Manager periodically polls the PLC API for a list of all
- slices that are allowed to exist on the given node. Before
+ slices that are allowed to exist on the given node. Before
actions are performed on a delegated slice (such as creation),
- a controller slice must deliver a valid slice ticket to NM.
-
+ a controller slice must deliver a valid slice ticket to NM.
+
This ticket is the value retured by PLC's GetSliceTicket() API call."""
try:
data = ticket_module.verify(ticket)
except Exception, err:
raise xmlrpclib.Fault(102, 'Ticket error: ' + str(err))
-@export_to_docbook(roles=['self'],
- accepts=[Parameter(str, 'A ticket returned from GetSlivers()')],
+@export_to_docbook(roles=['self'],
+ accepts=[Parameter(str, 'A ticket returned from GetSlivers()')],
returns=Parameter(int, '1 if successful'))
@export_to_api(1)
def AdminTicket(ticket):
@export_to_docbook(roles=['self'],
- accepts=[],
+ accepts=[],
returns={'sliver_name' : Parameter(int, 'the associated xid')})
@export_to_api(0)
def GetXIDs():
"""Return an dictionary mapping Slice names to XIDs"""
- return dict([(pwent[0], pwent[2]) for pwent in pwd.getpwall() if pwent[6] == sliver_vs.Sliver_VS.SHELL])
+ return dict([(pwent[0], pwent[2]) for pwent in pwd.getpwall() if pwent[6] == slivermanager.sliver_password_shell])
@export_to_docbook(roles=['self'],
- accepts=[],
+ accepts=[],
returns={ 'sliver_name' : Parameter(str, 'the associated SSHKey')})
@export_to_api(0)
def GetSSHKeys():
return keydict
-@export_to_docbook(roles=['nm-controller', 'self'],
- accepts=[Parameter(str, 'A sliver/slice name.')],
+@export_to_docbook(roles=['nm-controller', 'self'],
+ accepts=[Parameter(str, 'A sliver/slice name.')],
returns=Parameter(int, '1 if successful'))
@export_to_api(1)
def Create(sliver_name):
"""Create a non-PLC-instantiated sliver"""
rec = sliver_name
- if rec['instantiation'] == 'delegated':
- accounts.get(rec['name']).ensure_created(rec)
+ if rec['instantiation'] == 'delegated':
+ account.get(rec['name']).ensure_created(rec)
logger.log("api_calls: Create %s"%rec['name'])
- else:
+ else:
raise Exception, "Only PLC can create non delegated slivers."
-@export_to_docbook(roles=['nm-controller', 'self'],
- accepts=[Parameter(str, 'A sliver/slice name.')],
+@export_to_docbook(roles=['nm-controller', 'self'],
+ accepts=[Parameter(str, 'A sliver/slice name.')],
returns=Parameter(int, '1 if successful'))
@export_to_api(1)
def Destroy(sliver_name):
"""Destroy a non-PLC-instantiated sliver"""
- rec = sliver_name
- if rec['instantiation'] == 'delegated':
- accounts.get(rec['name']).ensure_destroyed()
+ rec = sliver_name
+ if rec['instantiation'] == 'delegated':
+ account.get(rec['name']).ensure_destroyed()
logger.log("api_calls: Destroy %s"%rec['name'])
- else:
+ else:
raise Exception, "Only PLC can destroy non delegated slivers."
-@export_to_docbook(roles=['nm-controller', 'self'],
- accepts=[Parameter(str, 'A sliver/slice name.')],
+@export_to_docbook(roles=['nm-controller', 'self'],
+ accepts=[Parameter(str, 'A sliver/slice name.')],
returns=Parameter(int, '1 if successful'))
@export_to_api(1)
def Start(sliver_name):
"""Configure and start sliver."""
rec = sliver_name
- accounts.get(rec['name']).start(rec)
+ account.get(rec['name']).start(rec)
logger.log("api_calls: Start %s"%rec['name'])
-@export_to_docbook(roles=['nm-controller', 'self'],
- accepts=[Parameter(str, 'A sliver/slice name.')],
+@export_to_docbook(roles=['nm-controller', 'self'],
+ accepts=[Parameter(str, 'A sliver/slice name.')],
returns=Parameter(int, '1 if successful'))
@export_to_api(1)
def Stop(sliver_name):
"""Kill all processes belonging to the specified sliver"""
rec = sliver_name
- accounts.get(rec['name']).stop()
+ account.get(rec['name']).stop()
logger.log("api_calls: Stop %s"%rec['name'])
-@export_to_docbook(roles=['nm-controller', 'self'],
- accepts=[Parameter(str, 'A sliver/slice name.')],
+@export_to_docbook(roles=['nm-controller', 'self'],
+ accepts=[Parameter(str, 'A sliver/slice name.')],
returns=Parameter(int, '1 if successful'))
@export_to_api(1)
def ReCreate(sliver_name):
"""Stop, Destroy, Create, Start sliver in order to reinstall it."""
rec = sliver_name
- accounts.get(rec['name']).stop()
- accounts.get(rec['name']).ensure_created(rec)
- accounts.get(rec['name']).start(rec)
+ account.get(rec['name']).stop()
+ account.get(rec['name']).ensure_created(rec)
+ account.get(rec['name']).start(rec)
logger.log("api_calls: ReCreate %s"%rec['name'])
-@export_to_docbook(roles=['nm-controller', 'self'],
- accepts=[Parameter(str, 'A sliver/slice name.')],
+@export_to_docbook(roles=['nm-controller', 'self'],
+ accepts=[Parameter(str, 'A sliver/slice name.')],
returns=Parameter(dict, "A resource specification"))
@export_to_api(1)
def GetEffectiveRSpec(sliver_name):
return rec.get('_rspec', {}).copy()
-@export_to_docbook(roles=['nm-controller', 'self'],
- accepts=[Parameter(str, 'A sliver/slice name.')],
+@export_to_docbook(roles=['nm-controller', 'self'],
+ accepts=[Parameter(str, 'A sliver/slice name.')],
returns={"resource name" : Parameter(int, "amount")})
@export_to_api(1)
def GetRSpec(sliver_name):
return rec.get('rspec', {}).copy()
-@export_to_docbook(roles=['nm-controller', 'self'],
- accepts=[Parameter(str, 'A sliver/slice name.')],
+@export_to_docbook(roles=['nm-controller', 'self'],
+ accepts=[Parameter(str, 'A sliver/slice name.')],
returns=[Mixed(Parameter(str, 'recipient slice name'),
Parameter(str, 'resource name'),
Parameter(int, 'resource amount'))])
def validate_loans(loans):
"""Check that <obj> is a list of valid loan specifications."""
- def validate_loan(loan):
+ def validate_loan(loan):
return (type(loan)==list or type(loan)==tuple) and len(loan)==3 \
and type(loan[0])==str and type(loan[1])==str and loan[1] in database.LOANABLE_RESOURCES and type(loan[2])==int and loan[2]>=0
return type(loans)==list and False not in [validate_loan(load) for loan in loans]
-@export_to_docbook(roles=['nm-controller', 'self'],
+@export_to_docbook(roles=['nm-controller', 'self'],
accepts=[ Parameter(str, 'A sliver/slice name.'),
[Mixed(Parameter(str, 'recipient slice name'),
Parameter(str, 'resource name'),
in the future. As well, there is currently no asynchronous notification
of loss of resources."""
rec = sliver_name
- if not validate_loans(loans):
+ if not validate_loans(loans):
raise xmlrpclib.Fault(102, 'Invalid argument: the second argument must be a well-formed loan specification')
rec['_loans'] = loans
database.db.sync()
-@export_to_docbook(roles=['nm-controller', 'self'],
+@export_to_docbook(roles=['nm-controller', 'self'],
returns=Parameter(dict, 'Record dictionary'))
@export_to_api(0)
def GetRecord(sliver_name):
git://git.onelab.eu / nodemanager.git / blobdiff