openstack/cloudkitty
Code Issues Proposed changes
Rating service for OpenStack
743 Commits 10 Branches 79 Tags 14 MiB
Python 96.5%
Shell 2%
PHP 0.6%
HTML 0.5%
Mako 0.4%
4b794472a8
Go to file
Luka Peschke 4b794472a8 Change the documentation layout 
This changes the documentation layout according to the previously submitted
spec.

Change-Id: I9aa879af23ae4e993da60186eddaef8d22f59e79
Story: 2004179
Task: 28152
2018-12-14 10:28:59 +01:00
cloudkitty Add missing help kwarg to oslo option in influx storage 2018-12-13 17:23:54 +01:00
contrib Remove Ceilometer collector and transformer 2018-03-07 09:14:02 +00:00
devstack Adds doc8 check to pep8 2018-10-22 11:14:57 +02:00
doc Change the documentation layout 2018-12-14 10:28:59 +01:00
etc Improve metrics configuration 2018-06-28 11:19:51 +00:00
releasenotes Adding an InfluxDB storage backend 2018-12-11 14:32:55 +01:00
.gitignore Switch to stestr 2018-07-18 08:00:06 +07:00
.gitreview Update .gitreview for new namespace 2015-10-17 22:00:44 +00:00
.stestr.conf Switch to stestr 2018-07-18 08:00:06 +07:00
.zuul.yaml Convert legacy zuul jobs to new format 2018-11-20 11:26:12 +01:00
HACKING.rst Adds doc8 check to pep8 2018-10-22 11:14:57 +02:00
LICENSE Set copyright/license information in .py files 2014-06-07 09:14:06 +02:00
lower-constraints.txt Adding an InfluxDB storage backend 2018-12-11 14:32:55 +01:00
README.rst Changed author email 2018-12-06 09:45:17 +01:00
requirements.txt Adding an InfluxDB storage backend 2018-12-11 14:32:55 +01:00
rtd-requirements.txt Bump the openstackdocstheme extension to 1.20 2018-08-21 13:54:06 +00:00
setup.cfg Adding an InfluxDB storage backend 2018-12-11 14:32:55 +01:00
setup.py Use global-requirements for requirements 2018-10-17 07:29:48 +00:00
test-requirements.txt Adds doc8 check to pep8 2018-10-22 11:14:57 +02:00
tox.ini Enable python3.7 testing jobs 2018-10-30 11:01:49 +01:00

README.rst

Team and repository tags

image

CloudKitty

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.