cinder/doc/source/configuration/tables/cinder-scheduler.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.2 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-scheduler:
.. list-table:: Description of scheduler configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[DEFAULT]**
-
* - ``filter_function`` = ``None``
- (String) String representation for an equation that will be used to filter hosts. Only used when the driver filter is set to be used by the Cinder scheduler.
* - ``goodness_function`` = ``None``
- (String) String representation for an equation that will be used to determine the goodness of a host. Only used when using the goodness weigher is set to be used by the Cinder scheduler.
* - ``scheduler_default_filters`` = ``AvailabilityZoneFilter, CapacityFilter, CapabilitiesFilter``
- (List) Which filter class names to use for filtering hosts when not specified in the request.
* - ``scheduler_default_weighers`` = ``CapacityWeigher``
- (List) Which weigher class names to use for weighing hosts.
* - ``scheduler_driver`` = ``cinder.scheduler.filter_scheduler.FilterScheduler``
- (String) Default scheduler driver to use
* - ``scheduler_host_manager`` = ``cinder.scheduler.host_manager.HostManager``
- (String) The scheduler host manager class to use
* - ``scheduler_json_config_location`` =
- (String) Absolute path to scheduler configuration JSON file.
* - ``scheduler_manager`` = ``cinder.scheduler.manager.SchedulerManager``
- (String) Full class name for the Manager for scheduler
* - ``scheduler_max_attempts`` = ``3``
- (Integer) Maximum number of attempts to schedule a volume
* - ``scheduler_weight_handler`` = ``cinder.scheduler.weights.OrderedHostWeightHandler``
- (String) Which handler to use for selecting the host/pool after weighing