openstack/cinder
Code Issues Proposed changes

Remove ZFSSA static config option tables

Browse Source 
Switch to using config-table directive.

Change-Id: I5fb17c6cf730a6c5c0149b60ec66af73fc24bab8
This commit is contained in:
Sean McGinnis 2018-05-02 06:33:04 -05:00
parent ac2a518b5e
commit e3873225d7
4 changed files with 8 additions and 104 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/source/configuration/block-storage/drivers/zfssa-iscsi-driver.rst
View File

@ -262,4 +262,7 @@ Driver options
The Oracle ZFSSA iSCSI Driver supports these options:
.. include:: ../../tables/cinder-zfssa-iscsi.inc
.. config-table::
:config-target: ZFS Storage Appliance iSCSI
cinder.volume.drivers.zfssa.zfssaiscsi

5
doc/source/configuration/block-storage/drivers/zfssa-nfs-driver.rst
View File

@ -291,7 +291,10 @@ Driver options
The Oracle ZFS Storage Appliance NFS driver supports these options:
.. include:: ../../tables/cinder-zfssa-nfs.inc
.. config-table::
:config-target: ZFS Storage Appliance NFS
cinder.volume.drivers.zfssa.zfssanfs
This driver shares additional NFS configuration options with the generic
NFS driver. For a description of these, see :ref:`cinder-storage_nfs`.

56
doc/source/configuration/tables/cinder-zfssa-iscsi.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-zfssa-iscsi:
.. list-table:: Description of ZFS Storage Appliance iSCSI driver configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[DEFAULT]**
-
* - ``zfssa_initiator`` =
- (String) iSCSI initiator IQNs. (comma separated)
* - ``zfssa_initiator_config`` =
- (String) iSCSI initiators configuration.
* - ``zfssa_initiator_group`` =
- (String) iSCSI initiator group.
* - ``zfssa_initiator_password`` =
- (String) Secret of the iSCSI initiator CHAP user.
* - ``zfssa_initiator_user`` =
- (String) iSCSI initiator CHAP user (name).
* - ``zfssa_lun_compression`` = ``off``
- (String) Data compression.
* - ``zfssa_lun_logbias`` = ``latency``
- (String) Synchronous write bias.
* - ``zfssa_lun_sparse`` = ``False``
- (Boolean) Flag to enable sparse (thin-provisioned): True, False.
* - ``zfssa_lun_volblocksize`` = ``8k``
- (String) Block size.
* - ``zfssa_pool`` = ``None``
- (String) Storage pool name.
* - ``zfssa_project`` = ``None``
- (String) Project name.
* - ``zfssa_replication_ip`` =
- (String) IP address used for replication data. (maybe the same as data ip)
* - ``zfssa_rest_timeout`` = ``None``
- (Integer) REST connection timeout. (seconds)
* - ``zfssa_target_group`` = ``tgt-grp``
- (String) iSCSI target group name.
* - ``zfssa_target_interfaces`` = ``None``
- (String) Network interfaces of iSCSI targets. (comma separated)
* - ``zfssa_target_password`` =
- (String) Secret of the iSCSI target CHAP user.
* - ``zfssa_target_portal`` = ``None``
- (String) iSCSI target portal (Data-IP:Port, w.x.y.z:3260).
* - ``zfssa_target_user`` =
- (String) iSCSI target CHAP user (name).

46
doc/source/configuration/tables/cinder-zfssa-nfs.inc
View File

@ -1,46 +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-zfssa-nfs:
.. list-table:: Description of ZFS Storage Appliance NFS driver configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[DEFAULT]**
-
* - ``zfssa_cache_directory`` = ``os-cinder-cache``
- (String) Name of directory inside zfssa_nfs_share where cache volumes are stored.
* - ``zfssa_cache_project`` = ``os-cinder-cache``
- (String) Name of ZFSSA project where cache volumes are stored.
* - ``zfssa_data_ip`` = ``None``
- (String) Data path IP address
* - ``zfssa_enable_local_cache`` = ``True``
- (Boolean) Flag to enable local caching: True, False.
* - ``zfssa_https_port`` = ``443``
- (String) HTTPS port number
* - ``zfssa_manage_policy`` = ``loose``
- (String) Driver policy for volume manage.
* - ``zfssa_nfs_mount_options`` =
- (String) Options to be passed while mounting share over nfs
* - ``zfssa_nfs_pool`` =
- (String) Storage pool name.
* - ``zfssa_nfs_project`` = ``NFSProject``
- (String) Project name.
* - ``zfssa_nfs_share`` = ``nfs_share``
- (String) Share name.
* - ``zfssa_nfs_share_compression`` = ``off``
- (String) Data compression.
* - ``zfssa_nfs_share_logbias`` = ``latency``
- (String) Synchronous write bias-latency, throughput.
* - ``zfssa_rest_timeout`` = ``None``
- (Integer) REST connection timeout. (seconds)