]>
git.proxmox.com Git - ceph.git/blob - ceph/src/pybind/mgr/restful/module.py
a2d6793eaf2d1fae8da7c61c2e50c8458172d8d4
4 from __future__
import absolute_import
20 from uuid
import uuid4
21 from pecan
import jsonify
, make_app
22 from OpenSSL
import crypto
23 from pecan
.rest
import RestController
24 from six
import iteritems
25 from werkzeug
.serving
import make_server
, make_ssl_devcert
27 from .hooks
import ErrorHook
28 from mgr_module
import MgrModule
, CommandResult
31 class CannotServe(Exception):
35 class CommandsRequest(object):
37 This class handles parallel as well as sequential execution of
38 commands. The class accept a list of iterables that should be
39 executed sequentially. Each iterable can contain several commands
40 that can be executed in parallel.
44 - run c1 and c2 in parallel
45 - wait for them to finish
46 - run c3 and c4 in parallel
47 - wait for them to finish
51 def __init__(self
, commands_arrays
):
52 self
.id = str(id(self
))
54 # Filter out empty sub-requests
55 commands_arrays
= [x
for x
in commands_arrays
59 self
.waiting
= commands_arrays
[1:]
63 self
.lock
= threading
.RLock()
64 if not len(commands_arrays
):
68 # Process first iteration of commands_arrays in parallel
69 results
= self
.run(commands_arrays
[0])
71 self
.running
.extend(results
)
74 def run(self
, commands
):
76 A static method that will execute the given list of commands in
77 parallel and will return the list of command results.
80 # Gather the results (in parallel)
82 for index
in range(len(commands
)):
83 tag
= '%s:%s:%d' % (__name__
, self
.id, index
)
86 result
= CommandResult(tag
)
87 result
.command
= common
.humanify_command(commands
[index
])
88 results
.append(result
)
91 context
.instance
.send_command(result
, 'mon', '', json
.dumps(commands
[index
]), tag
)
102 # Run a next iteration of commands
103 commands
= self
.waiting
[0]
104 self
.waiting
= self
.waiting
[1:]
106 self
.running
.extend(self
.run(commands
))
109 def finish(self
, tag
):
111 for index
in range(len(self
.running
)):
112 if self
.running
[index
].tag
== tag
:
113 if self
.running
[index
].r
== 0:
114 self
.finished
.append(self
.running
.pop(index
))
116 self
.failed
.append(self
.running
.pop(index
))
123 def is_running(self
, tag
):
124 for result
in self
.running
:
125 if result
.tag
== tag
:
132 return not self
.running
and self
.waiting
135 def is_waiting(self
):
136 return bool(self
.waiting
)
139 def is_finished(self
):
141 return not self
.running
and not self
.waiting
144 def has_failed(self
):
145 return bool(self
.failed
)
150 if not self
.is_finished():
153 if self
.has_failed():
164 'command': x
.command
,
172 'command': x
.command
,
180 lambda y
: common
.humanify_command(y
),
187 'command': x
.command
,
193 'is_waiting': self
.is_waiting(),
194 'is_finished': self
.is_finished(),
195 'has_failed': self
.has_failed(),
196 'state': self
.get_state(),
201 class Module(MgrModule
):
203 {'name': 'server_addr'},
204 {'name': 'server_port'},
205 {'name': 'key_file'},
210 "cmd": "restful create-key name=key_name,type=CephString",
211 "desc": "Create an API key with this name",
215 "cmd": "restful delete-key name=key_name,type=CephString",
216 "desc": "Delete an API key with this name",
220 "cmd": "restful list-keys",
221 "desc": "List all API keys",
225 "cmd": "restful create-self-signed-cert",
226 "desc": "Create localized self signed certificate",
230 "cmd": "restful restart",
231 "desc": "Restart API server",
236 def __init__(self
, *args
, **kwargs
):
237 super(Module
, self
).__init
__(*args
, **kwargs
)
238 context
.instance
= self
241 self
.requests_lock
= threading
.RLock()
244 self
.disable_auth
= False
248 self
.stop_server
= False
249 self
.serve_event
= threading
.Event()
253 while not self
.stop_server
:
256 self
.server
.socket
.close()
257 except CannotServe
as cs
:
258 self
.log
.warn("server not running: %s", cs
)
260 self
.log
.error(str(traceback
.format_exc()))
262 # Wait and clear the threading event
263 self
.serve_event
.wait()
264 self
.serve_event
.clear()
266 def refresh_keys(self
):
268 rawkeys
= self
.get_store_prefix('keys/') or {}
269 for k
, v
in six
.iteritems(rawkeys
):
270 self
.keys
[k
[5:]] = v
# strip of keys/ prefix
273 # Load stored authentication keys
276 jsonify
._instance
= jsonify
.GenericJSON(
279 separators
=(',', ': '),
282 server_addr
= self
.get_localized_module_option('server_addr', '::')
283 if server_addr
is None:
284 raise CannotServe('no server_addr configured; try "ceph config-key set mgr/restful/server_addr <ip>"')
286 server_port
= int(self
.get_localized_module_option('server_port', '8003'))
287 self
.log
.info('server_addr: %s server_port: %d',
288 server_addr
, server_port
)
290 cert
= self
.get_localized_store("crt")
292 cert_tmp
= tempfile
.NamedTemporaryFile()
293 cert_tmp
.write(cert
.encode('utf-8'))
295 cert_fname
= cert_tmp
.name
297 cert_fname
= self
.get_localized_store('crt_file')
299 pkey
= self
.get_localized_store("key")
301 pkey_tmp
= tempfile
.NamedTemporaryFile()
302 pkey_tmp
.write(pkey
.encode('utf-8'))
304 pkey_fname
= pkey_tmp
.name
306 pkey_fname
= self
.get_localized_module_option('key_file')
308 if not cert_fname
or not pkey_fname
:
309 raise CannotServe('no certificate configured')
310 if not os
.path
.isfile(cert_fname
):
311 raise CannotServe('certificate %s does not exist' % cert_fname
)
312 if not os
.path
.isfile(pkey_fname
):
313 raise CannotServe('private key %s does not exist' % pkey_fname
)
315 # Publish the URI that others may use to access the service we're
316 # about to start serving
317 self
.set_uri("https://{0}:{1}/".format(
318 socket
.gethostname() if server_addr
== "::" else server_addr
,
322 # Create the HTTPS werkzeug server serving pecan app
323 self
.server
= make_server(
327 root
='restful.api.Root',
328 hooks
= [ErrorHook()], # use a callable if pecan >= 0.3.2
330 ssl_context
=(cert_fname
, pkey_fname
),
333 self
.server
.serve_forever()
338 self
.stop_server
= True
340 self
.server
.shutdown()
341 self
.serve_event
.set()
343 self
.log
.error(str(traceback
.format_exc()))
350 self
.server
.shutdown()
351 self
.serve_event
.set()
353 self
.log
.error(str(traceback
.format_exc()))
356 def notify(self
, notify_type
, tag
):
358 self
._notify
(notify_type
, tag
)
360 self
.log
.error(str(traceback
.format_exc()))
363 def _notify(self
, notify_type
, tag
):
364 if notify_type
!= "command":
365 self
.log
.debug("Unhandled notification type '%s'", notify_type
)
367 # we can safely skip all the sequential commands
371 with self
.requests_lock
:
372 request
= next(x
for x
in self
.requests
if x
.is_running(tag
))
374 if request
.is_ready():
376 except StopIteration:
377 # the command was not issued by me
381 def create_self_signed_cert(self
):
384 pkey
.generate_key(crypto
.TYPE_RSA
, 2048)
386 # create a self-signed cert
388 cert
.get_subject().O
= "IT"
389 cert
.get_subject().CN
= "ceph-restful"
390 cert
.set_serial_number(int(uuid4()))
391 cert
.gmtime_adj_notBefore(0)
392 cert
.gmtime_adj_notAfter(10*365*24*60*60)
393 cert
.set_issuer(cert
.get_subject())
394 cert
.set_pubkey(pkey
)
395 cert
.sign(pkey
, 'sha512')
398 crypto
.dump_certificate(crypto
.FILETYPE_PEM
, cert
),
399 crypto
.dump_privatekey(crypto
.FILETYPE_PEM
, pkey
)
403 def handle_command(self
, inbuf
, command
):
404 self
.log
.warn("Handling command: '%s'" % str(command
))
405 if command
['prefix'] == "restful create-key":
406 if command
['key_name'] in self
.keys
:
407 return 0, self
.keys
[command
['key_name']], ""
411 self
.keys
[command
['key_name']] = key
412 self
.set_store('keys/' + command
['key_name'], key
)
416 self
.keys
[command
['key_name']],
420 elif command
['prefix'] == "restful delete-key":
421 if command
['key_name'] in self
.keys
:
422 del self
.keys
[command
['key_name']]
423 self
.set_store('keys/' + command
['key_name'], None)
431 elif command
['prefix'] == "restful list-keys":
435 json
.dumps(self
.keys
, indent
=2),
439 elif command
['prefix'] == "restful create-self-signed-cert":
440 cert
, pkey
= self
.create_self_signed_cert()
441 self
.set_store(self
.get_mgr_id() + '/crt', cert
.decode('utf-8'))
442 self
.set_store(self
.get_mgr_id() + '/key', pkey
.decode('utf-8'))
447 "Restarting RESTful API server...",
451 elif command
['prefix'] == 'restful restart':
455 "Restarting RESTful API server...",
463 "Command not found '{0}'".format(command
['prefix'])
467 def get_doc_api(self
, root
, prefix
=''):
469 for _obj
in dir(root
):
470 obj
= getattr(root
, _obj
)
472 if isinstance(obj
, RestController
):
473 doc
.update(self
.get_doc_api(obj
, prefix
+ '/' + _obj
))
475 if getattr(root
, '_lookup', None) and isinstance(root
._lookup
('0')[0], RestController
):
476 doc
.update(self
.get_doc_api(root
._lookup
('0')[0], prefix
+ '/<arg>'))
478 prefix
= prefix
or '/'
481 for method
in 'get', 'post', 'patch', 'delete':
482 if getattr(root
, method
, None):
483 doc
[prefix
][method
.upper()] = inspect
.getdoc(getattr(root
, method
)).split('\n')
485 if len(doc
[prefix
]) == 0:
492 mon_map_mons
= self
.get('mon_map')['mons']
493 mon_status
= json
.loads(self
.get('mon_status')['json'])
495 # Add more information
496 for mon
in mon_map_mons
:
497 mon
['in_quorum'] = mon
['rank'] in mon_status
['quorum']
498 mon
['server'] = self
.get_metadata("mon", mon
['name'])['hostname']
499 mon
['leader'] = mon
['rank'] == mon_status
['quorum'][0]
504 def get_osd_pools(self
):
505 osds
= dict(map(lambda x
: (x
['osd'], []), self
.get('osd_map')['osds']))
506 pools
= dict(map(lambda x
: (x
['pool'], x
), self
.get('osd_map')['pools']))
507 crush
= self
.get('osd_map_crush')
508 crush_rules
= crush
['rules']
511 for pool_id
, pool
in pools
.items():
513 for rule
in [r
for r
in crush_rules
if r
['rule_id'] == pool
['crush_rule']]:
514 if rule
['min_size'] <= pool
['size'] <= rule
['max_size']:
515 pool_osds
= common
.crush_rule_osds(crush
['buckets'], rule
)
517 osds_by_pool
[pool_id
] = pool_osds
519 for pool_id
in pools
.keys():
520 for in_pool_id
in osds_by_pool
[pool_id
]:
521 osds
[in_pool_id
].append(pool_id
)
526 def get_osds(self
, pool_id
=None, ids
=None):
528 osd_map
= self
.get('osd_map')
529 osd_metadata
= self
.get('osd_metadata')
531 # Update the data with the additional info from the osd map
532 osds
= osd_map
['osds']
536 osds
= [x
for x
in osds
if str(x
['osd']) in ids
]
538 # Get list of pools per osd node
539 pools_map
= self
.get_osd_pools()
541 # map osd IDs to reweight
542 reweight_map
= dict([
543 (x
.get('id'), x
.get('reweight', None))
544 for x
in self
.get('osd_map_tree')['nodes']
547 # Build OSD data objects
549 osd
['pools'] = pools_map
[osd
['osd']]
550 osd
['server'] = osd_metadata
.get(str(osd
['osd']), {}).get('hostname', None)
552 osd
['reweight'] = reweight_map
.get(osd
['osd'], 0.0)
555 osd
['valid_commands'] = common
.OSD_IMPLEMENTED_COMMANDS
557 osd
['valid_commands'] = []
561 pool_id
= int(pool_id
)
562 osds
= [x
for x
in osds
if pool_id
in x
['pools']]
567 def get_osd_by_id(self
, osd_id
):
568 osd
= [x
for x
in self
.get('osd_map')['osds']
569 if x
['osd'] == osd_id
]
577 def get_pool_by_id(self
, pool_id
):
578 pool
= [x
for x
in self
.get('osd_map')['pools']
579 if x
['pool'] == pool_id
]
587 def submit_request(self
, _request
, **kwargs
):
588 with self
.requests_lock
:
589 request
= CommandsRequest(_request
)
590 self
.requests
.append(request
)
591 if kwargs
.get('wait', 0):
592 while not request
.is_finished():
597 def run_command(self
, command
):
598 # tag with 'seq' so that we can ignore these in notify function
599 result
= CommandResult('seq')
601 self
.send_command(result
, 'mon', '', json
.dumps(command
), 'seq')