Merge "[config-ref] Convert the Dell drivers to RST"
This commit is contained in:
Jenkins
@@ -1,3 +1,5 @@
|
||||
.. _block-storage-sample-configuration-file:
|
||||
|
||||
========================================
|
||||
Block Storage sample configuration files
|
||||
========================================
|
||||
|
||||
@@ -9,12 +9,13 @@ Supported operations
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
- Create, delete, attach, and detach volumes.
|
||||
|
||||
- Create, list, and delete volume snapshots.
|
||||
|
||||
- Clone a volume.
|
||||
|
||||
The Block Storage service supports:
|
||||
Configuration
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
The OpenStack Block Storage service supports:
|
||||
|
||||
- Multiple instances of Dell EqualLogic Groups or Dell EqualLogic Group
|
||||
Storage Pools and multiple pools on a single array.
|
||||
@@ -22,28 +23,24 @@ The Block Storage service supports:
|
||||
- Multiple instances of Dell EqualLogic Groups or Dell EqualLogic Group
|
||||
Storage Pools or multiple pools on a single array.
|
||||
|
||||
The Dell EqualLogic volume driver's ability to access the EqualLogic
|
||||
Group is dependent upon the generic block storage driver's SSH settings
|
||||
in the ``/etc/cinder/cinder.conf`` file (see the section called
|
||||
`Block Storage sample configuration files
|
||||
<http://docs.openstack.org/liberty/config-reference/
|
||||
content/section_block-storage-sample-configuration-files.html>`_
|
||||
for reference).
|
||||
The Dell EqualLogic volume driver's ability to access the EqualLogic Group is
|
||||
dependent upon the generic block storage driver's SSH settings in the
|
||||
``/etc/cinder/cinder.conf`` file (see
|
||||
:ref:`block-storage-sample-configuration-file` for reference).
|
||||
|
||||
.. include:: ../../tables/cinder-eqlx.rst
|
||||
|
||||
Default (single-instance) configuration
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
---------------------------------------
|
||||
|
||||
The following sample ``/etc/cinder/cinder.conf`` configuration lists the
|
||||
relevant settings for a typical Block Storage service using a single
|
||||
Dell EqualLogic Group:
|
||||
|
||||
.. code-block:: ini
|
||||
:linenos:
|
||||
|
||||
[DEFAULT]
|
||||
#Required settings
|
||||
# Required settings
|
||||
|
||||
volume_driver = cinder.volume.drivers.eqlx.DellEQLSanISCSIDriver
|
||||
san_ip = IP_EQLX
|
||||
@@ -52,7 +49,7 @@ Dell EqualLogic Group:
|
||||
eqlx_group_name = EQLX_GROUP
|
||||
eqlx_pool = EQLX_POOL
|
||||
|
||||
#Optional settings
|
||||
# Optional settings
|
||||
|
||||
san_thin_provision = true|false
|
||||
eqlx_use_chap = true|false
|
||||
@@ -67,77 +64,76 @@ Dell EqualLogic Group:
|
||||
|
||||
In this example, replace the following variables accordingly:
|
||||
|
||||
IP\_EQLX
|
||||
The IP address used to reach the Dell EqualLogic Group through SSH.
|
||||
This field has no default value.
|
||||
IP_EQLX
|
||||
The IP address used to reach the Dell EqualLogic Group through SSH.
|
||||
This field has no default value.
|
||||
|
||||
SAN\_UNAME
|
||||
The user name to login to the Group manager via SSH at the
|
||||
``san_ip``. Default user name is ``grpadmin``.
|
||||
SAN_UNAME
|
||||
The user name to login to the Group manager via SSH at the
|
||||
``san_ip``. Default user name is ``grpadmin``.
|
||||
|
||||
SAN\_PW
|
||||
The corresponding password of SAN\_UNAME. Not used when
|
||||
``san_private_key`` is set. Default password is ``password``.
|
||||
SAN_PW
|
||||
The corresponding password of SAN_UNAME. Not used when
|
||||
``san_private_key`` is set. Default password is ``password``.
|
||||
|
||||
EQLX\_GROUP
|
||||
The group to be used for a pool where the Block Storage service will
|
||||
create volumes and snapshots. Default group is ``group-0``.
|
||||
EQLX_GROUP
|
||||
The group to be used for a pool where the Block Storage service will
|
||||
create volumes and snapshots. Default group is ``group-0``.
|
||||
|
||||
EQLX\_POOL
|
||||
The pool where the Block Storage service will create volumes and
|
||||
snapshots. Default pool is ``default``. This option cannot be used
|
||||
for multiple pools utilized by the Block Storage service on a single
|
||||
Dell EqualLogic Group.
|
||||
EQLX_POOL
|
||||
The pool where the Block Storage service will create volumes and
|
||||
snapshots. Default pool is ``default``. This option cannot be used
|
||||
for multiple pools utilized by the Block Storage service on a single
|
||||
Dell EqualLogic Group.
|
||||
|
||||
EQLX\_UNAME
|
||||
The CHAP login account for each volume in a pool, if
|
||||
``eqlx_use_chap`` is set to ``true``. Default account name is
|
||||
``chapadmin``.
|
||||
EQLX_UNAME
|
||||
The CHAP login account for each volume in a pool, if
|
||||
``eqlx_use_chap`` is set to ``true``. Default account name is
|
||||
``chapadmin``.
|
||||
|
||||
EQLX\_PW
|
||||
The corresponding password of EQLX\_UNAME. The default password is
|
||||
randomly generated in hexadecimal, so you must set this password
|
||||
manually.
|
||||
EQLX_PW
|
||||
The corresponding password of EQLX_UNAME. The default password is
|
||||
randomly generated in hexadecimal, so you must set this password
|
||||
manually.
|
||||
|
||||
SAN\_KEY\_PATH (optional)
|
||||
The filename of the private key used for SSH authentication. This
|
||||
provides password-less login to the EqualLogic Group. Not used when
|
||||
``san_password`` is set. There is no default value.
|
||||
SAN_KEY_PATH (optional)
|
||||
The filename of the private key used for SSH authentication. This
|
||||
provides password-less login to the EqualLogic Group. Not used when
|
||||
``san_password`` is set. There is no default value.
|
||||
|
||||
In addition, enable thin provisioning for SAN volumes using the default
|
||||
``san_thin_provision = true`` setting.
|
||||
|
||||
Multi back-end Dell EqualLogic configuration
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
Multi back-end configuration
|
||||
----------------------------
|
||||
|
||||
The following example shows the typical configuration for a Block
|
||||
Storage service that uses two Dell EqualLogic back ends:
|
||||
|
||||
.. code-block:: ini
|
||||
:linenos:
|
||||
|
||||
enabled_backends = backend1,backend2
|
||||
san_ssh_port = 22
|
||||
ssh_conn_timeout = 30
|
||||
san_thin_provision = true
|
||||
|
||||
[backend1]
|
||||
volume_driver = cinder.volume.drivers.eqlx.DellEQLSanISCSIDriver
|
||||
volume_backend_name = backend1
|
||||
san_ip = IP_EQLX1
|
||||
san_login = SAN_UNAME
|
||||
san_password = SAN_PW
|
||||
eqlx_group_name = EQLX_GROUP
|
||||
eqlx_pool = EQLX_POOL
|
||||
|
||||
[backend2]
|
||||
volume_driver = cinder.volume.drivers.eqlx.DellEQLSanISCSIDriver
|
||||
volume_backend_name = backend2
|
||||
san_ip = IP_EQLX2
|
||||
ssh_conn_timeout = 30
|
||||
san_thin_provision = true
|
||||
|
||||
[backend1]
|
||||
volume_driver = cinder.volume.drivers.eqlx.DellEQLSanISCSIDriver
|
||||
volume_backend_name = backend1
|
||||
san_ip = IP_EQLX1
|
||||
san_login = SAN_UNAME
|
||||
san_password = SAN_PW
|
||||
eqlx_group_name = EQLX_GROUP
|
||||
eqlx_pool = EQLX_POOL
|
||||
eqlx_group_name = EQLX_GROUP
|
||||
eqlx_pool = EQLX_POOL
|
||||
|
||||
[backend2]
|
||||
volume_driver = cinder.volume.drivers.eqlx.DellEQLSanISCSIDriver
|
||||
volume_backend_name = backend2
|
||||
san_ip = IP_EQLX2
|
||||
san_login = SAN_UNAME
|
||||
san_password = SAN_PW
|
||||
eqlx_group_name = EQLX_GROUP
|
||||
eqlx_pool = EQLX_POOL
|
||||
|
||||
In this example:
|
||||
|
||||
|
||||
@@ -1,3 +1,135 @@
|
||||
===================================================
|
||||
Dell Storage Center Fibre Channel and iSCSI drivers
|
||||
===================================================
|
||||
|
||||
The Dell Storage Center volume driver interacts with configured Storage
|
||||
Center arrays.
|
||||
|
||||
The Dell Storage Center driver manages Storage Center arrays through
|
||||
Enterprise Manager. Enterprise Manager connection settings and Storage
|
||||
Center options are defined in the ``cinder.conf`` file.
|
||||
|
||||
Prerequisite: Dell Enterprise Manager 2015 R1 or later must be used.
|
||||
|
||||
Supported operations
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
|
||||
The Dell Storage Center volume driver provides the following Cinder
|
||||
volume operations:
|
||||
|
||||
- Create, delete, attach (map), and detach (unmap) volumes.
|
||||
- Create, list, and delete volume snapshots.
|
||||
- Create a volume from a snapshot.
|
||||
- Copy an image to a volume.
|
||||
- Copy a volume to an image.
|
||||
- Clone a volume.
|
||||
- Extend a volume.
|
||||
|
||||
Extra spec options
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Volume type extra specs can be used to select different Storage
|
||||
Profiles.
|
||||
|
||||
Storage Profiles control how Storage Center manages volume data. For a
|
||||
given volume, the selected Storage Profile dictates which disk tier
|
||||
accepts initial writes, as well as how data progression moves data
|
||||
between tiers to balance performance and cost. Predefined Storage
|
||||
Profiles are the most effective way to manage data in Storage Center.
|
||||
|
||||
By default, if no Storage Profile is specified in the volume extra
|
||||
specs, the default Storage Profile for the user account configured for
|
||||
the Block Storage driver is used. The extra spec key
|
||||
``storagetype:storageprofile`` with the value of the name of the Storage
|
||||
Profile on the Storage Center can be set to allow to use Storage
|
||||
Profiles other than the default.
|
||||
|
||||
For ease of use from the command line, spaces in Storage Profile names
|
||||
are ignored. As an example, here is how to define two volume types using
|
||||
the ``High Priority`` and ``Low Priority`` Storage Profiles:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
$ cinder type-create "GoldVolumeType"
|
||||
$ cinder type-key "GoldVolumeType" set storagetype:storageprofile=highpriority
|
||||
$ cinder type-create "BronzeVolumeType"
|
||||
$ cinder type-key "BronzeVolumeType" set storagetype:storageprofile=lowpriority
|
||||
|
||||
iSCSI configuration
|
||||
~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Use the following instructions to update the configuration file for iSCSI:
|
||||
|
||||
.. code-block:: ini
|
||||
|
||||
default_volume_type = delliscsi
|
||||
enabled_backends = delliscsi
|
||||
|
||||
[delliscsi]
|
||||
# Name to give this storage backend
|
||||
volume_backend_name = delliscsi
|
||||
# The iSCSI driver to load
|
||||
volume_driver = cinder.volume.drivers.dell.dell_storagecenter_iscsi.DellStorageCenterISCSIDriver
|
||||
# IP address of Enterprise Manager
|
||||
san_ip = 172.23.8.101
|
||||
# Enterprise Manager user name
|
||||
san_login = Admin
|
||||
# Enterprise Manager password
|
||||
san_password = secret
|
||||
# The Storage Center iSCSI IP address
|
||||
iscsi_ip_address = 192.168.0.20
|
||||
# The Storage Center serial number to use
|
||||
dell_sc_ssn = 64702
|
||||
|
||||
# ==Optional settings==
|
||||
# The Enterprise Manager API port
|
||||
dell_sc_api_port = 3033
|
||||
# Server folder to place new server definitions
|
||||
dell_sc_server_folder = devstacksrv
|
||||
# Volume folder to place created volumes
|
||||
dell_sc_volume_folder = devstackvol/Cinder
|
||||
# The iSCSI IP port
|
||||
iscsi_port = 3260
|
||||
|
||||
Fibre Channel configuration
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Use the following instructions to update the configuration file for fibre
|
||||
channel:
|
||||
|
||||
.. code-block:: ini
|
||||
|
||||
default_volume_type = dellfc
|
||||
enabled_backends = dellfc
|
||||
|
||||
[dellfc]
|
||||
# Name to give this storage backend
|
||||
volume_backend_name = dellfc
|
||||
# The FC driver to load
|
||||
volume_driver = cinder.volume.drivers.dell.dell_storagecenter_fc.DellStorageCenterFCDriver
|
||||
# IP address of Enterprise Manager
|
||||
san_ip = 172.23.8.101
|
||||
# Enterprise Manager user name
|
||||
san_login = Admin
|
||||
# Enterprise Manager password
|
||||
san_password = secret
|
||||
# The Storage Center serial number to use
|
||||
dell_sc_ssn = 64702
|
||||
|
||||
# Optional settings
|
||||
|
||||
# The Enterprise Manager API port
|
||||
dell_sc_api_port = 3033
|
||||
# Server folder to place new server definitions
|
||||
dell_sc_server_folder = devstacksrv
|
||||
# Volume folder to place created volumes
|
||||
dell_sc_volume_folder = devstackvol/Cinder
|
||||
|
||||
Driver options
|
||||
~~~~~~~~~~~~~~
|
||||
|
||||
The following table contains the configuration options specific to the
|
||||
Dell Storage Center volume driver.
|
||||
|
||||
.. include:: ../../tables/cinder-dellsc.rst
|
||||
|
||||
Reference in New Issue
Block a user