1B - Ceph Management API » History » Version 1
Jessica Mack, 06/22/2015 04:21 AM
1 | 1 | Jessica Mack | h1. 1B - Ceph Management API |
---|---|---|---|
2 | |||
3 | h3. Live Pad |
||
4 | |||
5 | The live pad can be found here: "[pad]":http://pad.ceph.com/p/Ceph_management_API |
||
6 | Summit Snapshot |
||
7 | wCoding tasks (some done, see http://github.com/ceph/ceph branch wip-ceph-cli for an out-of-date working branch) |
||
8 | If you have ideas/comments/suggestions, contact us at irc.oftc.net #ceph, or ceph-devel@vger.kernel.org! |
||
9 | |||
10 | |||
11 | # Create command/param/help registry in monclient, export in JSON on request |
||
12 | ** expression language for parameter descriptions: type, name, valid ranges/values, etc. |
||
13 | ** make it simple to add new commands and easy to find the full list of commands supported |
||
14 | # Frontend CLI that requests command registry and validates user input, submits JSON command request |
||
15 | ** do as much validation upfront as possible, as generically as possible |
||
16 | ** write validation code such that it can be reused in REST endpoint |
||
17 | ** format help, provide substring help |
||
18 | ** allow for command-line completion (allow partial matching of input) |
||
19 | ** format actual command request in unambiguous complete JSON form |
||
20 | # Remove existing command validation/parsing from monclient |
||
21 | ** rely on front end to pass only valid commands as much as possible (some validation must talk to the cluster) |
||
22 | ** refactor common tasks, like selection of output format |
||
23 | # Allow all formatted commands to output JSON or XML (planning ahead for REST) |
||
24 | # Validate all existing functionality remains unchanged with much-enhanced unit tests and existing tests |
||
25 | # migration path for existing 'allow command ...' cap strings |
||
26 | # discover/describe --admin-daemon and tell commands (currently just passthru) |
||
27 | # merge to master... 0.63ish? |
||
28 | # Add command-line completion to frontend and BASH snippets |
||
29 | # Create webserver for REST endpoint (after the interface is designed) using chunks of the CLI code as needed |
||
30 | # Allow REST endpoint to respond in JSON or XML at user's request |
||
31 | # Add some appropriate sort of monitoring to the REST endpoint |
||
32 | # ability to access daemon admin socket command set via REST mgmt endpoint |
||
33 | # ability to do 'tell <name> ...' |
||
34 | # ability to access cluster event log via cli, REST mgmt endpoint |
||
35 | # ceph-deploy support for deploying a management endpoint daemon |
||
36 | # (Possible): allow client to register interest in cluster events (cluster/OSD full, daemon status change, quorum change, administrative events/change) using an unknown mechanism (perhaps a URL that can be accessed on such events, perhaps with a parameter structure to carry information about the |
||
37 | |||
38 | Build / release tasks |
||
39 | |||
40 | |||
41 | # document upgrade path: upgrade cli tool first (it can talk to either old or new mons), mons second. |
||
42 | # merge first batch of cli stuff |
||
43 | # merge rest mgmt endpoint as it finishes |
||
44 | |||
45 | Documentation tasks |
||
46 | |||
47 | |||
48 | # Fix up manpage/webdoc for CLI; decide to document each or just defer to CLI help |
||
49 | # A large pile of documentation for REST API |
||
50 | |||
51 | Deprecation tasks |
||
52 | |||
53 | n/a |