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
89
90
91
92
93
94
95
96
97
98
|
======================
Fetcher configuration
======================
Backend option
==============
``backend`` is a common option specified in the ``[fetcher]`` section of
the configuration file. It defaults to ``keystone`` and specifies the driver
to be used for fetching the list of scopes to rate.
Fetcher-specific options
========================
Fetcher-specific options must be specified in the
``fetcher_{fetcher_name}`` section of ``cloudkitty.conf``.
Gnocchi
-------
Section ``fetcher_gnocchi``.
* ``scope_attribute``: Defaults to ``project_id``. Attribute from which
scope_ids should be collected.
* ``resource_types``: Defaults to ``[generic]``. List of gnocchi resource
types. All if left blank.
* ``gnocchi_auth_type``: Defaults to ``keystone``. Defines what authentication
method should be used by the gnocchi fetcher. Must be one of ``basic``
(for gnocchi basic authentication) or ``keystone`` (for classic keystone
authentication). If ``keystone`` is chosen, credentials can be specified
in a section pointed at by the ``auth_section`` parameter.
* ``gnocchi_user``: For gnocchi basic authentication only. The gnocchi user.
* ``gnocchi_endpoint``: For gnocchi basic authentication only. The gnocchi
endpoint.
* ``interface``: Defaults to ``internalURL``. For keystone authentication only.
The interface to use for keystone URL discovery.
* ``region_name``: Defaults to ``RegionOne``. For keystone authentication only.
Region name.
Keystone
--------
Section ``fetcher_keystone``.
* ``keystone_version``: Defaults to ``3``. Keystone version to use.
* ``auth_section``: If the ``auth_section`` option is defined then all the
options declared in the target section will be used in order to fetch scopes
through Keystone service.
If ``auth_section`` option is not defined then you can configure Keystone
fetcher using regular Keystone authentication options as found here:
:doc:`configuration`.
* ``ignore_rating_role``: if set to true, the Keystone fetcher will not check
if a project has the rating role; thus, CloudKitty will execute rating for
every project it finds. Defaults to false.
* ``ignore_disabled_tenants``: if set to true, Cloudkitty will not rate
projects that are disabled in Keystone. Defaults to false.
Prometheus
----------
Section ``fetcher_prometheus``.
* ``metric``: Metric from which scope_ids should be requested.
* ``scope_attribute``: Defaults to ``project_id``. Attribute from which
scope_ids should be requested.
* ``filters``: Optional key-value dictionary to use additional metadata to
filter out some of the Prometheus service response.
* ``prometheus_url``: Prometheus HTTP API URL.
* ``prometheus_user``: For HTTP basic authentication. The username.
* ``prometheus_password``: For HTTP basic authentication. The password.
* ``cafile``: Option to allow custom certificate authority file.
* ``insecure``: Option to explicitly allow untrusted HTTPS connections.
Source
------
Section ``fetcher_source``.
* ``sources``: Explicit list of scope_ids.
|
