openstack/cinder
Code Issues Proposed changes

Updating docs for Datera driver

Browse Source 
- Reformatted lines to respect doc8 79 char limit

Change-Id: Ib9868cc6fcb5b4351dcc504954e943eac92596ab
Blueprint: https://blueprints.launchpad.net/cinder/+spec/datera-driver-restoration
This commit is contained in:
Mark Korondi
2020-04-20 22:54:06 +02:00
parent 3e958207ab
commit d0e30ff6f5
2 changed files with 38 additions and 73 deletions
Download Patch File Download Diff File Expand all files Collapse all files

109
doc/source/configuration/block-storage/drivers/datera-volume-driver.rst
View File

@@ -5,9 +5,9 @@ Datera drivers
Datera iSCSI driver Datera iSCSI driver
------------------- -------------------
The Datera Elastic Data Fabric (EDF) is a scale-out storage software that The Datera Data Services Platform (DSP) is a scale-out storage software that
turns standard, commodity hardware into a RESTful API-driven, intent-based turns standard, commodity hardware into a RESTful API-driven, intent-based
policy controlled storage fabric for large-scale clouds. The Datera EDF policy controlled storage fabric for large-scale clouds. The Datera DSP
integrates seamlessly with the Block Storage service. It provides storage integrates seamlessly with the Block Storage service. It provides storage
through the iSCSI block protocol framework over the iSCSI block protocol. through the iSCSI block protocol framework over the iSCSI block protocol.
Datera supports all of the Block Storage services. Datera supports all of the Block Storage services.
@@ -18,13 +18,9 @@ System requirements, prerequisites, and recommendations
Prerequisites Prerequisites
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
* Must be running compatible versions of OpenStack and Datera EDF. * All nodes must have access to Datera DSP through the iSCSI block protocol.
Please visit `here <https://github.com/datera/cinder-driver>`_ to determine
the correct version.
* All nodes must have access to Datera EDF through the iSCSI block protocol. * All nodes accessing the Datera DSP must have the following packages
* All nodes accessing the Datera EDF must have the following packages
installed: installed:
* Linux I/O (LIO) * Linux I/O (LIO)
@@ -56,27 +52,31 @@ Modify the ``/etc/cinder/cinder.conf`` file for Block Storage service.
default_volume_type = datera default_volume_type = datera
* Create a new section for the Datera back-end definition. The ``san_ip`` can * Create a new section for the Datera back-end definition. The ``VIP`` can
be either the Datera Management Network VIP or one of the Datera iSCSI be either the Datera Management Network VIP or one of the Datera iSCSI
Access Network VIPs depending on the network segregation requirements: Access Network VIPs depending on the network segregation requirements. For
a complete list of parameters that can be configured, please see the
section `Volume Driver Cinder.conf Options <https://github.com/Datera/cinder-driver/blob/master/README.rst#volume-driver-cinderconf-options>`_
.. code-block:: ini .. code-block:: ini
volume_driver = cinder.volume.drivers.datera.DateraDriver [datera]
san_ip = <IP_ADDR> # The OOB Management IP of the cluster volume_driver = cinder.volume.drivers.datera.datera_iscsi.DateraDriver
san_login = admin # Your cluster admin login san_ip = <VIP>
san_password = password # Your cluster admin password san_login = admin
san_is_local = true san_password = password
datera_num_replicas = 3 # Number of replicas to use for volume datera_tenant_id =
volume_backend_name = datera
datera_volume_type_defaults=replica_count:3
Enable the Datera volume driver Enable the Datera volume driver
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Verify the OpenStack control node can reach the Datera ``san_ip``: * Verify the OpenStack control node can reach the Datera ``VIP``:
.. code-block:: bash .. code-block:: bash
$ ping -c 4 <san_IP> $ ping -c 4 <VIP>
* Start the Block Storage service on all nodes running the ``cinder-volume`` * Start the Block Storage service on all nodes running the ``cinder-volume``
services: services:
@@ -85,31 +85,27 @@ Enable the Datera volume driver
$ service cinder-volume restart $ service cinder-volume restart
QoS support for the Datera drivers includes the ability to set the Configuring one (or more) Datera specific volume types
following capabilities in QoS Specs ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* **read_iops_max** -- must be positive integer There are extra volume type parameters that can be used to define Datera volume
types with specific QoS policies (R/W IOPS, R/W bandwidth) and/or placement
policies (replica count, type of media, IP pool to use, etc.)
* **write_iops_max** -- must be positive integer For a full list of supported options please see the `Volume-Type ExtraSpecs
<https://github.com/Datera/cinder-driver/blob/master/README.rst#volume-type-extraspecs>`_
* **total_iops_max** -- must be positive integer section in the driver documentation. See more examples in the `Usage
<https://github.com/Datera/cinder-driver/blob/master/README.rst#usage>`_
* **read_bandwidth_max** -- in KB per second, must be positive integer section.
* **write_bandwidth_max** -- in KB per second, must be positive integer
* **total_bandwidth_max** -- in KB per second, must be positive integer
.. code-block:: bash .. code-block:: bash
# Create qos spec # Create 2 replica volume type
$ openstack volume qos create --property total_iops_max=1000 total_bandwidth_max=2000 DateraBronze $ openstack volume type create datera_2way --property volume_backend_name=datera --property DF:replica_count=2
# Associate qos-spec with volume type # Create volume type with limited write IOPS
$ openstack volume qos associate DateraBronze VOLUME_TYPE $ openstack volume type create datera_iops --property volume_backend_name=datera --property DF:write_iops_max=5000
# Add additional qos values or update existing ones
$ openstack volume qos set --property read_bandwidth_max=500 DateraBronze
Supported operations Supported operations
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~
@@ -133,39 +129,8 @@ Supported operations
Configuring multipathing Configuring multipathing
~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~
The following configuration is for 3.X Linux kernels, some parameters in Enabling multipathing is strongly reccomended for reliability and availability
different Linux distributions may be different. Make the following changes reasons. Please refer to the following `file
in the ``multipath.conf`` file: <https://github.com/Datera/datera-csi/blob/master/assets/multipath.conf>`_ for
an example of configuring multipathing in Linux 3.x kernels. Some parameters
.. code-block:: text in different Linux distributions may be different.
defaults {
checker_timer 5
}
devices {
device {
vendor "DATERA"
product "IBLOCK"
getuid_callout "/lib/udev/scsi_id --whitelisted --
replace-whitespace --page=0x80 --device=/dev/%n"
path_grouping_policy group_by_prio
path_checker tur
prio alua
path_selector "queue-length 0"
hardware_handler "1 alua"
failback 5
}
}
blacklist {
device {
vendor ".*"
product ".*"
}
}
blacklist_exceptions {
device {
vendor "DATERA.*"
product "IBLOCK.*"
}
}

2
doc/source/reference/support-matrix.ini
View File

@@ -196,7 +196,7 @@ notes=A vendor driver is considered supported if the vendor is
accurate results. If a vendor doesn't meet this requirement accurate results. If a vendor doesn't meet this requirement
the driver is marked unsupported and is removed if the problem the driver is marked unsupported and is removed if the problem
isn't resolved before the end of the subsequent release. isn't resolved before the end of the subsequent release.
driver.datera=missing driver.datera=complete
driver.dell_emc_powermax=complete driver.dell_emc_powermax=complete
driver.dell_emc_sc=complete driver.dell_emc_sc=complete
driver.dell_emc_unity=complete driver.dell_emc_unity=complete