Skip to content

Latest commit

 

History

History
51 lines (31 loc) · 2.13 KB

README.rst

File metadata and controls

51 lines (31 loc) · 2.13 KB
https://travis-ci.org/ceph/calamari.svg?branch=master https://readthedocs.org/projects/calamari/badge/?version=latest

Calamari server

Calamari is a management and monitoring service for Ceph, exposing a high level REST API.

This repository contains the Calamari server-side code. There is an accompanying user interface built on the Calamari REST API at https://github.com/ceph/calamari-clients

For developers

  1. Read about setting up a development environment: http://calamari.readthedocs.org/en/latest/development/dev_env.html
  2. Read about the coding style for Python code: http://calamari.readthedocs.org/en/latest/development/coding_style.html
  3. Read about the format for commit messages: http://ceph.com/resources/development/ceph-commit-comments/
  4. ...and send a pull request

For users

Calamari was only recently released as open source software, and this repository is for the moment mainly aimed at developers. However, early adopters are welcome to try getting Calamari up and running, and feedback to the mailing list will certainly be appreciated.

Pre-built Calamari packages are not available here, but scripts are included to build your own: http://calamari.readthedocs.org/en/latest/development/building_packages.html

A high level guide to installing Calamari from packages you have built is available here: http://calamari.readthedocs.org/en/latest/operations/index.html

Check the mailing list archives for recent discussions of commonly encountered issues, and post your questions there. Check back here for more comprehensive guidance for end-users in the near future.

Resources

Calamari developer documentation: http://calamari.readthedocs.org

Calamari mailing list: http://lists.ceph.com/listinfo.cgi/ceph-calamari-ceph.com

Calamari issue tracker: http://tracker.ceph.com/projects/calamari