Files
cinder/doc/source/configuration/block-storage/drivers/lvm-volume-driver.rst
Sean McGinnis c87da91757 Add config table sphinx directive
In the past we had used an openstack-manuals tool to manually generate
config option tables that would then be included into driver config
documentation.

With the move of documentation in-tree and the deprecation and removal
of that tool, we have ended up with options that are no longer being
updated when drivers change, or maintainers are left manually updating
the existing tables.

This addes a sphinx extension to use a new config-table directive to
automatically pull in config options from the source so we no longer
need to perform any manual action to pick up changes.

Change-Id: I625fb96229001c326ed2400155e2d067279a400e
2018-04-26 13:47:43 -05:00

47 lines
1.3 KiB
ReStructuredText

===
LVM
===
The default volume back end uses local volumes managed by LVM.
This driver supports different transport protocols to attach volumes,
currently iSCSI and iSER.
Set the following in your ``cinder.conf`` configuration file, and use
the following options to configure for iSCSI transport:
.. code-block:: ini
volume_driver = cinder.volume.drivers.lvm.LVMVolumeDriver
iscsi_protocol = iscsi
Use the following options to configure for the iSER transport:
.. code-block:: ini
volume_driver = cinder.volume.drivers.lvm.LVMVolumeDriver
iscsi_protocol = iser
.. config-table::
:config-target: LVM
cinder.volume.drivers.lvm
.. caution::
When extending an existing volume which has a linked snapshot, the related
logical volume is deactivated. This logical volume is automatically
reactivated unless ``auto_activation_volume_list`` is defined in LVM
configuration file ``lvm.conf``. See the ``lvm.conf`` file for more
information.
If auto activated volumes are restricted, then include the cinder volume
group into this list:
.. code-block:: ini
auto_activation_volume_list = [ "existingVG", "cinder-volumes" ]
This note does not apply for thinly provisioned volumes
because they do not need to be deactivated.