121 lines
3.1 KiB
ReStructuredText
121 lines
3.1 KiB
ReStructuredText
========================
|
|
Team and repository tags
|
|
========================
|
|
|
|
.. image:: https://governance.openstack.org/tc/badges/cloudkitty.svg
|
|
:target: https://governance.openstack.org/tc/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 @ oftc.net), or on the official
|
|
OpenStack mailing list openstack-discuss@lists.openstack.org.
|
|
|
|
A storyboard_ 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 libraries new namespace backward compatibility is not possible. If you
|
|
want to install it on an older system, use a virtualenv.
|
|
|
|
Getting release notes
|
|
---------------------
|
|
|
|
Release notes can be found in the `release notes section`_ of the
|
|
documentation.
|
|
|
|
|
|
.. Global references and images
|
|
|
|
.. |doc-status|
|
|
image:: https://readthedocs.org/projects/cloudkitty/badge/?version=latest
|
|
:target: https://cloudkitty.readthedocs.io/en/latest/
|
|
:alt: Documentation Status
|
|
|
|
|
|
.. _readthedocs: https://cloudkitty.readthedocs.io/en/latest/
|
|
|
|
|
|
.. _storyboard: https://storyboard.openstack.org/#!/project/890
|
|
|
|
|
|
.. _python-cloudkittyclient: https://github.com/openstack/python-cloudkittyclient
|
|
|
|
|
|
.. _cloudkitty-dashboard: https://github.com/openstack/cloudkitty-dashboard
|
|
|
|
|
|
.. _architecture section: https://cloudkitty.readthedocs.io/en/latest/arch.html
|
|
|
|
|
|
.. _devstack section: https://cloudkitty.readthedocs.io/en/latest/devstack.html
|
|
|
|
|
|
.. _installation section: https://cloudkitty.readthedocs.io/en/latest/installation.html
|
|
|
|
.. _release notes section: https://docs.openstack.org/releasenotes/cloudkitty/
|