Update Dell EMC docs to use config-table directive
Remove static config table files in favor of using dynamically generated options using config-table directive. Change-Id: I07fac023866fc4a61f157c3b8a75409b75ae2923
This commit is contained in:
Sean McGinnis
parent
bd4da9309d
commit
7795f9c9b5
|
|
@ -12,7 +12,6 @@ These options can also be set in the ``cinder.conf`` file.
|
|||
.. include:: ../tables/cinder-coordination.inc
|
||||
.. include:: ../tables/cinder-debug.inc
|
||||
.. include:: ../tables/cinder-drbd.inc
|
||||
.. include:: ../tables/cinder-emc.inc
|
||||
.. include:: ../tables/cinder-eternus.inc
|
||||
.. include:: ../tables/cinder-flashsystem.inc
|
||||
.. include:: ../tables/cinder-hgst.inc
|
||||
|
|
|
|||
|
|
@ -207,7 +207,10 @@ Configuration options
|
|||
|
||||
The ScaleIO driver supports these configuration options:
|
||||
|
||||
.. include:: ../../tables/cinder-emc_sio.inc
|
||||
.. config-table::
|
||||
:config-target: ScaleIO
|
||||
|
||||
cinder.volume.drivers.dell_emc.scaleio.driver
|
||||
|
||||
Volume Types
|
||||
------------
|
||||
|
|
|
|||
|
|
@ -158,7 +158,10 @@ Driver configuration
|
|||
Driver options
|
||||
~~~~~~~~~~~~~~
|
||||
|
||||
.. include:: ../../tables/cinder-dell_emc_unity.inc
|
||||
.. config-table::
|
||||
:config-target: Unity
|
||||
|
||||
cinder.volume.drivers.dell_emc.unity.driver
|
||||
|
||||
FC or iSCSI ports option
|
||||
------------------------
|
||||
|
|
|
|||
|
|
@ -1,9 +1,9 @@
|
|||
=================================
|
||||
Dell EMC EqualLogic volume driver
|
||||
=================================
|
||||
================================
|
||||
Dell EMC PS Series volume driver
|
||||
================================
|
||||
|
||||
The Dell EqualLogic volume driver interacts with configured EqualLogic
|
||||
arrays and supports various operations.
|
||||
The Dell PS Series (EqualLogic) volume driver interacts with configured PS
|
||||
Series arrays and supports various operations.
|
||||
|
||||
Supported operations
|
||||
~~~~~~~~~~~~~~~~~~~~
|
||||
|
|
@ -28,7 +28,10 @@ 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.inc
|
||||
.. config-table::
|
||||
:config-target: PS Series
|
||||
|
||||
cinder.volume.drivers.dell_emc.ps
|
||||
|
||||
Default (single-instance) configuration
|
||||
---------------------------------------
|
||||
|
|
|
|||
|
|
@ -398,4 +398,7 @@ Driver options
|
|||
The following table contains the configuration options specific to the
|
||||
Dell EMC Storage Center volume driver.
|
||||
|
||||
.. include:: ../../tables/cinder-dellsc.inc
|
||||
.. config-table::
|
||||
:config-target: SC Series
|
||||
|
||||
cinder.volume.drivers.dell_emc.sc.storagecenter_common
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
==============================================
|
||||
EMC XtremIO Block Storage driver configuration
|
||||
==============================================
|
||||
=====================================
|
||||
Dell EMC XtremIO Block Storage driver
|
||||
=====================================
|
||||
|
||||
The high performance XtremIO All Flash Array (AFA) offers Block Storage
|
||||
services to OpenStack. Using the driver, OpenStack Block Storage hosts
|
||||
|
|
@ -53,7 +53,10 @@ under a separate section in case of multiple back ends (for example
|
|||
[XTREMIO]). The configuration file is usually located under the
|
||||
following path ``/etc/cinder/cinder.conf``.
|
||||
|
||||
.. include:: ../../tables/cinder-emc_xtremio.inc
|
||||
.. config-table::
|
||||
:config-target: XtremIO
|
||||
|
||||
cinder.volume.drivers.dell_emc.xtremio
|
||||
|
||||
For a configuration example, refer to the configuration
|
||||
:ref:`emc_extremio_configuration_example`.
|
||||
|
|
@ -68,13 +71,13 @@ Configure the driver name by setting the following parameter in the
|
|||
|
||||
.. code-block:: ini
|
||||
|
||||
volume_driver = cinder.volume.drivers.emc.xtremio.XtremIOISCSIDriver
|
||||
volume_driver = cinder.volume.drivers.dell_emc.xtremio.XtremIOISCSIDriver
|
||||
|
||||
- For Fibre Channel:
|
||||
|
||||
.. code-block:: ini
|
||||
|
||||
volume_driver = cinder.volume.drivers.emc.xtremio.XtremIOFibreChannelDriver
|
||||
volume_driver = cinder.volume.drivers.dell_emc.xtremio.XtremIOFibreChannelDriver
|
||||
|
||||
XtremIO management server (XMS) IP
|
||||
----------------------------------
|
||||
|
|
@ -243,7 +246,7 @@ follows:
|
|||
enabled_backends = XtremIO
|
||||
|
||||
[XtremIO]
|
||||
volume_driver = cinder.volume.drivers.emc.xtremio.XtremIOFibreChannelDriver
|
||||
volume_driver = cinder.volume.drivers.dell_emc.xtremio.XtremIOFibreChannelDriver
|
||||
san_ip = XMS_IP
|
||||
xtremio_cluster_name = Cluster01
|
||||
san_login = XMS_USER
|
||||
|
|
|
|||
|
|
@ -1,24 +0,0 @@
|
|||
..
|
||||
Warning: Do not edit this file. It is automatically generated from the
|
||||
software project's code and your changes will be overwritten.
|
||||
|
||||
The tool to generate this file lives in openstack-doc-tools repository.
|
||||
|
||||
Please make any changes needed in the code, then run the
|
||||
autogenerate-config-doc tool from the openstack-doc-tools repository, or
|
||||
ask for help on the documentation mailing list, IRC channel or meeting.
|
||||
|
||||
.. _cinder-dell_emc_unity:
|
||||
|
||||
.. list-table:: Description of Dell EMC Unity volume driver configuration options
|
||||
:header-rows: 1
|
||||
:class: config-ref-table
|
||||
|
||||
* - Configuration option = Default value
|
||||
- Description
|
||||
* - **[DEFAULT]**
|
||||
-
|
||||
* - ``unity_io_ports`` = ``None``
|
||||
- (List) A comma-separated list of iSCSI or FC ports to be used. Each port can be Unix-style glob expressions.
|
||||
* - ``unity_storage_pool_names`` = ``None``
|
||||
- (List) A comma-separated list of storage pool names to be used.
|
||||
|
|
@ -1,42 +0,0 @@
|
|||
..
|
||||
Warning: Do not edit this file. It is automatically generated from the
|
||||
software project's code and your changes will be overwritten.
|
||||
|
||||
The tool to generate this file lives in openstack-doc-tools repository.
|
||||
|
||||
Please make any changes needed in the code, then run the
|
||||
autogenerate-config-doc tool from the openstack-doc-tools repository, or
|
||||
ask for help on the documentation mailing list, IRC channel or meeting.
|
||||
|
||||
.. _cinder-dellsc:
|
||||
|
||||
.. list-table:: Description of Dell Storage Center volume driver configuration options
|
||||
:header-rows: 1
|
||||
:class: config-ref-table
|
||||
|
||||
* - Configuration option = Default value
|
||||
- Description
|
||||
* - **[DEFAULT]**
|
||||
-
|
||||
* - ``dell_sc_api_port`` = ``3033``
|
||||
- (Port number) Dell API port
|
||||
* - ``dell_sc_server_folder`` = ``openstack``
|
||||
- (String) Name of the server folder to use on the Storage Center
|
||||
* - ``dell_sc_ssn`` = ``64702``
|
||||
- (Integer) Storage Center System Serial Number
|
||||
* - ``dell_sc_verify_cert`` = ``False``
|
||||
- (Boolean) Enable HTTPS SC certificate verification
|
||||
* - ``dell_sc_volume_folder`` = ``openstack``
|
||||
- (String) Name of the volume folder to use on the Storage Center
|
||||
* - ``dell_server_os`` = ``Red Hat Linux 6.x``
|
||||
- (String) Server OS type to use when creating a new server on the Storage Center.
|
||||
* - ``excluded_domain_ip`` = ``None``
|
||||
- (Unknown) Domain IP to be excluded from iSCSI returns.
|
||||
* - ``secondary_san_ip`` =
|
||||
- (String) IP address of secondary DSM controller
|
||||
* - ``secondary_san_login`` = ``Admin``
|
||||
- (String) Secondary DSM user name
|
||||
* - ``secondary_san_password`` =
|
||||
- (String) Secondary DSM user password name
|
||||
* - ``secondary_sc_api_port`` = ``3033``
|
||||
- (Port number) Secondary Dell API port
|
||||
|
|
@ -1,48 +0,0 @@
|
|||
..
|
||||
Warning: Do not edit this file. It is automatically generated from the
|
||||
software project's code and your changes will be overwritten.
|
||||
|
||||
The tool to generate this file lives in openstack-doc-tools repository.
|
||||
|
||||
Please make any changes needed in the code, then run the
|
||||
autogenerate-config-doc tool from the openstack-doc-tools repository, or
|
||||
ask for help on the documentation mailing list, IRC channel or meeting.
|
||||
|
||||
.. _cinder-emc:
|
||||
|
||||
.. list-table:: Description of EMC configuration options
|
||||
:header-rows: 1
|
||||
:class: config-ref-table
|
||||
|
||||
* - Configuration option = Default value
|
||||
- Description
|
||||
* - **[DEFAULT]**
|
||||
-
|
||||
* - ``check_max_pool_luns_threshold`` = ``False``
|
||||
- (Boolean) Report free_capacity_gb as 0 when the limit to maximum number of pool LUNs is reached. By default, the value is False.
|
||||
* - ``cinder_emc_config_file`` = ``/etc/cinder/cinder_emc_config.xml``
|
||||
- (String) Use this file for cinder emc plugin config data
|
||||
* - ``destroy_empty_storage_group`` = ``False``
|
||||
- (Boolean) To destroy storage group when the last LUN is removed from it. By default, the value is False.
|
||||
* - ``force_delete_lun_in_storagegroup`` = ``False``
|
||||
- (Boolean) Delete a LUN even if it is in Storage Groups. By default, the value is False.
|
||||
* - ``initiator_auto_deregistration`` = ``False``
|
||||
- (Boolean) Automatically deregister initiators after the related storage group is destroyed. By default, the value is False.
|
||||
* - ``initiator_auto_registration`` = ``False``
|
||||
- (Boolean) Automatically register initiators. By default, the value is False.
|
||||
* - ``io_port_list`` = ``None``
|
||||
- (List) Comma separated iSCSI or FC ports to be used in Nova or Cinder.
|
||||
* - ``iscsi_initiators`` = ``None``
|
||||
- (String) Mapping between hostname and its iSCSI initiator IP addresses.
|
||||
* - ``max_luns_per_storage_group`` = ``255``
|
||||
- (Integer) Default max number of LUNs in a storage group. By default, the value is 255.
|
||||
* - ``multi_pool_support`` = ``False``
|
||||
- (String) Use this value to specify multi-pool support for VMAX3
|
||||
* - ``naviseccli_path`` = ``None``
|
||||
- (String) Naviseccli Path.
|
||||
* - ``storage_vnx_authentication_type`` = ``global``
|
||||
- (String) VNX authentication scope type. By default, the value is global.
|
||||
* - ``storage_vnx_pool_names`` = ``None``
|
||||
- (List) Comma-separated list of storage pool names to be used.
|
||||
* - ``storage_vnx_security_file_dir`` = ``None``
|
||||
- (String) Directory path that contains the VNX security file. Make sure the security file is generated first.
|
||||
|
|
@ -1,85 +0,0 @@
|
|||
..
|
||||
Warning: Do not edit this file. It is automatically generated from the
|
||||
software project's code and your changes will be overwritten.
|
||||
|
||||
The tool to generate this file lives in openstack-doc-tools repository.
|
||||
|
||||
Please make any changes needed in the code, then run the
|
||||
autogenerate-config-doc tool from the openstack-doc-tools repository, or
|
||||
ask for help on the documentation mailing list, IRC channel or meeting.
|
||||
|
||||
.. _cinder-emc_sio:
|
||||
|
||||
.. list-table:: Description of EMC SIO volume driver configuration options
|
||||
:header-rows: 1
|
||||
:class: config-ref-table
|
||||
|
||||
* - Configuration option = Default value
|
||||
- Description
|
||||
|
||||
* - ``sio_allow_non_padded_thick_volumes`` = ``False``
|
||||
|
||||
- (Boolean) Allow thick volumes to be created in Storage Pools
|
||||
when zero padding is disabled. This option should
|
||||
not be enabled if multiple tenants will utilize
|
||||
thick volumes from a shared Storage Pool.
|
||||
|
||||
* - ``sio_max_over_subscription_ratio`` = ``10.0``
|
||||
|
||||
- (Floating point) max_over_subscription_ratio setting for the ScaleIO driver. This replaces the general max_over_subscription_ratio which has no effect in this driver.Maximum value allowed for ScaleIO is 10.0.
|
||||
|
||||
* - ``sio_protection_domain_id`` = ``None``
|
||||
|
||||
- (String) Protection Domain ID.
|
||||
|
||||
- **Deprecated**
|
||||
|
||||
Replaced by sio_storage_pools option
|
||||
|
||||
* - ``sio_protection_domain_name`` = ``None``
|
||||
|
||||
- (String) Protection Domain name.
|
||||
|
||||
- **Deprecated**
|
||||
|
||||
Replaced by sio_storage_pools option
|
||||
|
||||
* - ``sio_rest_server_port`` = ``443``
|
||||
|
||||
- (String) REST server port.
|
||||
|
||||
* - ``sio_round_volume_capacity`` = ``True``
|
||||
|
||||
- (Boolean) Round up volume capacity.
|
||||
|
||||
* - ``sio_server_certificate_path`` = ``None``
|
||||
|
||||
- (String) Server certificate path.
|
||||
|
||||
* - ``sio_storage_pool_id`` = ``None``
|
||||
|
||||
- (String) Storage Pool ID.
|
||||
|
||||
- **Deprecated**
|
||||
|
||||
Replaced by sio_storage_pools option
|
||||
|
||||
* - ``sio_storage_pool_name`` = ``None``
|
||||
|
||||
- (String) Storage Pool name.
|
||||
|
||||
- **Deprecated**
|
||||
|
||||
Replaced by sio_storage_pools option
|
||||
|
||||
* - ``sio_storage_pools`` = ``None``
|
||||
|
||||
- (String) Storage Pools.
|
||||
|
||||
* - ``sio_unmap_volume_before_deletion`` = ``False``
|
||||
|
||||
- (Boolean) Unmap volume before deletion.
|
||||
|
||||
* - ``sio_verify_server_certificate`` = ``False``
|
||||
|
||||
- (Boolean) Verify server certificate.
|
||||
|
|
@ -1,28 +0,0 @@
|
|||
..
|
||||
Warning: Do not edit this file. It is automatically generated from the
|
||||
software project's code and your changes will be overwritten.
|
||||
|
||||
The tool to generate this file lives in openstack-doc-tools repository.
|
||||
|
||||
Please make any changes needed in the code, then run the
|
||||
autogenerate-config-doc tool from the openstack-doc-tools repository, or
|
||||
ask for help on the documentation mailing list, IRC channel or meeting.
|
||||
|
||||
.. _cinder-emc_xtremio:
|
||||
|
||||
.. list-table:: Description of EMC XtremIO volume driver configuration options
|
||||
:header-rows: 1
|
||||
:class: config-ref-table
|
||||
|
||||
* - Configuration option = Default value
|
||||
- Description
|
||||
* - **[DEFAULT]**
|
||||
-
|
||||
* - ``xtremio_array_busy_retry_count`` = ``5``
|
||||
- (Integer) Number of retries in case array is busy
|
||||
* - ``xtremio_array_busy_retry_interval`` = ``5``
|
||||
- (Integer) Interval between retries in case array is busy
|
||||
* - ``xtremio_cluster_name`` =
|
||||
- (String) XMS cluster id in multi-cluster environment
|
||||
* - ``xtremio_volumes_per_glance_cache`` = ``100``
|
||||
- (Integer) Number of volumes created from each cached glance image
|
||||
|
|
@ -1,26 +0,0 @@
|
|||
..
|
||||
Warning: Do not edit this file. It is automatically generated from the
|
||||
software project's code and your changes will be overwritten.
|
||||
|
||||
The tool to generate this file lives in openstack-doc-tools repository.
|
||||
|
||||
Please make any changes needed in the code, then run the
|
||||
autogenerate-config-doc tool from the openstack-doc-tools repository, or
|
||||
ask for help on the documentation mailing list, IRC channel or meeting.
|
||||
|
||||
.. _cinder-eqlx:
|
||||
|
||||
.. list-table:: Description of Dell EqualLogic volume driver configuration options
|
||||
:header-rows: 1
|
||||
:class: config-ref-table
|
||||
|
||||
* - Configuration option = Default value
|
||||
- Description
|
||||
* - **[DEFAULT]**
|
||||
-
|
||||
* - ``eqlx_cli_max_retries`` = ``5``
|
||||
- (Integer) Maximum retry count for reconnection. Default is 5.
|
||||
* - ``eqlx_group_name`` = ``group-0``
|
||||
- (String) Group name to use for creating volumes. Defaults to "group-0".
|
||||
* - ``eqlx_pool`` = ``default``
|
||||
- (String) Pool in which volumes will be created. Defaults to "default".
|
||||
Loading…
Reference in New Issue