Rating service for OpenStack
Go to file
Andreas Jaeger cbcdacac61 Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.

Disable openstackdocs_auto_name to use 'project' variable as name.

Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.

openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: I6be1174686cb1d8f11e8cb4be58c0e739bf0f931
2020-09-07 18:47:30 +02:00
cloudkitty Merge "Adjust hacking tests to fix py38 support" 2020-09-07 13:18:50 +00:00
contrib Update hacking for Python3 2020-08-18 22:27:09 -03:00
devstack Merge "Replace deprecated devstack authtoken function" 2019-09-24 14:17:50 +00:00
doc Switch to newer openstackdocstheme and reno versions 2020-09-07 18:47:30 +02:00
etc Merge "Update the default metrics.yml file" 2019-04-02 10:43:51 +00:00
releasenotes Switch to newer openstackdocstheme and reno versions 2020-09-07 18:47:30 +02:00
.gitignore Switch to stestr 2018-07-18 08:00:06 +07:00
.gitreview OpenDev Migration Patch 2019-04-19 19:29:58 +00:00
.stestr.conf Switch to stestr 2018-07-18 08:00:06 +07:00
.zuul.yaml Add Python3 victoria unit tests 2020-09-07 12:33:16 +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 Switch to newer openstackdocstheme and reno versions 2020-09-07 18:47:30 +02:00
requirements.txt Replace tz.UTC with dateutil.tz.tzutc() 2020-08-21 15:58:38 +02:00
rtd-requirements.txt Bump the openstackdocstheme extension to 1.20 2018-08-21 13:54:06 +00:00
setup.cfg Add py38 package metadata 2020-09-07 12:27:15 +00:00
setup.py [ussuri][goal] Cleanup drop python 2.7 support 2020-02-24 20:16:56 +01:00
test-requirements.txt Switch to newer openstackdocstheme and reno versions 2020-09-07 18:47:30 +02:00
tox.ini Update hacking for Python3 2020-08-18 22:27:09 -03: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.