cinder/doc/source/configuration/tables/cinder-vmware.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

55 lines
3.3 KiB
PHP

..
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-vmware:
.. list-table:: Description of VMware configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[DEFAULT]**
-
* - ``vmware_adapter_type`` = ``lsiLogic``
- (String) Default adapter type to be used for attaching volumes.
* - ``vmware_api_retry_count`` = ``10``
- (Integer) Number of times VMware vCenter server API must be retried upon connection related issues.
* - ``vmware_ca_file`` = ``None``
- (String) CA bundle file to use in verifying the vCenter server certificate.
* - ``vmware_cluster_name`` = ``None``
- (Multi-valued) Name of a vCenter compute cluster where volumes should be created.
* - ``vmware_connection_pool_size`` = ``10``
- (Integer) Maximum number of connections in http connection pool.
* - ``vmware_host_ip`` = ``None``
- (String) IP address for connecting to VMware vCenter server.
* - ``vmware_host_password`` = ``None``
- (String) Password for authenticating with VMware vCenter server.
* - ``vmware_host_port`` = ``443``
- (Port number) Port number for connecting to VMware vCenter server.
* - ``vmware_host_username`` = ``None``
- (String) Username for authenticating with VMware vCenter server.
* - ``vmware_host_version`` = ``None``
- (String) Optional string specifying the VMware vCenter server version. The driver attempts to retrieve the version from VMware vCenter server. Set this configuration only if you want to override the vCenter server version.
* - ``vmware_image_transfer_timeout_secs`` = ``7200``
- (Integer) Timeout in seconds for VMDK volume transfer between Cinder and Glance.
* - ``vmware_insecure`` = ``False``
- (Boolean) If true, the vCenter server certificate is not verified. If false, then the default CA truststore is used for verification. This option is ignored if "vmware_ca_file" is set.
* - ``vmware_max_objects_retrieval`` = ``100``
- (Integer) Max number of objects to be retrieved per batch. Query results will be obtained in batches from the server and not in one shot. Server may still limit the count to something less than the configured value.
* - ``vmware_task_poll_interval`` = ``2.0``
- (Floating point) The interval (in seconds) for polling remote tasks invoked on VMware vCenter server.
* - ``vmware_tmp_dir`` = ``/tmp``
- (String) Directory where virtual disks are stored during volume backup and restore.
* - ``vmware_volume_folder`` = ``Volumes``
- (String) Name of the vCenter inventory folder that will contain Cinder volumes. This folder will be created under "OpenStack/<project_folder>", where project_folder is of format "Project (<volume_project_id>)".
* - ``vmware_wsdl_location`` = ``None``
- (String) Optional VIM service WSDL Location e.g http://<server>/vimService.wsdl. Optional over-ride to default location for bug work-arounds.