cinder/doc/source/configuration/tables/cinder-solidfire.inc
Jay S. Bryant 986a6a015f [DOC BLD FIX] Name files for inclusion properly
The Sphinx build was issuing hundreds of warning for
duplicate labels.  The reason for this was because
all of the tables we had were named as .rst files.
This would cause Sphinx to process them twice and it would
think there were duplicated sections.

There were two ways this could be handled:  1) Exclude the tables
directory from the docs build. 2) Name the files as they should
have always been so they weren't build twice.  Given that
option 1 just masked the problem, I am implementing this
patch using option 2.

So, all the tables we are including in our documentation
have been named from .rst to .inc and the .. include::
directives that use them have also been updated to use
the new file name.

Change-Id: If395eb652f7e3b789bcbd5e6d6d05954c23d8d8a
2017-08-04 15:33:52 -05:00

41 lines
2.4 KiB
HTML

..
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-'.