openstack/openstack-manuals
Code Issues Proposed changes

Merge "Converts section_ratelimit-volume-copy-bandwidth.xml to RST"

Browse Source
This commit is contained in:
Jenkins 2015-07-08 17:32:45 +00:00 committed by Gerrit Code Review
commit 882cfd8295
2 changed files with 51 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/admin-guide-cloud-rst/source/blockstorage-manage-volumes.rst
View File

@ -62,6 +62,7 @@ troubleshoot your installation and back up your Compute volumes.
.. include:: blockstorage-lio-iscsi-support.rst
.. include:: blockstorage-consistency-groups.rst
.. include:: blockstorage-driver-filter-weighing.rst
.. include:: blockstorage_ratelimit_volume_copy_bandwidth.rst
.. toctree::
:hidden:
@ -74,6 +75,7 @@ troubleshoot your installation and back up your Compute volumes.
blockstorage-lio-iscsi-support.rst
blockstorage-consistency-groups.rst
blockstorage-driver-filter-weighing.rst
blockstorage_ratelimit_volume_copy_bandwidth.rst
.. TODO (MZ) Convert and include the following sections
include: blockstorage/section_volume-migration.xml
@ -81,5 +83,4 @@ troubleshoot your installation and back up your Compute volumes.
include: blockstorage/section_volume-backups.xml
include: blockstorage/section_volume-backups-export-import.xml
include: blockstorage/section_volume_number_weighter.xml
include: blockstorage/section_ratelimit-volume-copy-bandwidth.xml
include: blockstorage/section_over_subscription.xml

49
doc/admin-guide-cloud-rst/source/blockstorage_ratelimit_volume_copy_bandwidth.rst Normal file
View File

@ -0,0 +1,49 @@
.. _ratelimit_volume_copy_bandwidth:
.. highlight: ini
:linenothreshold: 5
Rate-limit volume copy bandwidth
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
When you create a new volume from an image or an existing volume, or
when you upload a volume image to the Image Service, large data copy
may stress disk and network bandwidth. To mitigate slow down of data
access from the instances, OpenStack Block Storage supports rate-limiting
of volume data copy bandwidth.
Configure volume copy bandwidth limit
-------------------------------------
To configure the volume copy bandwidth limit, set the
``volume_copy_bps_limit`` option in the configuration groups for each
back end in the ``cinder.conf`` file. This option takes the integer of
maximum bandwidth allowed for volume data copy in byte per second. If
this option is set to ``0``, the rate-limit is disabled.
While multiple volume data copy operations are running in the same back
end, the specified bandwidth is divided to each copy.
Example ``cinder.conf`` configuration file to limit volume copy bandwidth
of ``lvmdriver-1`` up to 100 MiB/s:
.. code-block:: ini
:linenos:
[lvmdriver-1]
volume_group=cinder-volumes-1
volume_driver=cinder.volume.drivers.lvm.LVMISCSIDriver
volume_backend_name=LVM_iSCSI
volume_copy_bps_limit=104857600
.. note::
This feature requires libcgroup to set up blkio cgroup for disk I/O
bandwidth limit. The libcgroup is provided by the cgroup-bin package
in Debian and Ubuntu, or by the libcgroup-tools package in Fedora,
Red Hat Enterprise Linux, CentOS, openSUSE, and SUSE Linux Enterprise.
.. note::
Some back ends which use remote file systems such as NFS are not
supported by this feature.