5c5927a3d2
These closely related features are the source of a disproportionate number of bugs and a large amount of confusion among users. The spread of information around multiple docs probably doesn't help matters. Do what we've already done for the metadata service and remote consoles and clean these docs up. There are a number of important changes: - All documentation related to host aggregates and availability zones is placed in one of three documents, '/user/availability-zones', '/admin/aggregates' and '/admin/availability-zones'. (note that there is no '/user/aggregates' document since this is not user-facing) - References to these features are updated to point to the new location - A glossary is added. Currently this only contains definitions for host aggregates and availability zones - nova CLI commands are replaced with their openstack CLI counterparts - Some gaps in related documentation are closed Change-Id: If847b0085dbfb4c813d4a8d14d99346f8252bc19 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
118 lines
3.8 KiB
ReStructuredText
118 lines
3.8 KiB
ReStructuredText
==================
|
|
File-backed memory
|
|
==================
|
|
|
|
.. important::
|
|
|
|
As of the 18.0.0 Rocky release, the functionality described below is
|
|
only supported by the libvirt/KVM driver.
|
|
|
|
The file-backed memory feature in Openstack allows a Nova node to serve guest
|
|
memory from a file backing store. This mechanism uses the libvirt file memory
|
|
source, causing guest instance memory to be allocated as files within the
|
|
libvirt memory backing directory.
|
|
|
|
Since instance performance will be related to the speed of the backing store,
|
|
this feature works best when used with very fast block devices or virtual file
|
|
systems - such as flash or RAM devices.
|
|
|
|
When configured, ``nova-compute`` will report the capacity configured for
|
|
file-backed memory to placement in place of the total system memory capacity.
|
|
This allows the node to run more instances than would normally fit
|
|
within system memory.
|
|
|
|
When available in libvirt and qemu, instance memory will be discarded by qemu
|
|
at shutdown by calling ``madvise(MADV_REMOVE)``, to avoid flushing any dirty
|
|
memory to the backing store on exit.
|
|
|
|
To enable file-backed memory, follow the steps below:
|
|
|
|
#. `Configure the backing store`_
|
|
|
|
#. `Configure Nova Compute for file-backed memory`_
|
|
|
|
.. important::
|
|
|
|
It is not possible to live migrate from a node running a version of
|
|
OpenStack that does not support file-backed memory to a node with file
|
|
backed memory enabled. It is recommended that all Nova compute nodes are
|
|
upgraded to Rocky before enabling file-backed memory.
|
|
|
|
Prerequisites and Limitations
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Libvirt
|
|
File-backed memory requires libvirt version 4.0.0 or newer. Discard
|
|
capability requires libvirt version 4.4.0 or newer.
|
|
|
|
Qemu
|
|
File-backed memory requires qemu version 2.6.0 or newer.Discard capability
|
|
requires qemu version 2.10.0 or newer.
|
|
|
|
Memory overcommit
|
|
File-backed memory is not compatible with memory overcommit.
|
|
``ram_allocation_ratio`` must be set to ``1.0`` in ``nova.conf``, and the
|
|
host must not be added to a :doc:`host aggregate </admin/aggregates>`
|
|
with ``ram_allocation_ratio`` set to anything but ``1.0``.
|
|
|
|
Huge pages
|
|
File-backed memory is not compatible with huge pages. Instances with huge
|
|
pages configured will not start on a host with file-backed memory enabled. It
|
|
is recommended to use host aggregates to ensure instances configured for
|
|
huge pages are not placed on hosts with file-backed memory configured.
|
|
|
|
Handling these limitations could be optimized with a scheduler filter in the
|
|
future.
|
|
|
|
Configure the backing store
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
.. note::
|
|
|
|
``/dev/sdb`` and the ``ext4`` filesystem are used here as an example. This
|
|
will differ between environments.
|
|
|
|
.. note::
|
|
|
|
``/var/lib/libvirt/qemu/ram`` is the default location. The value can be
|
|
set via ``memory_backing_dir`` in ``/etc/libvirt/qemu.conf``, and the
|
|
mountpoint must match the value configured there.
|
|
|
|
By default, Libvirt with qemu/KVM allocates memory within
|
|
``/var/lib/libvirt/qemu/ram/``. To utilize this, you need to have the backing
|
|
store mounted at (or above) this location.
|
|
|
|
#. Create a filesystem on the backing device
|
|
|
|
.. code-block:: console
|
|
|
|
# mkfs.ext4 /dev/sdb
|
|
|
|
#. Mount the backing device
|
|
|
|
Add the backing device to ``/etc/fstab`` for automatic mounting to
|
|
``/var/lib/libvirt/qemu/ram``
|
|
|
|
Mount the device
|
|
|
|
.. code-block:: console
|
|
|
|
# mount /dev/sdb /var/lib/libvirt/qemu/ram
|
|
|
|
Configure Nova Compute for file-backed memory
|
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
#. Enable File-backed memory in ``nova-compute``
|
|
|
|
Configure Nova to utilize file-backed memory with the capacity of the
|
|
backing store in MiB. 1048576 MiB (1 TiB) is used in this example.
|
|
|
|
Edit ``/etc/nova/nova.conf``
|
|
|
|
.. code-block:: ini
|
|
|
|
[libvirt]
|
|
file_backed_memory=1048576
|
|
|
|
#. Restart the ``nova-compute`` service
|