Do not use include for blockstorage-manage-volumes.rst
Do not use include and thus create a very large page, use the normal toctree. Change-Id: I2a566b1d78ddb3c00aa080a7b19141d99f682ae1
This commit is contained in:
Andreas Jaeger
parent
3e71b640a7
commit
9d0e5deed8
@ -1,5 +1,6 @@
|
||||
================
|
||||
Boot from volume
|
||||
~~~~~~~~~~~~~~~~
|
||||
================
|
||||
|
||||
In some cases, you can store and run instances from inside volumes.
|
||||
For information, see the `Launch an instance from a volume`_ section
|
||||
|
||||
@ -1,8 +1,9 @@
|
||||
.. highlight:: console
|
||||
:linenothreshold: 5
|
||||
|
||||
==================
|
||||
Consistency groups
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
==================
|
||||
|
||||
Consistency group support is available in OpenStack Block Storage. The
|
||||
support is added for creating snapshots of consistency groups. This
|
||||
|
||||
@ -1,8 +1,9 @@
|
||||
.. highlight:: ini
|
||||
:linenothreshold: 5
|
||||
|
||||
==========================================================
|
||||
Configure and use driver filter and weighing for scheduler
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
==========================================================
|
||||
|
||||
OpenStack Block Storage enables you to choose a volume back end based on
|
||||
back-end specific properties by using the DriverFilter and
|
||||
@ -12,7 +13,8 @@ based on requested volume properties as well as various back-end
|
||||
specific properties.
|
||||
|
||||
What is driver filter and weigher and when to use it
|
||||
----------------------------------------------------
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
The driver filter and weigher gives you the ability to more finely
|
||||
control how the OpenStack Block Storage scheduler chooses the best back
|
||||
end to use when handling a volume request. One example scenario where
|
||||
@ -28,7 +30,8 @@ of the back end degrades. The driver filter and weigher can provide a
|
||||
way for these limits to be checked for.
|
||||
|
||||
Enable driver filter and weighing
|
||||
---------------------------------
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
To enable the driver filter, set the ``scheduler_default_filters`` option in
|
||||
the :file:`cinder.conf` file to ``DriverFilter`` or add it to the list if
|
||||
other filters are already present.
|
||||
@ -63,7 +66,8 @@ Example :file:`cinder.conf` configuration file::
|
||||
these.
|
||||
|
||||
Defining your own filter and goodness functions
|
||||
-----------------------------------------------
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
You can define your own filter and goodness functions through the use of
|
||||
various properties that OpenStack Block Storage has exposed. Properties
|
||||
exposed include information about the volume request being made,
|
||||
@ -88,7 +92,8 @@ highest).
|
||||
|
||||
|
||||
Supported operations in filter and goodness functions
|
||||
-----------------------------------------------------
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Below is a table of all the operations currently usable in custom filter
|
||||
and goodness functions created by you:
|
||||
|
||||
@ -114,7 +119,8 @@ and goodness functions created by you:
|
||||
cause errors to be thrown at volume request time.
|
||||
|
||||
Available properties when creating custom functions
|
||||
---------------------------------------------------
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
There are various properties that can be used in either the
|
||||
``filter_function`` or the ``goodness_function`` strings. The properties allow
|
||||
access to volume info, qos settings, extra specs, and so on.
|
||||
@ -123,7 +129,7 @@ The following properties and their sub-properties are currently
|
||||
available for use:
|
||||
|
||||
Host stats for a back end
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
-------------------------
|
||||
host
|
||||
The host's name
|
||||
|
||||
@ -152,13 +158,15 @@ reserved\_percentage
|
||||
The reserved storage percentage
|
||||
|
||||
Capabilities specific to a back end
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
-----------------------------------
|
||||
|
||||
These properties are determined by the specific back end
|
||||
you are creating filter and goodness functions for. Some back ends
|
||||
may not have any properties available here.
|
||||
|
||||
Requested volume properties
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
---------------------------
|
||||
|
||||
status
|
||||
Status for the requested volume
|
||||
|
||||
@ -216,13 +224,15 @@ metadata
|
||||
The property most used from here will most likely be the ``size`` sub-property.
|
||||
|
||||
Extra specs for the requested volume type
|
||||
-----------------------------------------
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
View the available properties for volume types by running::
|
||||
|
||||
$ cinder extra-specs-list
|
||||
|
||||
Current QoS specs for the requested volume type
|
||||
-----------------------------------------------
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
View the available properties for volume types by running::
|
||||
|
||||
$ cinder qos-list
|
||||
@ -233,7 +243,8 @@ format:
|
||||
``<property>.<sub_property>``
|
||||
|
||||
Diver filter and weigher usage examples
|
||||
---------------------------------------
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Below are examples for using the filter and weigher separately,
|
||||
together, and using driver-specific properties.
|
||||
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
=====================
|
||||
Use LIO iSCSI support
|
||||
~~~~~~~~~~~~~~~~~~~~~
|
||||
=====================
|
||||
|
||||
The default mode for the ``iscsi_helper`` tool is ``tgtadm``.
|
||||
To use LIO iSCSI, install the ``python-rtslib`` package, and set
|
||||
|
||||
@ -54,24 +54,7 @@ To set up Compute to use volumes, ensure that Block Storage is
|
||||
installed along with ``lvm2``. This guide describes how to
|
||||
troubleshoot your installation and back up your Compute volumes.
|
||||
|
||||
.. include:: blockstorage-boot-from-volume.rst
|
||||
.. include:: blockstorage_nfs_backend.rst
|
||||
.. include:: blockstorage_glusterfs_backend.rst
|
||||
.. include:: blockstorage_multi_backend.rst
|
||||
.. include:: blockstorage_backup_disks.rst
|
||||
.. include:: blockstorage_volume_migration.rst
|
||||
.. include:: blockstorage_glusterfs_removal.rst
|
||||
.. include:: blockstorage_volume_backups.rst
|
||||
.. include:: blockstorage_volume_backups_export_import.rst
|
||||
.. include:: blockstorage-lio-iscsi-support.rst
|
||||
.. include:: blockstorage_volume_number_weighter.rst
|
||||
.. include:: blockstorage-consistency-groups.rst
|
||||
.. include:: blockstorage-driver-filter-weighing.rst
|
||||
.. include:: blockstorage_ratelimit_volume_copy_bandwidth.rst
|
||||
.. include:: blockstorage_over_subscription.rst
|
||||
|
||||
.. toctree::
|
||||
:hidden:
|
||||
|
||||
blockstorage-boot-from-volume.rst
|
||||
blockstorage_nfs_backend.rst
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
===================================
|
||||
Back up Block Storage service disks
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
===================================
|
||||
|
||||
While you can use the LVM snapshot to create snapshots, you can also use
|
||||
it to back up your volumes. By using LVM snapshot, you reduce the size
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
==============================
|
||||
Configure a GlusterFS back end
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
==============================
|
||||
|
||||
This section explains how to configure OpenStack Block Storage to use
|
||||
GlusterFS as a back end. You must be able to access the GlusterFS shares
|
||||
|
||||
@ -3,8 +3,9 @@
|
||||
.. highlight: ini
|
||||
:linenothreshold: 5
|
||||
|
||||
===============================================
|
||||
Gracefully remove a GlusterFS volume from usage
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
===============================================
|
||||
|
||||
Configuring the ``cinder`` volume service to use GlusterFS involves creating a
|
||||
shares file (for example, :file:`/etc/cinder/glusterfs`). This shares file
|
||||
|
||||
@ -3,8 +3,9 @@
|
||||
.. highlight: ini
|
||||
:linenothreshold: 5
|
||||
|
||||
====================================
|
||||
Configure multiple-storage back ends
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
====================================
|
||||
|
||||
When you configure multiple-storage back ends, you can create several
|
||||
back-end storage solutions that serve the same OpenStack Compute
|
||||
|
||||
@ -1,5 +1,6 @@
|
||||
=================================
|
||||
Configure an NFS storage back end
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
=================================
|
||||
|
||||
This section explains how to configure OpenStack Block Storage to use
|
||||
NFS storage. You must be able to access the NFS shares from the server
|
||||
|
||||
@ -3,8 +3,9 @@
|
||||
.. highlight: ini
|
||||
:linenothreshold: 5
|
||||
|
||||
=====================================
|
||||
Oversubscription in thin provisioning
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
=====================================
|
||||
|
||||
OpenStack Block Storage enables you to choose a volume back end based on
|
||||
virtual capacities for thin provisioning using the oversubscription ratio.
|
||||
@ -13,7 +14,8 @@ A reference implementation is provided for the default LVM driver. The
|
||||
illustration below uses the LVM driver as an example.
|
||||
|
||||
Configure oversubscription settings
|
||||
-----------------------------------
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
To support oversubscription in thin provisioning, a flag
|
||||
``max_over_subscription_ratio`` is introduced into :file:`cinder.conf`.
|
||||
This is a float representation of the oversubscription ratio when thin
|
||||
@ -45,7 +47,7 @@ This flag represents the percentage of the back-end capacity that is reserved.
|
||||
capacity.
|
||||
|
||||
Capabilities
|
||||
------------
|
||||
~~~~~~~~~~~~
|
||||
|
||||
Drivers can report the following capabilities for a back end or a pool:
|
||||
|
||||
@ -71,7 +73,7 @@ The LVM driver reports ``thin_provisioning_support=True`` and
|
||||
``thin_provisioning_support=False`` and ``thick_provisioning_support=True``.
|
||||
|
||||
Volume type extra specs
|
||||
-----------------------
|
||||
~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
If volume type is provided as part of the volume creation request, it can
|
||||
have the following extra specs defined:
|
||||
@ -98,14 +100,14 @@ supports thin provisioning, thick provisioning, or both to match the needs
|
||||
of a specific volume type.
|
||||
|
||||
Capacity filter
|
||||
---------------
|
||||
~~~~~~~~~~~~~~~
|
||||
|
||||
In the capacity filter, ``max_over_subscription_ratio`` is used when
|
||||
choosing a back end if ``thin_provisioning_support`` is True and
|
||||
``max_over_subscription_ratio`` is greater than 1.0.
|
||||
|
||||
Capacity weigher
|
||||
----------------
|
||||
~~~~~~~~~~~~~~~~
|
||||
|
||||
In the capacity weigher, virtual free capacity is used for ranking if
|
||||
``thin_provisioning_support`` is True. Otherwise, real free capacity
|
||||
|
||||
@ -3,8 +3,9 @@
|
||||
.. 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
|
||||
@ -13,7 +14,7 @@ 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
|
||||
|
||||
@ -3,8 +3,9 @@
|
||||
.. highlight: ini
|
||||
:linenothreshold: 5
|
||||
|
||||
===========================
|
||||
Back up and restore volumes
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
===========================
|
||||
|
||||
The **cinder** command-line interface provides the tools for creating a
|
||||
volume backup. You can restore a volume from a backup as long as the
|
||||
|
||||
@ -3,8 +3,10 @@
|
||||
.. highlight: ini
|
||||
:linenothreshold: 5
|
||||
|
||||
=================================
|
||||
Export and import backup metadata
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
=================================
|
||||
|
||||
|
||||
A volume backup can only be restored on the same Block Storage service. This
|
||||
is because restoring a volume from a backup requires metadata available on
|
||||
|
||||
@ -3,8 +3,9 @@
|
||||
.. highlight: ini
|
||||
:linenothreshold: 5
|
||||
|
||||
===============
|
||||
Migrate volumes
|
||||
~~~~~~~~~~~~~~~
|
||||
===============
|
||||
|
||||
OpenStack has the ability to migrate volumes between back-ends which support
|
||||
its volume-type. Migrating a volume transparently moves its data from the
|
||||
|
||||
@ -3,8 +3,9 @@
|
||||
.. highlight: ini
|
||||
:linenothreshold: 5
|
||||
|
||||
========================================
|
||||
Configure and use volume number weighter
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
========================================
|
||||
|
||||
OpenStack Block Storage enables you to choose a volume back end according
|
||||
to ``free_capacity`` and ``allocated_capacity``. The volume number weighter
|
||||
@ -13,7 +14,7 @@ number in the volume back end. This can provide another means to improve
|
||||
the volume back ends' I/O balance and the volumes' I/O performance.
|
||||
|
||||
Enable volume number weighter
|
||||
-----------------------------
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
To enable a volume number weighter, set the
|
||||
``scheduler_default_weighters`` to ``VolumeNumberWeigher`` flag in the
|
||||
@ -21,7 +22,8 @@ To enable a volume number weighter, set the
|
||||
as the selected weighter.
|
||||
|
||||
Configure multiple-storage back ends
|
||||
------------------------------------
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
|
||||
To configure ``VolumeNumberWeigher``, use ``LVMISCSIDriver``
|
||||
as the volume driver.
|
||||
@ -46,7 +48,7 @@ This example configuration defines two back ends:
|
||||
volume_backend_name=LVM_iSCSI
|
||||
|
||||
Volume type
|
||||
-----------
|
||||
~~~~~~~~~~~
|
||||
|
||||
Define a volume type in Block Storage::
|
||||
|
||||
@ -60,7 +62,7 @@ This example creates a lvm volume type with
|
||||
``volume_backend_name=LVM_iSCSI`` as extra specifications.
|
||||
|
||||
Usage
|
||||
-----
|
||||
~~~~~
|
||||
|
||||
To create six 1-GB volumes, run the
|
||||
:command:`cinder create --volume-type lvm 1` command six times::
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user