openstack/cinder
Code Issues Proposed changes

Update HPE docs to use config-table directive

Browse Source 
Remove use of static config tables in favor of dynamically
generated ones using the config-table directive.

Change-Id: I886a1a3c44262b6ba49ffa9295067cb2db148c4b
This commit is contained in:
Sean McGinnis 2018-04-25 02:18:46 +00:00
parent be7880d9e1
commit 25ec787557
7 changed files with 11 additions and 169 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/configuration/block-storage/config-options.rst
View File

@ -14,8 +14,6 @@ These options can also be set in the ``cinder.conf`` file.
.. include:: ../tables/cinder-drbd.inc .. include:: ../tables/cinder-drbd.inc
.. include:: ../tables/cinder-flashsystem.inc .. include:: ../tables/cinder-flashsystem.inc
.. include:: ../tables/cinder-hgst.inc .. include:: ../tables/cinder-hgst.inc
.. include:: ../tables/cinder-hpelefthand.inc
.. include:: ../tables/cinder-hpexp.inc
.. include:: ../tables/cinder-huawei.inc .. include:: ../tables/cinder-huawei.inc
.. include:: ../tables/cinder-hyperv.inc .. include:: ../tables/cinder-hyperv.inc
.. include:: ../tables/cinder-images.inc .. include:: ../tables/cinder-images.inc

11
doc/source/configuration/block-storage/drivers/hp-msa-driver.rst
View File

@ -1,6 +1,6 @@
====================================== =======================================
HP MSA Fibre Channel and iSCSI drivers HPE MSA Fibre Channel and iSCSI drivers
====================================== =======================================
The ``HPMSAFCDriver`` and ``HPMSAISCSIDriver`` Cinder drivers allow HP MSA The ``HPMSAFCDriver`` and ``HPMSAISCSIDriver`` Cinder drivers allow HP MSA
2040 or 1040 arrays to be used for Block Storage in OpenStack deployments. 2040 or 1040 arrays to be used for Block Storage in OpenStack deployments.
@ -162,4 +162,7 @@ Driver-specific options
The following table contains the configuration options that are specific to The following table contains the configuration options that are specific to
the HP MSA drivers. the HP MSA drivers.
.. include:: ../../tables/cinder-hpmsa.inc .. config-table::
:config-target: HPE MSA
cinder.volume.drivers.san.hp.hpmsa_common

5
doc/source/configuration/block-storage/drivers/hpe-3par-driver.rst
View File

@ -414,4 +414,7 @@ service log files for errors.
The following table contains all the configuration options supported by The following table contains all the configuration options supported by
the HPE 3PAR Fibre Channel and iSCSI drivers. the HPE 3PAR Fibre Channel and iSCSI drivers.
.. include:: ../../tables/cinder-hpe3par.inc .. config-table::
:config-target: 3PAR
cinder.volume.drivers.hpe.hpe_3par_common

40
doc/source/configuration/tables/cinder-hpe3par.inc
View File

@ -1,40 +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-hpe3par:
.. list-table:: Description of HPE 3PAR Fibre Channel and iSCSI drivers configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[DEFAULT]**
-
* - ``hpe3par_api_url`` =
- (String) 3PAR WSAPI Server Url like https://<3par ip>:8080/api/v1
* - ``hpe3par_cpg`` = ``OpenStack``
- (List) List of the CPG(s) to use for volume creation
* - ``hpe3par_cpg_snap`` =
- (String) The CPG to use for Snapshots for volumes. If empty the userCPG will be used.
* - ``hpe3par_debug`` = ``False``
- (Boolean) Enable HTTP debugging to 3PAR
* - ``hpe3par_iscsi_chap_enabled`` = ``False``
- (Boolean) Enable CHAP authentication for iSCSI connections.
* - ``hpe3par_iscsi_ips`` =
- (List) List of target iSCSI addresses to use.
* - ``hpe3par_password`` =
- (String) 3PAR password for the user specified in hpe3par_username
* - ``hpe3par_snapshot_expiration`` =
- (String) The time in hours when a snapshot expires and is deleted. This must be larger than expiration
* - ``hpe3par_snapshot_retention`` =
- (String) The time in hours to retain a snapshot. You can't delete it before this expires.
* - ``hpe3par_username`` =
- (String) 3PAR username with the 'edit' role

