3 This module exposes an XMLRPC interface that allows PlanetLab users to
4 create/destroy slivers with delegated instantiation, start and stop
5 slivers, make resource loans, and examine resource allocations. The
6 XMLRPC is provided on a localhost-only TCP port as well as via a Unix
7 domain socket that is accessible by ssh-ing into a delegate account
8 with the forward_api_calls shell.
11 import SimpleXMLRPCServer
22 from PLC.Parameter import Parameter, Mixed
24 def Parameter(a = None, b = None): pass
25 def Mixed(a = None, b = None, c = None): pass
31 # TODO: These try/excepts are a hack to allow doc/DocBookLocal.py to
32 # import this file in order to extrac the documentation from each
33 # exported function. A better approach will involve more extensive code
36 except: import logger as database
38 except: import logger as sliver_vs
39 import ticket as ticket_module
42 deliver_ticket = None # set in sm.py:start()
47 def export_to_api(nargs):
49 nargs_dict[method.__name__] = nargs
50 api_method_dict[method.__name__] = method
54 def export_to_docbook(**kwargs):
67 # Inspect method. Remove self from the argument list.
68 max_args = method.func_code.co_varnames[0:method.func_code.co_argcount]
69 defaults = method.func_defaults
72 min_args = max_args[0:len(max_args) - len(defaults)]
74 defaults = tuple([None for arg in min_args]) + defaults
75 return (min_args, max_args, defaults)
77 keywords['name'] = method.__name__
78 keywords['args'] = args
80 method.__setattr__(arg, keywords[arg])
83 method.__setattr__(arg, kwargs[arg])
94 @export_to_docbook(roles=['self'],
96 returns=Parameter([], 'A list of supported functions'))
99 """Get a list of functions currently supported by the Node Manager API"""
100 return ''.join([method.__doc__ + '\n' for method in api_method_dict.itervalues()])
102 @export_to_docbook(roles=['self'],
103 accepts=[Parameter(str, 'A ticket returned from GetSliceTicket()')],
104 returns=Parameter(int, '1 if successful'))
107 """The Node Manager periodically polls the PLC API for a list of all
108 slices that are allowed to exist on the given node. Before
109 actions are performed on a delegated slice (such as creation),
110 a controller slice must deliver a valid slice ticket to NM.
112 This ticket is the value retured by PLC's GetSliceTicket() API call,
115 data = ticket_module.verify(ticket)
116 name = data['slivers'][0]['name']
119 logger.log('Ticket delivered for %s' % name)
120 Create(database.db.get(name))
121 except Exception, err:
122 raise xmlrpclib.Fault(102, 'Ticket error: ' + str(err))
124 @export_to_docbook(roles=['self'],
126 returns={'sliver_name' : Parameter(int, 'the associated xid')})
129 """Return an dictionary mapping Slice names to XIDs"""
130 return dict([(pwent[0], pwent[2]) for pwent in pwd.getpwall() if pwent[6] == sliver_vs.Sliver_VS.SHELL])
132 @export_to_docbook(roles=['self'],
134 returns={ 'sliver_name' : Parameter(str, 'the associated SSHKey')})
137 """Return an dictionary mapping slice names to SSH keys"""
139 for rec in database.db.itervalues():
141 keydict[rec['name']] = rec['keys']
144 @export_to_docbook(roles=['nm-controller', 'self'],
145 accepts=[Parameter(str, 'A sliver/slice name.')],
146 returns=Parameter(int, '1 if successful'))
148 def Create(sliver_name):
149 """Create a non-PLC-instantiated sliver"""
151 if rec['instantiation'] == 'delegated': accounts.get(rec['name']).ensure_created(rec)
153 @export_to_docbook(roles=['nm-controller', 'self'],
154 accepts=[Parameter(str, 'A sliver/slice name.')],
155 returns=Parameter(int, '1 if successful'))
157 def Destroy(sliver_name):
158 """Destroy a non-PLC-instantiated sliver"""
160 if rec['instantiation'] == 'delegated': accounts.get(rec['name']).ensure_destroyed()
162 @export_to_docbook(roles=['nm-controller', 'self'],
163 accepts=[Parameter(str, 'A sliver/slice name.')],
164 returns=Parameter(int, '1 if successful'))
166 def Start(sliver_name):
167 """Run start scripts belonging to the specified sliver"""
169 accounts.get(rec['name']).start()
171 @export_to_docbook(roles=['nm-controller', 'self'],
172 accepts=[Parameter(str, 'A sliver/slice name.')],
173 returns=Parameter(int, '1 if successful'))
175 def Stop(sliver_name):
176 """Kill all processes belonging to the specified sliver"""
178 accounts.get(rec['name']).stop()
180 @export_to_docbook(roles=['nm-controller', 'self'],
181 accepts=[Parameter(str, 'A sliver/slice name.')],
182 returns=Parameter(int, '1 if successful'))
185 def ReCreate(sliver_name):
186 """Stop, Destroy, Create, Start sliver in order to reinstall it."""
191 @export_to_docbook(roles=['nm-controller', 'self'],
192 accepts=[Parameter(str, 'A sliver/slice name.')],
193 returns=Parameter(dict, "A resource specification"))
195 def GetEffectiveRSpec(sliver_name):
196 """Return the RSpec allocated to the specified sliver, including loans"""
198 return rec.get('_rspec', {}).copy()
200 @export_to_docbook(roles=['nm-controller', 'self'],
201 accepts=[Parameter(str, 'A sliver/slice name.')],
203 "resource name" : Parameter(int, "amount")
207 def GetRSpec(sliver_name):
208 """Return the RSpec allocated to the specified sliver, excluding loans"""
210 return rec.get('rspec', {}).copy()
212 @export_to_docbook(roles=['nm-controller', 'self'],
213 accepts=[Parameter(str, 'A sliver/slice name.')],
214 returns=[Mixed(Parameter(str, 'recipient slice name'),
215 Parameter(str, 'resource name'),
216 Parameter(int, 'resource amount'))]
219 def GetLoans(sliver_name):
220 """Return the list of loans made by the specified sliver"""
222 return rec.get('_loans', [])[:]
224 def validate_loans(obj):
225 """Check that <obj> is a valid loan specification."""
226 def validate_loan(obj): return (type(obj)==list or type(obj)==tuple) and len(obj)==3 and type(obj[0])==str and type(obj[1])==str and obj[1] in database.LOANABLE_RESOURCES and type(obj[2])==int and obj[2]>=0
227 return type(obj)==list and False not in map(validate_loan, obj)
229 @export_to_docbook(roles=['nm-controller', 'self'],
230 accepts=[ Parameter(str, 'A sliver/slice name.'),
231 [Mixed(Parameter(str, 'recipient slice name'),
232 Parameter(str, 'resource name'),
233 Parameter(int, 'resource amount'))] ],
234 returns=Parameter(int, '1 if successful'))
236 def SetLoans(sliver_name, loans):
237 """Overwrite the list of loans made by the specified sliver.
239 Also, note that SetLoans will not throw an error if more capacity than the
240 RSpec is handed out, but it will silently discard those loans that would
241 put it over capacity. This behavior may be replaced with error semantics
242 in the future. As well, there is currently no asynchronous notification
243 of loss of resources.
246 if not validate_loans(loans): raise xmlrpclib.Fault(102, 'Invalid argument: the second argument must be a well-formed loan specification')
247 rec['_loans'] = loans