3 `ceph-brag` is going to be an anonymized cluster reporting tool designed to collect a "registry" of Ceph clusters for community knowledge.
4 This data will be displayed on a public web page using UUID by default, but users can claim their cluster and publish information about ownership if they so desire.
6 For more information please visit:
8 * [Blueprint](http://wiki.ceph.com/Planning/Blueprints/Firefly/Ceph-Brag)
9 * [CDS Etherpad](http://pad.ceph.com/p/cdsfirefly-ceph-brag)
16 ceph-brag uses 'ceph' python script. Hence, before executing ceph-brag script ensure that ceph services are all running and 'ceph' script is in 'PATH' environment
18 ### Runtime instructions:
19 Run 'ceph-brag -h' to get the usage information of this tool.
24 "cluster_creation_date": "2014-01-16 13:38:41.928551",
25 "uuid": "20679d0e-04b1-4004-8ee9-45ac271510e9",
28 "num_bytes_total": 1209312904,
55 "organization": "eNovance",
56 "description": "Use case1",
57 "email": "mail@enovance.com",
81 "type": "#36-Ubuntu SMP Tue Apr 10 22:29:03 UTC 2012"
93 "cpu": "Intel Xeon E312xx (Sandy Bridge)"
99 "version": "3.2.0-23-virtual"
105 "version": "0.75-229-g4050eae(4050eae32cd77a1c210ca11d0f12c74daecb1bd3)"
117 "distro": "Ubuntu 12.04 precise (Ubuntu 12.04 LTS)"
127 The ceph-brag server code is a python based web application.
132 * [pecan](http://pecanpy.org) is the web framework that is used by this application.
133 * [sqlalchemy](www.sqlalchemy.org) is the ORM that is used by this application
136 * [Common recipes to deploy](http://pecan.readthedocs.org/en/latest/deployment.html#common-recipes)
137 * Modify server/config.py:sqlalchemy['url'] to point the correct database connection
140 Following are the REST urls that are implemented with 'url-prefix' being the mount point for the WSGI script
144 ##### * GET /url-prefix/
145 Returns the list of clusters that are registered so far.
146 Outputs - On success application/json of the following format is returned
151 "cluster_creation_date": "2014-01-16 13:38:41.928551",
152 "uuid": "20679d0e-04b1-4004-8ee9-45ac271510e9",
153 "cluster_name": "Cluster1",
154 "organization": "eNovance",
155 "email": "mail@enovance.com"
160 ##### * GET /url-prefix/UUID
161 Returns the list of version information for a particular UUID.
162 Outputs - On success application/json of the following format is returned
167 "version_date": "2014-02-10 10:17:56.283499"
172 ##### * GET /url-prefix/UUID/version\_number
173 Returns the entire brag report as mentioned in client's sample output for a particular version of a UUID
177 ##### * PUT /url-prefix
178 Uploads the brag report and creates a new version for the UUID mentioned in the payload
182 ##### * DELETE /url-prefix?uuid=xxxx
183 Deletes all the versions of a cluster whose UUID is sent as a parameter