.. index:: sync

=============================
Synchronize OpenStack objects
=============================

Fleio is storing a copy of the OpenStack objects in its database. This cache allows Fleio to be faster and puts less
load on the OpenStack API.

.. index:: fleio service, updated

updated container
=================

The ``fleio-updated-1`` container connects to an OpenStack messaging queue and receives notifications when OpenStack
objects (like instances, volumes or networks) are created, modified or deleted.

The ``fleio-updated-1`` container processes these notifications and updates the Fleio database.

.. index:: automatic sync

Automatic synchronization
=========================

The synchronization process is running automatically after saving the initial OpenStack configuration, and it will
populate the Fleio database with OpenStack objects.

.. index:: manual sync
.. _manual-sync:

Manual synchronization
======================

You can start a sync from the staff web application: ``Settings`` > ``OpenStack`` and click ``Sync`` button from the
bottom-right corner of the screen.

Or by using the command line:

.. code-block:: bash

    fleio sync

The manual synchronization is affected by :ref:`sync-settings`.

Special cases
=============

During synchronization Fleio will attempt to make a copy of all supported OpenStack objects into Fleio database.
However, there are some special cases where objects are treated differently or even ignored.

Temporary volumes
-----------------

.. versionadded:: 2022.05.1

During various operations (e.g. volume backup) `cinder` may create temporary volumes that do not count against quota and
for whom no notifications are sent. This volumes will not be added to Fleio database during normal operation however if
you trigger a sync during a volume backup for example then the temporary volume may be added to the Fleio database until
a future sync will remove it.

To prevent this we check `consumes_quota` attribute for volumes, if `consumes_quota` is False the volume will be ignored
during sync process.

Note that `consumes_quota` attribute is available only for `cinder` API version 3.65 or greater, if this API version is
not available in your OpenStack deployment we provide a workaround for volume backups
(see :ref:`exclude-backup-volumes-from-sync` )