34
doc/source/configuration/tables/cinder-hpelefthand.inc
View File

@ -1,34 +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-hpelefthand:
.. list-table:: Description of HPE LeftHand/StoreVirtual driver configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[DEFAULT]**
-
* - ``hpelefthand_api_url`` = ``None``
- (URI) HPE LeftHand WSAPI Server Url like https://<LeftHand ip>:8081/lhos
* - ``hpelefthand_clustername`` = ``None``
- (String) HPE LeftHand cluster name
* - ``hpelefthand_debug`` = ``False``
- (Boolean) Enable HTTP debugging to LeftHand
* - ``hpelefthand_iscsi_chap_enabled`` = ``False``
- (Boolean) Configure CHAP authentication for iSCSI connections (Default: Disabled)
* - ``hpelefthand_password`` = ``None``
- (String) HPE LeftHand Super user password
* - ``hpelefthand_ssh_port`` = ``16022``
- (Port number) Port number of SSH service.
* - ``hpelefthand_username`` = ``None``
- (String) HPE LeftHand Super user username

56
doc/source/configuration/tables/cinder-hpexp.inc
View File

@ -1,56 +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-hpexp:
.. list-table:: Description of HPE XP volume driver configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[DEFAULT]**
-
* - ``hpexp_async_copy_check_interval`` = ``10``
- (Integer) Interval to check copy asynchronously
* - ``hpexp_compute_target_ports`` = ``None``
- (List) Target port names of compute node for host group or iSCSI target
* - ``hpexp_copy_check_interval`` = ``3``
- (Integer) Interval to check copy
* - ``hpexp_copy_speed`` = ``3``
- (Integer) Copy speed of storage system
* - ``hpexp_default_copy_method`` = ``FULL``
- (String) Default copy method of storage system. There are two valid values: "FULL" specifies that a full copy; "THIN" specifies that a thin copy. Default value is "FULL"
* - ``hpexp_group_request`` = ``False``
- (Boolean) Request for creating host group or iSCSI target
* - ``hpexp_horcm_add_conf`` = ``True``
- (Boolean) Add to HORCM configuration
* - ``hpexp_horcm_name_only_discovery`` = ``False``
- (Boolean) Only discover a specific name of host group or iSCSI target
* - ``hpexp_horcm_numbers`` = ``200, 201``
- (List) Instance numbers for HORCM
* - ``hpexp_horcm_resource_name`` = ``meta_resource``
- (String) Resource group name of storage system for HORCM
* - ``hpexp_horcm_user`` = ``None``
- (String) Username of storage system for HORCM
* - ``hpexp_ldev_range`` = ``None``
- (String) Logical device range of storage system
* - ``hpexp_pool`` = ``None``
- (String) Pool of storage system
* - ``hpexp_storage_cli`` = ``None``
- (String) Type of storage command line interface
* - ``hpexp_storage_id`` = ``None``
- (String) ID of storage system
* - ``hpexp_target_ports`` = ``None``
- (List) Target port names for host group or iSCSI target
* - ``hpexp_thin_pool`` = ``None``
- (String) Thin pool of storage system
* - ``hpexp_zoning_request`` = ``False``
- (Boolean) Request for FC Zone creating host group

32
doc/source/configuration/tables/cinder-hpmsa.inc
View File

@ -1,32 +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-hpmsa:
.. list-table:: Description of HP MSA volume driver configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[DEFAULT]**
-
* - ``hpmsa_api_protocol`` = ``https``
- (String) HPMSA API interface protocol.
* - ``hpmsa_backend_name`` = ``A``
- (String) Pool or Vdisk name to use for volume creation.
* - ``hpmsa_backend_type`` = ``virtual``
- (String) linear (for Vdisk) or virtual (for Pool).
* - ``hpmsa_iscsi_ips`` =
- (List) List of comma-separated target iSCSI IP addresses.
* - ``hpmsa_verify_certificate`` = ``False``
- (Boolean) Whether to verify HPMSA array SSL certificate.
* - ``hpmsa_verify_certificate_path`` = ``None``
- (String) HPMSA array SSL certificate path.