.. _enable-openstack-notifications:

==============================
Enable OpenStack notifications
==============================

Fleio sends commands to the OpenStack API and consumes notifications received via the OpenStack internal RabbitMQ queue.
You need to make sure that the OpenStack services are sending notifications.
Depending on the method you used to install OpenStack, notifications may not be enabled by default.

Based on the OpenStack services you are using here's what you need to enable:

* for any OpenStack service that you use, :ref:`keystone-notifications` are required
* compute instances: enable :ref:`nova-notifications`, :ref:`glance-notifications` and :ref:`neutron-notifications`
* block storage (volumes): enable :ref:`cinder-notifications`

All services require the same configuration: ``driver = messagingv2``, and Nova also needs
``notify_on_state_change = vm_and_task_state``. Details below.

.. _keystone-notifications:

Keystone notifications
======================

Keystone is the identity service used by OpenStack for authentication (authN) and high-level authorization (authZ).

Make sure that the following settings are included in the Keystone configuration file.
File path is usually ``/etc/keystone/keystone.conf``:

.. code-block:: bash

        ...
        [oslo_messaging_notifications]
        driver = messagingv2
        ...

Restart the Keystone services to apply the configuration change.


.. _nova-notifications:

Nova notifications
==================

Nova is the name of the OpenStack compute service.

Enable notifications in Nova configuration file, usually in ``/etc/nova/nova.conf``:


.. code-block:: bash

        [DEFAULT]
        ...
        notify_on_state_change = vm_and_task_state
        ...
        [oslo_messaging_notifications]
        driver = messagingv2

Restart the Nova services to apply the configuration change.


.. _glance-notifications:

Glance notifications
====================

The OpenStack Image Service called Glance provides discovery, registration and delivery services for disk and server
images. It has the ability to copy (or snapshot) a server image and then to store it promptly.

Enable notifications in Glance configuration file, usually in ``/etc/glance/glance-api.conf``:


.. code-block:: bash

        [oslo_messaging_notifications]
        driver = messagingv2

Restart the Glance services to apply the configuration change.

.. _neutron-notifications:

Neutron notifications
=====================

OpenStack Neutron is an SDN networking project focused on delivering networking-as-a-service (NaaS) in
virtual compute environments.

Make sure that the following settings are included in the Neutron configuration file.
Neutron Configuration file path is usually ``/etc/neutron/neutron.conf``:


.. code-block:: bash

        ...
        [oslo_messaging_notifications]
        driver = messagingv2
        ...

Restart the Neutron services to apply the configuration change.


.. _cinder-notifications:

Cinder notifications
====================

Cinder is the code name for the OpenStack Block Storage service. OpenStack Block Storage provisions and manages
block devices known as Cinder volumes.

Make sure that the following settings are included in the Cinder configuration file,
usually ``/etc/cinder/cinder.conf``:

.. code-block:: bash

        ...
        [oslo_messaging_notifications]
        driver = messagingv2
        ...

Restart the Cinder services to apply the configuration change.