Rating service for OpenStack
Go to file
Matt Crees 913f061b59 Add OpenSearch as a v2 storage backend
To facilitate the switch from Elasticsearch to OpenSearch, the ES
backend has been duplicated and renamed where appropriate to OpenSearch.

The OpenSearch implementation was modified in places for compatibility
with OpenSearch 2.x, for example:

- remove mapping name from bulk API URL
- replace put_mapping by post_mapping

This will allow for the future removal of the Elasticsearch backend.

Change-Id: I88b0a30f66af13dad1bd75cde412d2880b4ead30
Co-Authored-By: Pierre Riteau <pierre@stackhpc.com>
(cherry picked from commit 964c6704a2)
2024-03-18 16:27:21 +01:00
cloudkitty Add OpenSearch as a v2 storage backend 2024-03-18 16:27:21 +01:00
contrib Update hacking for Python3 2020-08-18 22:27:09 -03:00
devstack Add OpenSearch as a v2 storage backend 2024-03-18 16:27:21 +01:00
doc Add OpenSearch as a v2 storage backend 2024-03-18 16:27:21 +01:00
etc Set force_granularity: 300 in metrics.yml 2021-09-06 16:22:19 +02:00
releasenotes Add OpenSearch as a v2 storage backend 2024-03-18 16:27:21 +01:00
.gitignore Introduce reprocessing API 2022-02-25 14:49:49 +01:00
.gitreview Update .gitreview for unmaintained/yoga 2024-02-05 16:43:03 +00:00
.stestr.conf Switch to stestr 2018-07-18 08:00:06 +07:00
.zuul.yaml Add OpenSearch as a v2 storage backend 2024-03-18 16:27:21 +01:00
CONTRIBUTING.rst [ussuri][goal] Update contributor documentation 2021-05-18 10:03:01 +02:00
HACKING.rst Remove six 2021-01-12 09:02:22 +08: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 Drop lower-constraints.txt and its testing 2023-10-13 14:53:23 +02:00
rtd-requirements.txt Remove six 2021-01-12 09:02:22 +08:00
setup.cfg Add OpenSearch as a v2 storage backend 2024-03-18 16:27:21 +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 Drop lower-constraints.txt and its testing 2023-10-13 14:53:23 +02: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 @ 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.