a106fd8fec
This patch adds the team's and repository's badges to the README file. The motivation behind this is to communicate the project status and features at first glance. For more information about this effort, please read this email thread: http://lists.openstack.org/pipermail/openstack-dev/2016-October/105562.html To see an example of how this would look like check: https://gist.github.com/eb5fd048a8c0897aac80c1675094b4ed Change-Id: I762ac1bbfe6924673105be8518f2b226f61625a2
113 lines
2.8 KiB
ReStructuredText
113 lines
2.8 KiB
ReStructuredText
========================
|
|
Team and repository tags
|
|
========================
|
|
|
|
.. image:: http://governance.openstack.org/badges/cloudkitty.svg
|
|
:target: http://governance.openstack.org/reference/tags/index.html
|
|
|
|
.. Change things from this point on
|
|
|
|
==========
|
|
CloudKitty
|
|
==========
|
|
|doc-status|
|
|
|
|
.. image:: doc/source/images/cloudkitty-logo.png
|
|
:alt: cloudkitty
|
|
:align: center
|
|
|
|
|
|
Rating as a Service component
|
|
+++++++++++++++++++++++++++++
|
|
|
|
Goal
|
|
----
|
|
|
|
CloudKitty aims at filling the gap between metrics collection systems like
|
|
ceilometer and a billing system.
|
|
|
|
Every metrics are collected, aggregated and processed through different rating
|
|
modules. You can then query CloudKitty's storage to retrieve processed data and
|
|
easily generate reports.
|
|
|
|
Most parts of CloudKitty are modular so you can easily extend the base code to
|
|
address your particular use case.
|
|
|
|
You can find more information on its architecture in the documentation,
|
|
`architecture section`_.
|
|
|
|
|
|
Status
|
|
------
|
|
|
|
CloudKitty has been successfully deployed in production on different OpenStack
|
|
systems.
|
|
|
|
You can find the latest documentation on readthedocs_.
|
|
|
|
|
|
Contributing
|
|
------------
|
|
|
|
We are welcoming new contributors, if you've got new ideas, suggestions or want
|
|
to contribute contact us.
|
|
|
|
You can reach us thought IRC (#cloudkitty @freenode.net), or on the official
|
|
OpenStack mailing list openstack-dev@lists.openstack.org.
|
|
|
|
A launchpad_ is available if you need to report bugs.
|
|
|
|
|
|
Additional components
|
|
---------------------
|
|
|
|
We're providing an OpenStack dashboard (Horizon) integration, you can find the
|
|
files in the cloudkitty-dashboard_ repository.
|
|
|
|
A CLI is available too in the python-cloudkittyclient_ repository.
|
|
|
|
|
|
Trying it
|
|
---------
|
|
|
|
CloudKitty can be deployed with devstack, more information can be found in the
|
|
`devstack section`_ of the documentation.
|
|
|
|
|
|
Deploying it in production
|
|
--------------------------
|
|
|
|
CloudKitty can be deployed in production on OpenStack Kilo environments, for
|
|
more information check the `installation section`_ of the documentation. Due to
|
|
oslo libraires new namespace backward compatibility is not possible. If you
|
|
want to install it on an older system, use a virtualenv.
|
|
|
|
|
|
.. Global references and images
|
|
|
|
.. |doc-status|
|
|
image:: https://readthedocs.org/projects/cloudkitty/badge/?version=latest
|
|
:target: http://cloudkitty.readthedocs.org
|
|
:alt: Documentation Status
|
|
|
|
|
|
.. _readthedocs: http://cloudkitty.readthedocs.org
|
|
|
|
|
|
.. _launchpad: https://launchpad.net/cloudkitty
|
|
|
|
|
|
.. _python-cloudkittyclient: https://github.com/openstack/python-cloudkittyclient
|
|
|
|
|
|
.. _cloudkitty-dashboard: https://github.com/openstack/cloudkitty-dashboard
|
|
|
|
|
|
.. _architecture section: https://cloudkitty.readthedocs.org/en/latest/arch.html
|
|
|
|
|
|
.. _devstack section: https://cloudkitty.readthedocs.org/en/latest/devstack.html
|
|
|
|
|
|
.. _installation section: https://cloudkitty.readthedocs.org/en/latest/installation.html
|