b8c848f9ec
To avoid source code updates with metrology conf update, the metrology configuration is separated from Cloudkitty configuration file and placed in a yaml one. Task: 5724 Story: 2001215 Change-Id: Icc098c40bc52c2589e89d705d9d711d0ce2fb557
343 lines
9.1 KiB
ReStructuredText
343 lines
9.1 KiB
ReStructuredText
###################
|
|
Configuration Guide
|
|
###################
|
|
|
|
Configure Cloudkitty
|
|
====================
|
|
|
|
Edit :file:`/etc/cloudkitty/cloudkitty.conf` to configure cloudkitty.
|
|
|
|
Then you need to know which keystone API version you use (which can be
|
|
determined using `openstack endpoint list`)
|
|
|
|
|
|
The first thing to set is the authentification method wished to reach Cloudkitty API endpoints.
|
|
|
|
|
|
Without authentification
|
|
------------------------
|
|
|
|
If wanted, you can choose to not set any authentification method.
|
|
This should be set in de DEFAULT block of the configuration file owing to the auth_strategy field:
|
|
|
|
.. code-block:: ini
|
|
|
|
[DEFAULT]
|
|
verbose = True
|
|
log_dir = /var/log/cloudkitty
|
|
# oslo_messaging_rabbit is deprecated
|
|
transport_url = rabbit://openstack:RABBIT_PASSWORD@RABBIT_HOST
|
|
auth_strategy = noauth
|
|
|
|
|
|
Otherwise, the only other officially implemented authentification method is keystone.
|
|
More methods will be implemented soon.
|
|
It should be set in the DEFAULT configuration block too, with the auth_stategy field.
|
|
|
|
|
|
For keystone (identity) API v2 (deprecated)
|
|
-------------------------------------------
|
|
|
|
.. code-block:: ini
|
|
|
|
[DEFAULT]
|
|
verbose = True
|
|
log_dir = /var/log/cloudkitty
|
|
# oslo_messaging_rabbit is deprecated
|
|
transport_url = rabbit://openstack:RABBIT_PASSWORD@RABBIT_HOST/
|
|
auth_strategy = keystone
|
|
|
|
[auth]
|
|
username = cloudkitty
|
|
password = CK_PASSWORD
|
|
tenant = service
|
|
region = RegionOne
|
|
url = http://KEYSTONE_HOST:5000/v2.0
|
|
|
|
[keystone_authtoken]
|
|
username = cloudkitty
|
|
password = CK_PASSWORD
|
|
project_name = service
|
|
region = RegionOne
|
|
auth_url = http://KEYSTONE_HOST:5000/v2.0
|
|
auth_plugin = password
|
|
|
|
[database]
|
|
connection = mysql://cloudkitty:CK_DBPASSWORD@DB_HOST/cloudkitty
|
|
|
|
[storage]
|
|
backend = sqlalchemy
|
|
|
|
[keystone_fetcher]
|
|
username = cloudkitty
|
|
password = CK_PASSWORD
|
|
tenant = service
|
|
region = RegionOne
|
|
url = http://KEYSTONE_HOST:5000/v2.0
|
|
|
|
[collect]
|
|
collector = ceilometer
|
|
period = 3600
|
|
services = compute, volume, network.bw.in, network.bw.out, network.floating, image
|
|
|
|
[ceilometer_collector]
|
|
username = cloudkitty
|
|
password = CK_PASSWORD
|
|
tenant = service
|
|
region = RegionOne
|
|
url = http://KEYSTONE_HOST:5000/v2.0
|
|
|
|
.. note::
|
|
|
|
* ``http://KEYSTONE_HOST:5000/v2.0`` and ``http://KEYSTONE_HOST:35357/v2.0`` are your
|
|
identity endpoints.
|
|
|
|
* the tenant named ``service`` is also commonly called ``services``
|
|
|
|
For keystone (identity) API v3
|
|
------------------------------
|
|
|
|
The following shows the basic configuration items:
|
|
|
|
.. code-block:: ini
|
|
|
|
[DEFAULT]
|
|
verbose = True
|
|
log_dir = /var/log/cloudkitty
|
|
# oslo_messaging_rabbit is deprecated
|
|
transport_url = rabbit://openstack:RABBIT_PASSWORD@RABBIT_HOST/
|
|
auth_strategy = keystone
|
|
|
|
[ks_auth]
|
|
auth_type = v3password
|
|
auth_protocol = http
|
|
auth_url = http://KEYSTONE_HOST:5000/
|
|
identity_uri = http://KEYSTONE_HOST:35357/
|
|
username = cloudkitty
|
|
password = CK_PASSWORD
|
|
project_name = service
|
|
user_domain_name = default
|
|
project_domain_name = default
|
|
debug = True
|
|
|
|
[keystone_authtoken]
|
|
auth_section = ks_auth
|
|
|
|
[database]
|
|
connection = mysql://cloudkitty:CK_DBPASSWORD@DB_HOST/cloudkitty
|
|
|
|
[keystone_fetcher]
|
|
auth_section = ks_auth
|
|
keystone_version = 3
|
|
|
|
[tenant_fetcher]
|
|
backend = keystone
|
|
|
|
.. note::
|
|
|
|
The tenant named ``service`` is also commonly called ``services``
|
|
|
|
It is now time to configure the storage backend. Three storage backends are
|
|
available: ``sqlalchemy``, ``gnocchihybrid``, and ``gnocchi``.
|
|
|
|
.. code-block:: ini
|
|
|
|
[storage]
|
|
backend = gnocchihybrid
|
|
|
|
As you will see in the following example, collector and storage backends sometimes
|
|
need additional configuration sections. (The tenant fetcher works the same way,
|
|
but for now, only Keystone is supported). The section's name has the following
|
|
format: ``{backend_name}_{backend_type}`` (``gnocchi_collector`` for example),
|
|
except for ``storage_gnocchi``.
|
|
|
|
.. note::
|
|
|
|
The section name format should become ``{backend_type}_{backend_name}`` for all
|
|
sections in the future (``storage_gnocchi`` style).
|
|
|
|
If you want to use the pure gnocchi storage, add the following entry:
|
|
|
|
.. code-block:: ini
|
|
|
|
[storage_gnocchi]
|
|
auth_section = ks_auth
|
|
|
|
Three collectors are available: Ceilometer (deprecated, see the Telemetry
|
|
documentation), Gnocchi and Monasca. The Monasca collector collects metrics
|
|
published by the Ceilometer agent to Monasca using Ceilosca_.
|
|
|
|
The collect information, is separated from the Cloudkitty configuration file, in a yaml one.
|
|
|
|
This allows Cloudkitty users to change metrology configuration,
|
|
without modifying source code or Cloudkitty configuration file.
|
|
|
|
.. code-block:: ini
|
|
|
|
[collect]
|
|
metrics_conf = /etc/cloudkitty/metrics.yml
|
|
|
|
[gnocchi_collector]
|
|
auth_section = ks_auth
|
|
|
|
The ``/etc/cloudkitty/metrics.yml`` file looks like this:
|
|
|
|
.. code-block:: yaml
|
|
|
|
- name: OpenStack
|
|
|
|
collector: gnocchi
|
|
period: 3600
|
|
wait_period: 2
|
|
window: 1800
|
|
|
|
services:
|
|
- compute
|
|
- volume
|
|
- network.bw.in
|
|
- network.bw.out
|
|
- network.floating
|
|
- image
|
|
|
|
services_objects:
|
|
compute: instance
|
|
volume: volume
|
|
network.bw.in: instance_network_interface
|
|
network.bw.out: instance_network_interface
|
|
network.floating: network
|
|
image: image
|
|
|
|
services_metrics:
|
|
compute:
|
|
- vcpus: max
|
|
- memory: max
|
|
- cpu: max
|
|
- disk.root.size: max
|
|
- disk.ephemeral.size: max
|
|
volume:
|
|
- volume.size: max
|
|
network.bw.in:
|
|
- network.incoming.bytes: max
|
|
network.bw.out:
|
|
- network.outgoing.bytes: max
|
|
network.floating:
|
|
- ip.floating: max
|
|
image:
|
|
- image.size: max
|
|
- image.download: max
|
|
- image.serve: max
|
|
|
|
services_units:
|
|
compute:
|
|
1: instance
|
|
volume:
|
|
volume.size: GB
|
|
network.bw.in:
|
|
network.incoming.bytes: MB
|
|
network.bw.out:
|
|
network.outgoing.bytes: MB
|
|
network.floating:
|
|
1: ip
|
|
image:
|
|
image.size: MB
|
|
default_unit:
|
|
1: unknown
|
|
|
|
|
|
Setup the database and storage backend
|
|
--------------------------------------
|
|
|
|
MySQL/MariaDB is the recommended database engine. To setup the database, use
|
|
the ``mysql`` client::
|
|
|
|
mysql -uroot -p << EOF
|
|
CREATE DATABASE cloudkitty;
|
|
GRANT ALL PRIVILEGES ON cloudkitty.* TO 'cloudkitty'@'localhost' IDENTIFIED BY 'CK_DBPASSWORD';
|
|
EOF
|
|
|
|
If you need to authorize the cloudkitty mysql user from another host you have
|
|
to change the line accordingly.
|
|
|
|
Run the database synchronisation scripts::
|
|
|
|
cloudkitty-dbsync upgrade
|
|
|
|
|
|
Init the storage backend::
|
|
|
|
cloudkitty-storage-init
|
|
|
|
|
|
Integration with Keystone
|
|
-------------------------
|
|
|
|
cloudkitty uses Keystone for authentication, and provides a ``rating`` service.
|
|
|
|
To integrate cloudkitty to Keystone, run the following commands (as OpenStack
|
|
administrator)::
|
|
|
|
openstack user create cloudkitty --password CK_PASSWORD --email cloudkitty@localhost
|
|
openstack role add --project service --user cloudkitty admin
|
|
|
|
|
|
Give the ``rating`` role to ``cloudkitty`` for each project that should be
|
|
handled by cloudkitty::
|
|
|
|
openstack role create rating
|
|
openstack role add --project XXX --user cloudkitty rating
|
|
|
|
Create the ``rating`` service and its endpoints::
|
|
|
|
openstack service create rating --name cloudkitty \
|
|
--description "OpenStack Rating Service"
|
|
openstack endpoint create rating --region RegionOne \
|
|
public http://localhost:8889
|
|
openstack endpoint create rating --region RegionOne \
|
|
admin http://localhost:8889
|
|
openstack endpoint create rating --region RegionOne \
|
|
internal http://localhost:8889
|
|
|
|
.. note::
|
|
|
|
The default port for the API service changed from 8888 to 8889
|
|
in the Newton release. If you installed Cloudkitty in an
|
|
earlier version, make sure to either explicitly define the
|
|
``[api]/port`` setting to 8888 in ``cloudkitty.conf``, or update
|
|
your keystone endpoints to use the 8889 port.
|
|
|
|
Start cloudkitty
|
|
================
|
|
|
|
If you installed cloudkitty from packages
|
|
-----------------------------------------
|
|
|
|
Start the processing services::
|
|
|
|
systemctl start cloudkitty-processor.service
|
|
|
|
If you installed cloudkitty from sources
|
|
-----------------------------------------
|
|
|
|
Start the processing services::
|
|
|
|
cloudkitty-processor --config-file /etc/cloudkitty/cloudkitty.conf
|
|
|
|
Choose and start the API server
|
|
-------------------------------
|
|
|
|
Cloudkitty includes the ``cloudkitty-api`` command. It can be
|
|
used to run the API server. For smaller or proof-of-concept
|
|
installations this is a reasonable choice. For larger installations it
|
|
is strongly recommended to install the API server in a WSGI host
|
|
such as mod_wsgi (see :ref:`mod_wsgi`). Doing so will provide better
|
|
performance and more options for making adjustments specific to the
|
|
installation environment.
|
|
|
|
If you are using the ``cloudkitty-api`` command it can be started
|
|
as::
|
|
|
|
$ cloudkitty-api -p 8889
|
|
|
|
|
|
.. _Ceilosca: https://github.com/openstack/monasca-ceilometer
|