]>
Commit | Line | Data |
---|---|---|
31f18b77 FG |
1 | """ |
2 | A RESTful API for Ceph | |
3 | """ | |
4 | ||
5 | import os | |
6 | import json | |
7 | import time | |
8 | import errno | |
9 | import inspect | |
10 | import tempfile | |
11 | import threading | |
12 | import traceback | |
13 | ||
14 | import common | |
15 | ||
16 | from uuid import uuid4 | |
17 | from pecan import jsonify, make_app | |
18 | from OpenSSL import crypto | |
19 | from pecan.rest import RestController | |
20 | from werkzeug.serving import make_server, make_ssl_devcert | |
21 | ||
22 | from hooks import ErrorHook | |
23 | from mgr_module import MgrModule, CommandResult | |
24 | ||
25 | # Global instance to share | |
26 | instance = None | |
27 | ||
28 | ||
29 | ||
30 | class CommandsRequest(object): | |
31 | """ | |
32 | This class handles parallel as well as sequential execution of | |
33 | commands. The class accept a list of iterables that should be | |
34 | executed sequentially. Each iterable can contain several commands | |
35 | that can be executed in parallel. | |
36 | ||
37 | Example: | |
38 | [[c1,c2],[c3,c4]] | |
39 | - run c1 and c2 in parallel | |
40 | - wait for them to finish | |
41 | - run c3 and c4 in parallel | |
42 | - wait for them to finish | |
43 | """ | |
44 | ||
45 | ||
46 | def __init__(self, commands_arrays): | |
47 | self.id = str(id(self)) | |
48 | ||
49 | # Filter out empty sub-requests | |
50 | commands_arrays = filter( | |
51 | lambda x: len(x) != 0, | |
52 | commands_arrays, | |
53 | ) | |
54 | ||
55 | self.running = [] | |
56 | self.waiting = commands_arrays[1:] | |
57 | self.finished = [] | |
58 | self.failed = [] | |
59 | ||
60 | self.lock = threading.RLock() | |
61 | if not len(commands_arrays): | |
62 | # Nothing to run | |
63 | return | |
64 | ||
65 | # Process first iteration of commands_arrays in parallel | |
66 | results = self.run(commands_arrays[0]) | |
67 | ||
68 | self.running.extend(results) | |
69 | ||
70 | ||
71 | def run(self, commands): | |
72 | """ | |
73 | A static method that will execute the given list of commands in | |
74 | parallel and will return the list of command results. | |
75 | """ | |
76 | ||
77 | # Gather the results (in parallel) | |
78 | results = [] | |
79 | for index in range(len(commands)): | |
80 | tag = '%s:%d' % (str(self.id), index) | |
81 | ||
82 | # Store the result | |
83 | result = CommandResult(tag) | |
84 | result.command = common.humanify_command(commands[index]) | |
85 | results.append(result) | |
86 | ||
87 | # Run the command | |
88 | instance.send_command(result, 'mon', '', json.dumps(commands[index]), tag) | |
89 | ||
90 | return results | |
91 | ||
92 | ||
93 | def next(self): | |
94 | with self.lock: | |
95 | if not self.waiting: | |
96 | # Nothing to run | |
97 | return | |
98 | ||
99 | # Run a next iteration of commands | |
100 | commands = self.waiting[0] | |
101 | self.waiting = self.waiting[1:] | |
102 | ||
103 | self.running.extend(self.run(commands)) | |
104 | ||
105 | ||
106 | def finish(self, tag): | |
107 | with self.lock: | |
108 | for index in range(len(self.running)): | |
109 | if self.running[index].tag == tag: | |
110 | if self.running[index].r == 0: | |
111 | self.finished.append(self.running.pop(index)) | |
112 | else: | |
113 | self.failed.append(self.running.pop(index)) | |
114 | return True | |
115 | ||
116 | # No such tag found | |
117 | return False | |
118 | ||
119 | ||
120 | def is_running(self, tag): | |
121 | for result in self.running: | |
122 | if result.tag == tag: | |
123 | return True | |
124 | return False | |
125 | ||
126 | ||
127 | def is_ready(self): | |
128 | with self.lock: | |
129 | return not self.running and self.waiting | |
130 | ||
131 | ||
132 | def is_waiting(self): | |
133 | return bool(self.waiting) | |
134 | ||
135 | ||
136 | def is_finished(self): | |
137 | with self.lock: | |
138 | return not self.running and not self.waiting | |
139 | ||
140 | ||
141 | def has_failed(self): | |
142 | return bool(self.failed) | |
143 | ||
144 | ||
145 | def get_state(self): | |
146 | with self.lock: | |
147 | if not self.is_finished(): | |
148 | return "pending" | |
149 | ||
150 | if self.has_failed(): | |
151 | return "failed" | |
152 | ||
153 | return "success" | |
154 | ||
155 | ||
156 | def __json__(self): | |
157 | return { | |
158 | 'id': self.id, | |
159 | 'running': map( | |
160 | lambda x: { | |
161 | 'command': x.command, | |
162 | 'outs': x.outs, | |
163 | 'outb': x.outb, | |
164 | }, | |
165 | self.running | |
166 | ), | |
167 | 'finished': map( | |
168 | lambda x: { | |
169 | 'command': x.command, | |
170 | 'outs': x.outs, | |
171 | 'outb': x.outb, | |
172 | }, | |
173 | self.finished | |
174 | ), | |
175 | 'waiting': map( | |
176 | lambda x: { | |
177 | 'command': x.command, | |
178 | 'outs': x.outs, | |
179 | 'outb': x.outb, | |
180 | }, | |
181 | self.waiting | |
182 | ), | |
183 | 'failed': map( | |
184 | lambda x: { | |
185 | 'command': x.command, | |
186 | 'outs': x.outs, | |
187 | 'outb': x.outb, | |
188 | }, | |
189 | self.failed | |
190 | ), | |
191 | 'is_waiting': self.is_waiting(), | |
192 | 'is_finished': self.is_finished(), | |
193 | 'has_failed': self.has_failed(), | |
194 | 'state': self.get_state(), | |
195 | } | |
196 | ||
197 | ||
198 | ||
199 | class Module(MgrModule): | |
200 | COMMANDS = [ | |
201 | { | |
202 | "cmd": "restful create-key name=key_name,type=CephString", | |
203 | "desc": "Create an API key with this name", | |
204 | "perm": "rw" | |
205 | }, | |
206 | { | |
207 | "cmd": "restful delete-key name=key_name,type=CephString", | |
208 | "desc": "Delete an API key with this name", | |
209 | "perm": "rw" | |
210 | }, | |
211 | { | |
212 | "cmd": "restful list-keys", | |
213 | "desc": "List all API keys", | |
214 | "perm": "rw" | |
215 | }, | |
216 | { | |
217 | "cmd": "restful create-self-signed-cert", | |
218 | "desc": "Create localized self signed certificate", | |
219 | "perm": "rw" | |
220 | }, | |
221 | { | |
222 | "cmd": "restful restart", | |
223 | "desc": "Restart API server", | |
224 | "perm": "rw" | |
225 | }, | |
226 | ] | |
227 | ||
228 | def __init__(self, *args, **kwargs): | |
229 | super(Module, self).__init__(*args, **kwargs) | |
230 | global instance | |
231 | instance = self | |
232 | ||
233 | self.requests = [] | |
234 | self.requests_lock = threading.RLock() | |
235 | ||
236 | self.keys = {} | |
237 | self.disable_auth = False | |
238 | ||
239 | self.server = None | |
240 | ||
241 | self.stop_server = False | |
242 | self.serve_event = threading.Event() | |
243 | ||
244 | ||
245 | def serve(self): | |
246 | while not self.stop_server: | |
247 | try: | |
248 | self._serve() | |
249 | self.server.socket.close() | |
250 | except: | |
251 | self.log.error(str(traceback.format_exc())) | |
252 | ||
253 | # Wait and clear the threading event | |
254 | self.serve_event.wait() | |
255 | self.serve_event.clear() | |
256 | ||
31f18b77 FG |
257 | def refresh_keys(self): |
258 | self.keys = {} | |
259 | rawkeys = self.get_config_prefix('keys/') or {} | |
260 | for k, v in rawkeys.iteritems(): | |
261 | self.keys[k[5:]] = v # strip of keys/ prefix | |
262 | ||
263 | def _serve(self): | |
264 | # Load stored authentication keys | |
265 | self.refresh_keys() | |
266 | ||
267 | jsonify._instance = jsonify.GenericJSON( | |
268 | sort_keys=True, | |
269 | indent=4, | |
270 | separators=(',', ': '), | |
271 | ) | |
272 | ||
224ce89b | 273 | server_addr = self.get_localized_config('server_addr', '::') |
31f18b77 FG |
274 | if server_addr is None: |
275 | raise RuntimeError('no server_addr configured; try "ceph config-key put mgr/restful/server_addr <ip>"') | |
224ce89b | 276 | server_port = int(self.get_localized_config('server_port', '8003')) |
31f18b77 FG |
277 | self.log.info('server_addr: %s server_port: %d', |
278 | server_addr, server_port) | |
279 | ||
280 | cert = self.get_localized_config("crt") | |
281 | if cert is not None: | |
282 | cert_tmp = tempfile.NamedTemporaryFile() | |
283 | cert_tmp.write(cert) | |
284 | cert_tmp.flush() | |
285 | cert_fname = cert_tmp.name | |
286 | else: | |
287 | cert_fname = self.get_localized_config('crt_file') | |
288 | ||
289 | pkey = self.get_localized_config("key") | |
290 | if pkey is not None: | |
291 | pkey_tmp = tempfile.NamedTemporaryFile() | |
292 | pkey_tmp.write(pkey) | |
293 | pkey_tmp.flush() | |
294 | pkey_fname = pkey_tmp.name | |
295 | else: | |
296 | pkey_fname = self.get_localized_config('key_file') | |
297 | ||
298 | if not cert_fname or not pkey_fname: | |
299 | raise RuntimeError('no certificate configured') | |
300 | if not os.path.isfile(cert_fname): | |
301 | raise RuntimeError('certificate %s does not exist' % cert_fname) | |
302 | if not os.path.isfile(pkey_fname): | |
303 | raise RuntimeError('private key %s does not exist' % pkey_fname) | |
304 | ||
305 | # Create the HTTPS werkzeug server serving pecan app | |
306 | self.server = make_server( | |
307 | host=server_addr, | |
308 | port=server_port, | |
309 | app=make_app( | |
310 | root='restful.api.Root', | |
311 | hooks = [ErrorHook()], # use a callable if pecan >= 0.3.2 | |
312 | ), | |
313 | ssl_context=(cert_fname, pkey_fname), | |
314 | ) | |
315 | ||
316 | self.server.serve_forever() | |
317 | ||
318 | ||
319 | def shutdown(self): | |
320 | try: | |
321 | self.stop_server = True | |
322 | if self.server: | |
323 | self.server.shutdown() | |
324 | self.serve_event.set() | |
325 | except: | |
326 | self.log.error(str(traceback.format_exc())) | |
327 | raise | |
328 | ||
329 | ||
330 | def restart(self): | |
331 | try: | |
332 | if self.server: | |
333 | self.server.shutdown() | |
334 | self.serve_event.set() | |
335 | except: | |
336 | self.log.error(str(traceback.format_exc())) | |
337 | ||
338 | ||
339 | def notify(self, notify_type, tag): | |
340 | try: | |
341 | self._notify(notify_type, tag) | |
342 | except: | |
343 | self.log.error(str(traceback.format_exc())) | |
344 | ||
345 | ||
346 | def _notify(self, notify_type, tag): | |
347 | if notify_type == "command": | |
348 | # we can safely skip all the sequential commands | |
349 | if tag == 'seq': | |
350 | return | |
351 | ||
352 | request = filter( | |
353 | lambda x: x.is_running(tag), | |
354 | self.requests) | |
355 | ||
356 | if len(request) != 1: | |
357 | self.log.warn("Unknown request '%s'" % str(tag)) | |
358 | return | |
359 | ||
360 | request = request[0] | |
361 | request.finish(tag) | |
362 | if request.is_ready(): | |
363 | request.next() | |
364 | else: | |
365 | self.log.debug("Unhandled notification type '%s'" % notify_type) | |
366 | ||
367 | ||
368 | def create_self_signed_cert(self): | |
369 | # create a key pair | |
370 | pkey = crypto.PKey() | |
371 | pkey.generate_key(crypto.TYPE_RSA, 2048) | |
372 | ||
373 | # create a self-signed cert | |
374 | cert = crypto.X509() | |
375 | cert.get_subject().O = "IT" | |
376 | cert.get_subject().CN = "ceph-restful" | |
377 | cert.set_serial_number(int(uuid4())) | |
378 | cert.gmtime_adj_notBefore(0) | |
379 | cert.gmtime_adj_notAfter(10*365*24*60*60) | |
380 | cert.set_issuer(cert.get_subject()) | |
381 | cert.set_pubkey(pkey) | |
382 | cert.sign(pkey, 'sha512') | |
383 | ||
384 | return ( | |
385 | crypto.dump_certificate(crypto.FILETYPE_PEM, cert), | |
386 | crypto.dump_privatekey(crypto.FILETYPE_PEM, pkey) | |
387 | ) | |
388 | ||
389 | ||
390 | def handle_command(self, command): | |
391 | self.log.warn("Handling command: '%s'" % str(command)) | |
392 | if command['prefix'] == "restful create-key": | |
393 | if command['key_name'] in self.keys: | |
394 | return 0, self.keys[command['key_name']], "" | |
395 | ||
396 | else: | |
397 | key = str(uuid4()) | |
398 | self.keys[command['key_name']] = key | |
399 | self.set_config('keys/' + command['key_name'], key) | |
400 | ||
401 | return ( | |
402 | 0, | |
403 | self.keys[command['key_name']], | |
404 | "", | |
405 | ) | |
406 | ||
407 | elif command['prefix'] == "restful delete-key": | |
408 | if command['key_name'] in self.keys: | |
409 | del self.keys[command['key_name']] | |
410 | self.set_config('keys/' + command['key_name'], None) | |
411 | ||
412 | return ( | |
413 | 0, | |
414 | "", | |
415 | "", | |
416 | ) | |
417 | ||
418 | elif command['prefix'] == "restful list-keys": | |
419 | self.refresh_keys() | |
420 | return ( | |
421 | 0, | |
422 | json.dumps(self.keys, indent=2), | |
423 | "", | |
424 | ) | |
425 | ||
426 | elif command['prefix'] == "restful create-self-signed-cert": | |
427 | cert, pkey = self.create_self_signed_cert() | |
428 | ||
429 | self.set_config(self.get_mgr_id() + '/crt', cert) | |
430 | self.set_config(self.get_mgr_id() + '/key', pkey) | |
431 | ||
432 | self.restart() | |
433 | return ( | |
434 | 0, | |
435 | "Restarting RESTful API server...", | |
436 | "" | |
437 | ) | |
438 | ||
439 | elif command['prefix'] == 'restful restart': | |
440 | self.restart(); | |
441 | return ( | |
442 | 0, | |
443 | "Restarting RESTful API server...", | |
444 | "" | |
445 | ) | |
446 | ||
447 | else: | |
448 | return ( | |
449 | -errno.EINVAL, | |
450 | "", | |
451 | "Command not found '{0}'".format(command['prefix']) | |
452 | ) | |
453 | ||
454 | ||
455 | def get_doc_api(self, root, prefix=''): | |
456 | doc = {} | |
457 | for _obj in dir(root): | |
458 | obj = getattr(root, _obj) | |
459 | ||
460 | if isinstance(obj, RestController): | |
461 | doc.update(self.get_doc_api(obj, prefix + '/' + _obj)) | |
462 | ||
463 | if getattr(root, '_lookup', None) and isinstance(root._lookup('0')[0], RestController): | |
464 | doc.update(self.get_doc_api(root._lookup('0')[0], prefix + '/<arg>')) | |
465 | ||
466 | prefix = prefix or '/' | |
467 | ||
468 | doc[prefix] = {} | |
469 | for method in 'get', 'post', 'patch', 'delete': | |
470 | if getattr(root, method, None): | |
471 | doc[prefix][method.upper()] = inspect.getdoc(getattr(root, method)).split('\n') | |
472 | ||
473 | if len(doc[prefix]) == 0: | |
474 | del doc[prefix] | |
475 | ||
476 | return doc | |
477 | ||
478 | ||
479 | def get_mons(self): | |
480 | mon_map_mons = self.get('mon_map')['mons'] | |
481 | mon_status = json.loads(self.get('mon_status')['json']) | |
482 | ||
483 | # Add more information | |
484 | for mon in mon_map_mons: | |
485 | mon['in_quorum'] = mon['rank'] in mon_status['quorum'] | |
486 | mon['server'] = self.get_metadata("mon", mon['name'])['hostname'] | |
487 | mon['leader'] = mon['rank'] == mon_status['quorum'][0] | |
488 | ||
489 | return mon_map_mons | |
490 | ||
491 | ||
492 | def get_osd_pools(self): | |
493 | osds = dict(map(lambda x: (x['osd'], []), self.get('osd_map')['osds'])) | |
494 | pools = dict(map(lambda x: (x['pool'], x), self.get('osd_map')['pools'])) | |
495 | crush_rules = self.get('osd_map_crush')['rules'] | |
496 | ||
497 | osds_by_pool = {} | |
498 | for pool_id, pool in pools.items(): | |
499 | pool_osds = None | |
500 | for rule in [r for r in crush_rules if r['rule_id'] == pool['crush_rule']]: | |
501 | if rule['min_size'] <= pool['size'] <= rule['max_size']: | |
502 | pool_osds = common.crush_rule_osds(self.get('osd_map_tree')['nodes'], rule) | |
503 | ||
504 | osds_by_pool[pool_id] = pool_osds | |
505 | ||
506 | for pool_id in pools.keys(): | |
507 | for in_pool_id in osds_by_pool[pool_id]: | |
508 | osds[in_pool_id].append(pool_id) | |
509 | ||
510 | return osds | |
511 | ||
512 | ||
513 | def get_osds(self, pool_id=None, ids=None): | |
514 | # Get data | |
515 | osd_map = self.get('osd_map') | |
516 | osd_metadata = self.get('osd_metadata') | |
517 | ||
518 | # Update the data with the additional info from the osd map | |
519 | osds = osd_map['osds'] | |
520 | ||
521 | # Filter by osd ids | |
522 | if ids is not None: | |
523 | osds = filter( | |
524 | lambda x: str(x['osd']) in ids, | |
525 | osds | |
526 | ) | |
527 | ||
528 | # Get list of pools per osd node | |
529 | pools_map = self.get_osd_pools() | |
530 | ||
531 | # map osd IDs to reweight | |
532 | reweight_map = dict([ | |
533 | (x.get('id'), x.get('reweight', None)) | |
534 | for x in self.get('osd_map_tree')['nodes'] | |
535 | ]) | |
536 | ||
537 | # Build OSD data objects | |
538 | for osd in osds: | |
539 | osd['pools'] = pools_map[osd['osd']] | |
540 | osd['server'] = osd_metadata.get(str(osd['osd']), {}).get('hostname', None) | |
541 | ||
542 | osd['reweight'] = reweight_map.get(osd['osd'], 0.0) | |
543 | ||
544 | if osd['up']: | |
545 | osd['valid_commands'] = common.OSD_IMPLEMENTED_COMMANDS | |
546 | else: | |
547 | osd['valid_commands'] = [] | |
548 | ||
549 | # Filter by pool | |
550 | if pool_id: | |
551 | pool_id = int(pool_id) | |
552 | osds = filter( | |
553 | lambda x: pool_id in x['pools'], | |
554 | osds | |
555 | ) | |
556 | ||
557 | return osds | |
558 | ||
559 | ||
560 | def get_osd_by_id(self, osd_id): | |
561 | osd = filter( | |
562 | lambda x: x['osd'] == osd_id, | |
563 | self.get('osd_map')['osds'] | |
564 | ) | |
565 | ||
566 | if len(osd) != 1: | |
567 | return None | |
568 | ||
569 | return osd[0] | |
570 | ||
571 | ||
572 | def get_pool_by_id(self, pool_id): | |
573 | pool = filter( | |
574 | lambda x: x['pool'] == pool_id, | |
575 | self.get('osd_map')['pools'], | |
576 | ) | |
577 | ||
578 | if len(pool) != 1: | |
579 | return None | |
580 | ||
581 | return pool[0] | |
582 | ||
583 | ||
584 | def submit_request(self, _request, **kwargs): | |
585 | request = CommandsRequest(_request) | |
586 | with self.requests_lock: | |
587 | self.requests.append(request) | |
588 | if kwargs.get('wait', 0): | |
589 | while not request.is_finished(): | |
590 | time.sleep(0.001) | |
591 | return request | |
592 | ||
593 | ||
594 | def run_command(self, command): | |
595 | # tag with 'seq' so that we can ingore these in notify function | |
596 | result = CommandResult('seq') | |
597 | ||
598 | self.send_command(result, 'mon', '', json.dumps(command), 'seq') | |
599 | return result.wait() |