Update Sheepdog docs to use config-table directive

Remove static table in favor of dynamic table generation with
the config-table directive.

Change-Id: If3cd9ff077d4de3b50b5e32e7e5ee1d670886971
This commit is contained in:
Sean McGinnis 2018-04-25 01:15:25 +00:00
parent 803ffe7ba5
commit f3feee2f95
2 changed files with 4 additions and 25 deletions

View File

@ -45,4 +45,7 @@ Set the following option in the ``cinder.conf`` file:
The following table contains the configuration options supported by the
Sheepdog driver:
.. include:: ../../tables/cinder-sheepdog.inc
.. config-table::
:config-target: Sheepdog
cinder.volume.drivers.sheepdog

View File

@ -1,24 +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-sheepdog:
.. list-table:: Description of Sheepdog driver configuration options
:header-rows: 1
:class: config-ref-table
* - Configuration option = Default value
- Description
* - **[DEFAULT]**
-
* - ``sheepdog_store_address`` = ``127.0.0.1``
- (String) IP address of sheep daemon.
* - ``sheepdog_store_port`` = ``7000``
- (Port number) Port of sheep daemon.