911c90569c
This patch updates/adds the contributor documentation to follow the guidelines of the Ussuri cycle community goal[1]. [1] https://governance.openstack.org/tc/goals/selected/ussuri/project-ptl-and-contrib-docs.html Story: #2007236 Task: #38517 Change-Id: I2ed8113b4a008475ab9526eed9a004bdfcf5d805 |
||
|---|---|---|
| cloudkitty | ||
| contrib | ||
| devstack | ||
| doc | ||
| etc | ||
| releasenotes | ||
| .gitignore | ||
| .gitreview | ||
| .stestr.conf | ||
| .zuul.yaml | ||
| CONTRIBUTING.rst | ||
| HACKING.rst | ||
| LICENSE | ||
| lower-constraints.txt | ||
| README.rst | ||
| requirements.txt | ||
| rtd-requirements.txt | ||
| setup.cfg | ||
| setup.py | ||
| test-requirements.txt | ||
| tox.ini | ||
Team and repository tags
CloudKitty
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-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.