Rating service for OpenStack
Go to file
Rafael Weingärtner 3aa31f8719 Add description option to a rating metric definition
There is the need to add human-readable description to the metric
definition. This can then be used to create custom reports in the
`summary` GET API. The value has to be stored in the backend as
we do with the alt_name and unit of the metric as well.

Depends-On: https://review.opendev.org/c/openstack/cloudkitty/+/861786
Change-Id: Icea8d00eaf3343e59f0f7b2234754f6abcb23258
2024-01-28 14:41:18 -03:00
api-ref/source Add groupby options by different timeframes 2023-11-13 11:25:03 -03:00
cloudkitty Add description option to a rating metric definition 2024-01-28 14:41:18 -03:00
contrib Update hacking for Python3 2020-08-18 22:27:09 -03:00
devstack Add OpenSearch as a v2 storage backend 2023-11-27 15:19:14 +01:00
doc Add description option to a rating metric definition 2024-01-28 14:41:18 -03:00
etc Include /v2 in public routes for keystone auth 2022-03-10 17:31:51 +11:00
releasenotes Add description option to a rating metric definition 2024-01-28 14:41:18 -03:00
.gitignore Introduce reprocessing API 2022-02-25 14:49:49 +01: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 OpenSearch as a v2 storage backend 2023-11-27 15:19:14 +01:00
CONTRIBUTING.rst [ussuri][goal] Update contributor documentation 2021-05-18 10:03:01 +02:00
HACKING.rst Replace deprecated assertRaisesRegexp 2022-06-27 00:28:14 +09:00
LICENSE Set copyright/license information in .py files 2014-06-07 09:14:06 +02:00
README.rst docs: Update Freenode to OFTC 2021-05-31 10:55:43 +02:00
requirements.txt Use new get_rpc_client API from oslo.messaging 2023-01-19 20:52:14 +00:00
rtd-requirements.txt Remove six 2021-01-12 09:02:22 +08:00
setup.cfg Add OpenSearch as a v2 storage backend 2023-11-27 15:19:14 +01:00
setup.py [ussuri][goal] Cleanup drop python 2.7 support 2020-02-24 20:16:56 +01:00
test-requirements.txt Add doc/requirements 2021-01-05 14:00:00 +01:00
tox.ini Remove the manual patch for WSME 2023-09-21 15:45:50 -03:00

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 @ oftc.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.