Rating service for OpenStack
Go to file
Luka Peschke af20bdef95 Minor documentation improvements
This adds minor improvements to the documentation:

     * the whole configuration part is no longer in index.rst, but in a
       separate configuration.rst file.

     * the new policy.rst file wasn't included in the docs, it is now.

     * metrics.yml file is now included instead of being copied in the
       documentation.

     * A few markup issues and typos have been fixed.

     * Lines have been wrapped to be < 80 characters.

     * The text in the API server serction has been left-aligned.

Change-Id: I20f88a4c653c4340afd98b670f319a349d242f45
2017-12-19 14:37:53 +01:00
cloudkitty Merge "Ensure compatibility with all versions of gnocchiclient." 2017-12-12 22:31:11 +00:00
contrib Merge "Changes default port from 8888 to 8889" 2016-06-29 15:24:49 +00:00
devstack Policy in code 2017-12-08 16:45:13 +00:00
doc Minor documentation improvements 2017-12-19 14:37:53 +01:00
etc Policy in code 2017-12-08 16:45:13 +00:00
playbooks/cloudkitty-tempest-full Add a tempest plugin gate job 2017-11-18 13:30:54 +01:00
releasenotes Remove deprecated APIs and method in cloudkitty 2017-11-29 09:50:18 +00:00
.gitignore Policy in code 2017-12-08 16:45:13 +00:00
.gitreview Update .gitreview for new namespace 2015-10-17 22:00:44 +00:00
.testr.conf Correct concurrency of gabbi tests for gabbi 1.22.0 2016-06-16 13:00:10 +01:00
.zuul.yaml Don't run non-voting jobs in gate 2017-12-16 22:48:10 +01:00
HACKING.rst Update and replace http with https for doc links in cloudkitty 2017-11-07 08:07:49 +00:00
LICENSE Set copyright/license information in .py files 2014-06-07 09:14:06 +02:00
README.rst Update and replace http with https for doc links in cloudkitty 2017-11-07 08:07:49 +00:00
requirements.txt Remove deprecated oslo_messaging.get_transport 2017-12-06 08:58:37 +00:00
rtd-requirements.txt Removes unused posix_ipc requirement 2016-02-11 08:44:54 -08:00
setup.cfg Policy in code 2017-12-08 16:45:13 +00:00
setup.py Updated from global requirements 2016-03-25 01:14:12 +01:00
test-requirements.txt Update usage of gabbi in Cloudkitty test 2017-10-24 15:06:04 +00:00
tox.ini Merge "Policy in code" 2017-12-12 22:03:15 +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-dev@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 libraires new namespace backward compatibility is not possible. If you want to install it on an older system, use a virtualenv.