Rating service for OpenStack
Go to file
Ghanshyam Mann c8370c2ab2 [goal] Deprecate the JSON formatted policy file
As per the community goal of migrating the policy file
the format from JSON to YAML[1], we need to do two things:

1. Change the default value of '[oslo_policy] policy_file''
config option from 'policy.json' to 'policy.yaml' with
upgrade checks.

2. Deprecate the JSON formatted policy file on the project side
via warning in doc and releasenotes.

Also replace policy.json to policy.yaml ref from doc.

[1]https://governance.openstack.org/tc/goals/selected/wallaby/migrate-policy-format-from-json-to-yaml.html

Change-Id: I608d3f55dfa9b6052f92c4fd13f2aae6d714e287
2020-12-22 18:49:31 -06:00
cloudkitty [goal] Deprecate the JSON formatted policy file 2020-12-22 18:49:31 -06: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 [goal] Deprecate the JSON formatted policy file 2020-12-22 18:49:31 -06:00
etc Add a /healthcheck URL 2020-09-09 13:40:05 +00:00
releasenotes [goal] Deprecate the JSON formatted policy file 2020-12-22 18:49:31 -06: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 wallaby unit tests 2020-09-21 22:16:38 +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 [goal] Deprecate the JSON formatted policy file 2020-12-22 18:49:31 -06:00
requirements.txt [goal] Deprecate the JSON formatted policy file 2020-12-22 18:49:31 -06:00
rtd-requirements.txt Bump the openstackdocstheme extension to 1.20 2018-08-21 13:54:06 +00:00
setup.cfg [goal] Deprecate the JSON formatted policy file 2020-12-22 18:49:31 -06:00
setup.py [ussuri][goal] Cleanup drop python 2.7 support 2020-02-24 20:16:56 +01:00
test-requirements.txt Update lower-constraints 2020-12-14 18:03:59 -03:00
tox.ini Update lower-constraints 2020-12-14 18:03:59 -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.