]>
git.proxmox.com Git - ceph.git/blob - ceph/src/pybind/mgr/restful/module.py
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 werkzeug
.serving
import make_server
, make_ssl_devcert
26 from .hooks
import ErrorHook
27 from mgr_module
import MgrModule
, CommandResult
30 class CannotServe(Exception):
34 class CommandsRequest(object):
36 This class handles parallel as well as sequential execution of
37 commands. The class accept a list of iterables that should be
38 executed sequentially. Each iterable can contain several commands
39 that can be executed in parallel.
43 - run c1 and c2 in parallel
44 - wait for them to finish
45 - run c3 and c4 in parallel
46 - wait for them to finish
50 def __init__(self
, commands_arrays
):
51 self
.id = str(id(self
))
53 # Filter out empty sub-requests
54 commands_arrays
= [x
for x
in commands_arrays
58 self
.waiting
= commands_arrays
[1:]
62 self
.lock
= threading
.RLock()
63 if not len(commands_arrays
):
67 # Process first iteration of commands_arrays in parallel
68 results
= self
.run(commands_arrays
[0])
70 self
.running
.extend(results
)
73 def run(self
, commands
):
75 A static method that will execute the given list of commands in
76 parallel and will return the list of command results.
79 # Gather the results (in parallel)
81 for index
, command
in enumerate(commands
):
82 tag
= '%s:%s:%d' % (__name__
, self
.id, index
)
85 result
= CommandResult(tag
)
86 result
.command
= common
.humanify_command(command
)
87 results
.append(result
)
90 context
.instance
.send_command(result
, 'mon', '', json
.dumps(command
), tag
)
101 # Run a next iteration of commands
102 commands
= self
.waiting
[0]
103 self
.waiting
= self
.waiting
[1:]
105 self
.running
.extend(self
.run(commands
))
108 def finish(self
, tag
):
110 for index
in range(len(self
.running
)):
111 if self
.running
[index
].tag
== tag
:
112 if self
.running
[index
].r
== 0:
113 self
.finished
.append(self
.running
.pop(index
))
115 self
.failed
.append(self
.running
.pop(index
))
122 def is_running(self
, tag
):
123 for result
in self
.running
:
124 if result
.tag
== tag
:
131 return not self
.running
and self
.waiting
134 def is_waiting(self
):
135 return bool(self
.waiting
)
138 def is_finished(self
):
140 return not self
.running
and not self
.waiting
143 def has_failed(self
):
144 return bool(self
.failed
)
149 if not self
.is_finished():
152 if self
.has_failed():
163 'command': x
.command
,
166 } for x
in self
.running
170 'command': x
.command
,
173 } for x
in self
.finished
176 [common
.humanify_command(y
) for y
in x
]
177 for x
in self
.waiting
181 'command': x
.command
,
184 } for x
in self
.failed
186 'is_waiting': self
.is_waiting(),
187 'is_finished': self
.is_finished(),
188 'has_failed': self
.has_failed(),
189 'state': self
.get_state(),
194 class Module(MgrModule
):
196 {'name': 'server_addr'},
197 {'name': 'server_port'},
198 {'name': 'key_file'},
199 {'name': 'enable_auth', 'type': 'bool', 'default': True},
204 "cmd": "restful create-key name=key_name,type=CephString",
205 "desc": "Create an API key with this name",
209 "cmd": "restful delete-key name=key_name,type=CephString",
210 "desc": "Delete an API key with this name",
214 "cmd": "restful list-keys",
215 "desc": "List all API keys",
219 "cmd": "restful create-self-signed-cert",
220 "desc": "Create localized self signed certificate",
224 "cmd": "restful restart",
225 "desc": "Restart API server",
230 def __init__(self
, *args
, **kwargs
):
231 super(Module
, self
).__init
__(*args
, **kwargs
)
232 context
.instance
= self
235 self
.requests_lock
= threading
.RLock()
238 self
.enable_auth
= True
242 self
.stop_server
= False
243 self
.serve_event
= threading
.Event()
247 self
.log
.debug('serve enter')
248 while not self
.stop_server
:
251 self
.server
.socket
.close()
252 except CannotServe
as cs
:
253 self
.log
.warning("server not running: %s", cs
)
255 self
.log
.error(str(traceback
.format_exc()))
257 # Wait and clear the threading event
258 self
.serve_event
.wait()
259 self
.serve_event
.clear()
260 self
.log
.debug('serve exit')
262 def refresh_keys(self
):
264 rawkeys
= self
.get_store_prefix('keys/') or {}
265 for k
, v
in rawkeys
.items():
266 self
.keys
[k
[5:]] = v
# strip of keys/ prefix
269 # Load stored authentication keys
272 jsonify
._instance
= jsonify
.GenericJSON(
275 separators
=(',', ': '),
278 server_addr
= self
.get_localized_module_option('server_addr', '::')
279 if server_addr
is None:
280 raise CannotServe('no server_addr configured; try "ceph config-key set mgr/restful/server_addr <ip>"')
282 server_port
= int(self
.get_localized_module_option('server_port', '8003'))
283 self
.log
.info('server_addr: %s server_port: %d',
284 server_addr
, server_port
)
286 cert
= self
.get_localized_store("crt")
288 cert_tmp
= tempfile
.NamedTemporaryFile()
289 cert_tmp
.write(cert
.encode('utf-8'))
291 cert_fname
= cert_tmp
.name
293 cert_fname
= self
.get_localized_store('crt_file')
295 pkey
= self
.get_localized_store("key")
297 pkey_tmp
= tempfile
.NamedTemporaryFile()
298 pkey_tmp
.write(pkey
.encode('utf-8'))
300 pkey_fname
= pkey_tmp
.name
302 pkey_fname
= self
.get_localized_module_option('key_file')
304 self
.enable_auth
= self
.get_localized_module_option('enable_auth', True)
306 if not cert_fname
or not pkey_fname
:
307 raise CannotServe('no certificate configured')
308 if not os
.path
.isfile(cert_fname
):
309 raise CannotServe('certificate %s does not exist' % cert_fname
)
310 if not os
.path
.isfile(pkey_fname
):
311 raise CannotServe('private key %s does not exist' % pkey_fname
)
313 # Publish the URI that others may use to access the service we're
314 # about to start serving
315 self
.set_uri("https://{0}:{1}/".format(
316 self
.get_mgr_ip() if server_addr
== "::" else server_addr
,
320 # Create the HTTPS werkzeug server serving pecan app
321 self
.server
= make_server(
325 root
='restful.api.Root',
326 hooks
= [ErrorHook()], # use a callable if pecan >= 0.3.2
328 ssl_context
=(cert_fname
, pkey_fname
),
330 sock_fd_flag
= fcntl
.fcntl(self
.server
.socket
.fileno(), fcntl
.F_GETFD
)
331 if not (sock_fd_flag
& fcntl
.FD_CLOEXEC
):
332 self
.log
.debug("set server socket close-on-exec")
333 fcntl
.fcntl(self
.server
.socket
.fileno(), fcntl
.F_SETFD
, sock_fd_flag | fcntl
.FD_CLOEXEC
)
335 self
.log
.debug('made server, but stop flag set')
337 self
.log
.debug('made server, serving forever')
338 self
.server
.serve_forever()
342 self
.log
.debug('shutdown enter')
344 self
.stop_server
= True
346 self
.log
.debug('calling server.shutdown')
347 self
.server
.shutdown()
348 self
.log
.debug('called server.shutdown')
349 self
.serve_event
.set()
351 self
.log
.error(str(traceback
.format_exc()))
353 self
.log
.debug('shutdown exit')
359 self
.server
.shutdown()
360 self
.serve_event
.set()
362 self
.log
.error(str(traceback
.format_exc()))
365 def notify(self
, notify_type
, tag
):
367 self
._notify
(notify_type
, tag
)
369 self
.log
.error(str(traceback
.format_exc()))
372 def _notify(self
, notify_type
, tag
):
373 if notify_type
!= "command":
374 self
.log
.debug("Unhandled notification type '%s'", notify_type
)
376 # we can safely skip all the sequential commands
380 with self
.requests_lock
:
381 request
= next(x
for x
in self
.requests
if x
.is_running(tag
))
383 if request
.is_ready():
385 except StopIteration:
386 # the command was not issued by me
389 def config_notify(self
):
390 self
.enable_auth
= self
.get_localized_module_option('enable_auth', True)
393 def create_self_signed_cert(self
):
396 pkey
.generate_key(crypto
.TYPE_RSA
, 2048)
398 # create a self-signed cert
400 cert
.get_subject().O
= "IT"
401 cert
.get_subject().CN
= "ceph-restful"
402 cert
.set_serial_number(int(uuid4()))
403 cert
.gmtime_adj_notBefore(0)
404 cert
.gmtime_adj_notAfter(10*365*24*60*60)
405 cert
.set_issuer(cert
.get_subject())
406 cert
.set_pubkey(pkey
)
407 cert
.sign(pkey
, 'sha512')
410 crypto
.dump_certificate(crypto
.FILETYPE_PEM
, cert
),
411 crypto
.dump_privatekey(crypto
.FILETYPE_PEM
, pkey
)
415 def handle_command(self
, inbuf
, command
):
416 self
.log
.warning("Handling command: '%s'" % str(command
))
417 if command
['prefix'] == "restful create-key":
418 if command
['key_name'] in self
.keys
:
419 return 0, self
.keys
[command
['key_name']], ""
423 self
.keys
[command
['key_name']] = key
424 self
.set_store('keys/' + command
['key_name'], key
)
428 self
.keys
[command
['key_name']],
432 elif command
['prefix'] == "restful delete-key":
433 if command
['key_name'] in self
.keys
:
434 del self
.keys
[command
['key_name']]
435 self
.set_store('keys/' + command
['key_name'], None)
443 elif command
['prefix'] == "restful list-keys":
447 json
.dumps(self
.keys
, indent
=4, sort_keys
=True),
451 elif command
['prefix'] == "restful create-self-signed-cert":
452 cert
, pkey
= self
.create_self_signed_cert()
453 self
.set_store(self
.get_mgr_id() + '/crt', cert
.decode('utf-8'))
454 self
.set_store(self
.get_mgr_id() + '/key', pkey
.decode('utf-8'))
459 "Restarting RESTful API server...",
463 elif command
['prefix'] == 'restful restart':
467 "Restarting RESTful API server...",
475 "Command not found '{0}'".format(command
['prefix'])
479 def get_doc_api(self
, root
, prefix
=''):
481 for _obj
in dir(root
):
482 obj
= getattr(root
, _obj
)
484 if isinstance(obj
, RestController
):
485 doc
.update(self
.get_doc_api(obj
, prefix
+ '/' + _obj
))
487 if getattr(root
, '_lookup', None) and isinstance(root
._lookup
('0')[0], RestController
):
488 doc
.update(self
.get_doc_api(root
._lookup
('0')[0], prefix
+ '/<arg>'))
490 prefix
= prefix
or '/'
493 for method
in 'get', 'post', 'patch', 'delete':
494 if getattr(root
, method
, None):
495 doc
[prefix
][method
.upper()] = inspect
.getdoc(getattr(root
, method
)).split('\n')
497 if len(doc
[prefix
]) == 0:
504 mon_map_mons
= self
.get('mon_map')['mons']
505 mon_status
= json
.loads(self
.get('mon_status')['json'])
507 # Add more information
508 for mon
in mon_map_mons
:
509 mon
['in_quorum'] = mon
['rank'] in mon_status
['quorum']
510 mon
['server'] = self
.get_metadata("mon", mon
['name'])['hostname']
511 mon
['leader'] = mon
['rank'] == mon_status
['quorum'][0]
516 def get_osd_pools(self
):
517 osds
= dict(map(lambda x
: (x
['osd'], []), self
.get('osd_map')['osds']))
518 pools
= dict(map(lambda x
: (x
['pool'], x
), self
.get('osd_map')['pools']))
519 crush
= self
.get('osd_map_crush')
520 crush_rules
= crush
['rules']
523 for pool_id
, pool
in pools
.items():
525 for rule
in [r
for r
in crush_rules
if r
['rule_id'] == pool
['crush_rule']]:
526 if rule
['min_size'] <= pool
['size'] <= rule
['max_size']:
527 pool_osds
= common
.crush_rule_osds(crush
['buckets'], rule
)
529 osds_by_pool
[pool_id
] = pool_osds
531 for pool_id
in pools
.keys():
532 for in_pool_id
in osds_by_pool
[pool_id
]:
533 osds
[in_pool_id
].append(pool_id
)
538 def get_osds(self
, pool_id
=None, ids
=None):
540 osd_map
= self
.get('osd_map')
541 osd_metadata
= self
.get('osd_metadata')
543 # Update the data with the additional info from the osd map
544 osds
= osd_map
['osds']
548 osds
= [x
for x
in osds
if str(x
['osd']) in ids
]
550 # Get list of pools per osd node
551 pools_map
= self
.get_osd_pools()
553 # map osd IDs to reweight
554 reweight_map
= dict([
555 (x
.get('id'), x
.get('reweight', None))
556 for x
in self
.get('osd_map_tree')['nodes']
559 # Build OSD data objects
561 osd
['pools'] = pools_map
[osd
['osd']]
562 osd
['server'] = osd_metadata
.get(str(osd
['osd']), {}).get('hostname', None)
564 osd
['reweight'] = reweight_map
.get(osd
['osd'], 0.0)
567 osd
['valid_commands'] = common
.OSD_IMPLEMENTED_COMMANDS
569 osd
['valid_commands'] = []
573 pool_id
= int(pool_id
)
574 osds
= [x
for x
in osds
if pool_id
in x
['pools']]
579 def get_osd_by_id(self
, osd_id
):
580 osd
= [x
for x
in self
.get('osd_map')['osds']
581 if x
['osd'] == osd_id
]
589 def get_pool_by_id(self
, pool_id
):
590 pool
= [x
for x
in self
.get('osd_map')['pools']
591 if x
['pool'] == pool_id
]
599 def submit_request(self
, _request
, **kwargs
):
600 with self
.requests_lock
:
601 request
= CommandsRequest(_request
)
602 self
.requests
.append(request
)
603 if kwargs
.get('wait', 0):
604 while not request
.is_finished():
609 def run_command(self
, command
):
610 # tag with 'seq' so that we can ignore these in notify function
611 result
= CommandResult('seq')
613 self
.send_command(result
, 'mon', '', json
.dumps(command
), 'seq')