openstack/cinder
Code Issues Proposed changes

Remove SolidFire static config option table

Browse Source 
Switch to using config-table directive.

Change-Id: I8142d5026a9760efdbbac763628fec3c99571e55
This commit is contained in:
Sean McGinnis 2018-05-02 06:17:48 -05:00
parent ac2a518b5e
commit f6f256f3e8
2 changed files with 4 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/source/configuration/block-storage/drivers/solidfire-volume-driver.rst
View File

@ -48,7 +48,10 @@ To configure the use of a SolidFire cluster with Block Storage, modify your
deployment it is recommended to add the Cluster as if it were a second deployment it is recommended to add the Cluster as if it were a second
backend and disable new deployments to the current back end. backend and disable new deployments to the current back end.
.. include:: ../../tables/cinder-solidfire.inc .. config-table::
:config-target: SolidFire
cinder.volume.drivers.solidfire
Supported operations Supported operations
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~

40
doc/source/configuration/tables/cinder-solidfire.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-solidfire:
.. list-table:: Description of SolidFire driver configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[DEFAULT]**
-
* - ``sf_account_prefix`` = ``None``
- (String) Create SolidFire accounts with this prefix. Any string can be used here, but the string "hostname" is special and will create a prefix using the cinder node hostname (previous default behavior). The default is NO prefix.
* - ``sf_allow_template_caching`` = ``True``
- (Boolean) Create an internal cache of copy of images when a bootable volume is created to eliminate fetch from glance and qemu-conversion on subsequent calls.
* - ``sf_allow_tenant_qos`` = ``False``
- (Boolean) Allow tenants to specify QOS on create
* - ``sf_api_port`` = ``443``
- (Port number) SolidFire API port. Useful if the device api is behind a proxy on a different port.
* - ``sf_emulate_512`` = ``True``
- (Boolean) Set 512 byte emulation on volume creation;
* - ``sf_enable_vag`` = ``False``
- (Boolean) Utilize volume access groups on a per-tenant basis.
* - ``sf_enable_volume_mapping`` = ``True``
- (Boolean) Create an internal mapping of volume IDs and account. Optimizes lookups and performance at the expense of memory, very large deployments may want to consider setting to False.
* - ``sf_svip`` = ``None``
- (String) Overrides default cluster SVIP with the one specified. This is required or deployments that have implemented the use of VLANs for iSCSI networks in their cloud.
* - ``sf_template_account_name`` = ``openstack-vtemplate``
- (String) Account name on the SolidFire Cluster to use as owner of template/cache volumes (created if does not exist).
* - ``sf_volume_prefix`` = ``UUID-``
- (String) Create SolidFire volumes with this prefix. Volume names are of the form <sf_volume_prefix><cinder-volume-id>. The default is to use a prefix of 'UUID-'.