1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
|
======
Rating
======
CloudKitty is shipped with three rating modules:
* ``noop``: Rating module for testing purpose (enabled only).
* ``hashmap``: Default rating module corresponding to usual CloudKitty
use cases (disabled by default).
* ``pyscripts``: Custom rating module allowing you to add your
own python scripts (disabled by default).
You can enable or disable each module independently
and prioritize one over another at will.
* ``Enabled`` state is represented by a boolean value (``True`` or ``False``).
* ``Priority`` is represented by an integer value.
.. note::
The module with the biggest priority value will process data first
(descending order).
List available modules
======================
List available rating modules:
.. code-block:: console
$ cloudkitty module list
+-----------+---------+----------+
| Module | Enabled | Priority |
+-----------+---------+----------+
| hashmap | False | 1 |
| noop | True | 1 |
| pyscripts | False | 1 |
+-----------+---------+----------+
Enable or disable module
========================
Enable the hashmap rating module:
.. code-block:: console
$ cloudkitty module enable hashmap
+---------+---------+----------+
| Module | Enabled | Priority |
+---------+---------+----------+
| hashmap | True | 1 |
+---------+---------+----------+
Disable the pyscripts rating module:
.. code-block:: console
$ cloudkitty module disable pyscripts
+-----------+---------+----------+
| Module | Enabled | Priority |
+-----------+---------+----------+
| pyscripts | False | 1 |
+-----------+---------+----------+
Set priority
============
Set the hashmap rating module priority to 100:
.. code-block:: console
$ cloudkitty module set priority hashmap 100
+---------+---------+----------+
| Module | Enabled | Priority |
+---------+---------+----------+
| hashmap | True | 100 |
+---------+---------+----------+
More details
============
.. toctree::
:maxdepth: 2
:glob:
hashmap.rst
pyscripts.rst
|