Rating service for OpenStack
Go to file
Luka Peschke bae398db2f Bootstrap the v2 API
This adds a v2 API root to CloudKitty. An example endpoint along with some
developer documentation has been added. The API root is now served with Flask
instead of pecan.

Change-Id: I4ede52dae531631f7fe708400def01bc08a64dec
Story: 2004208
Task: 27717
Task: 27718
Task: 27719
2019-04-02 17:28:36 +02:00
cloudkitty Bootstrap the v2 API 2019-04-02 17:28:36 +02:00
contrib Add a custom JSONEncoder 2019-02-13 15:05:17 +01:00
devstack Update the devstack plugin 2019-03-21 09:18:32 +00:00
doc Bootstrap the v2 API 2019-04-02 17:28:36 +02:00
etc Bootstrap the v2 API 2019-04-02 17:28:36 +02:00
releasenotes Bootstrap the v2 API 2019-04-02 17:28:36 +02:00
.gitignore Switch to stestr 2018-07-18 08:00:06 +07:00
.gitreview Update .gitreview for stable/stein 2019-03-21 20:29:36 +00:00
.stestr.conf Switch to stestr 2018-07-18 08:00:06 +07:00
.zuul.yaml Update the devstack plugin 2019-03-21 09:18:32 +00: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
README.rst Changed author email 2018-12-06 09:45:17 +01:00
lower-constraints.txt Bootstrap the v2 API 2019-04-02 17:28:36 +02:00
requirements.txt Bootstrap the v2 API 2019-04-02 17:28:36 +02:00
rtd-requirements.txt Bump the openstackdocstheme extension to 1.20 2018-08-21 13:54:06 +00:00
setup.cfg Merge "Support upgrade checks" 2019-03-07 19:36:03 +00:00
setup.py Use global-requirements for requirements 2018-10-17 07:29:48 +00:00
test-requirements.txt Bootstrap the v2 API 2019-04-02 17:28:36 +02:00
tox.ini Update UPPER_CONSTRAINTS_FILE for stable/stein 2019-03-21 20:29:38 +00: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.