diff --git a/doc/config-reference/source/bare-metal.rst b/doc/config-reference/source/bare-metal.rst index fa44379f6e..0bf663399c 100644 --- a/doc/config-reference/source/bare-metal.rst +++ b/doc/config-reference/source/bare-metal.rst @@ -2,6 +2,13 @@ Bare Metal service ================== +.. toctree:: + :maxdepth: 1 + + bare-metal/api.rst + bare-metal/config-options.rst + tables/conf-changes/ironic.rst + The Bare Metal service is capable of managing and provisioning physical machines. The configuration file of this module is ``/etc/ironic/ironic.conf``. @@ -11,41 +18,3 @@ machines. The configuration file of this module is The common configurations for shared service and libraries, such as database connections and RPC messaging, are described at :doc:`common-configurations`. - -The following tables provide a comprehensive list of the Bare Metal -service configuration options. - -.. include:: tables/ironic-agent.rst -.. include:: tables/ironic-amqp.rst -.. include:: tables/ironic-amt.rst -.. include:: tables/ironic-api.rst -.. include:: tables/ironic-auth_token.rst -.. include:: tables/ironic-auth.rst -.. include:: tables/ironic-cisco_ucs.rst -.. include:: tables/ironic-common.rst -.. include:: tables/ironic-conductor.rst -.. include:: tables/ironic-console.rst -.. include:: tables/ironic-debug.rst -.. include:: tables/ironic-deploy.rst -.. include:: tables/ironic-dhcp.rst -.. include:: tables/ironic-disk_partitioner.rst -.. include:: tables/ironic-glance.rst -.. include:: tables/ironic-iboot.rst -.. include:: tables/ironic-ilo.rst -.. include:: tables/ironic-inspector.rst -.. include:: tables/ironic-ipmi.rst -.. include:: tables/ironic-irmc.rst -.. include:: tables/ironic-keystone.rst -.. include:: tables/ironic-logging.rst -.. include:: tables/ironic-neutron.rst -.. include:: tables/ironic-pxe.rst -.. include:: tables/ironic-redis.rst -.. include:: tables/ironic-rpc.rst -.. include:: tables/ironic-rabbitmq.rst -.. include:: tables/ironic-seamicro.rst -.. include:: tables/ironic-snmp.rst -.. include:: tables/ironic-ssh.rst -.. include:: tables/ironic-swift.rst -.. include:: tables/ironic-virtualbox.rst -.. include:: tables/ironic-zeromq.rst -.. include:: tables/conf-changes/ironic.rst diff --git a/doc/config-reference/source/bare-metal/api.rst b/doc/config-reference/source/bare-metal/api.rst new file mode 100644 index 0000000000..4447fc03ea --- /dev/null +++ b/doc/config-reference/source/bare-metal/api.rst @@ -0,0 +1,11 @@ +============================ +Bare Metal API configuration +============================ + +Configuration options +~~~~~~~~~~~~~~~~~~~~~ + +The following options allow configuration of the APIs that +Bare Metal service supports. + +.. include:: ../tables/ironic-api.rst diff --git a/doc/config-reference/source/bare-metal/config-options.rst b/doc/config-reference/source/bare-metal/config-options.rst new file mode 100644 index 0000000000..21b3b83ca4 --- /dev/null +++ b/doc/config-reference/source/bare-metal/config-options.rst @@ -0,0 +1,39 @@ +======================================================= +Additional configuration options for Bare Metal service +======================================================= + +The following tables provide a comprehensive list of the Bare Metal +service configuration options. + +.. include:: ../tables/ironic-agent.rst +.. include:: ../tables/ironic-amqp.rst +.. include:: ../tables/ironic-amt.rst +.. include:: ../tables/ironic-auth_token.rst +.. include:: ../tables/ironic-auth.rst +.. include:: ../tables/ironic-cisco_ucs.rst +.. include:: ../tables/ironic-common.rst +.. include:: ../tables/ironic-conductor.rst +.. include:: ../tables/ironic-console.rst +.. include:: ../tables/ironic-debug.rst +.. include:: ../tables/ironic-deploy.rst +.. include:: ../tables/ironic-dhcp.rst +.. include:: ../tables/ironic-disk_partitioner.rst +.. include:: ../tables/ironic-glance.rst +.. include:: ../tables/ironic-iboot.rst +.. include:: ../tables/ironic-ilo.rst +.. include:: ../tables/ironic-inspector.rst +.. include:: ../tables/ironic-ipmi.rst +.. include:: ../tables/ironic-irmc.rst +.. include:: ../tables/ironic-keystone.rst +.. include:: ../tables/ironic-logging.rst +.. include:: ../tables/ironic-neutron.rst +.. include:: ../tables/ironic-pxe.rst +.. include:: ../tables/ironic-redis.rst +.. include:: ../tables/ironic-rpc.rst +.. include:: ../tables/ironic-rabbitmq.rst +.. include:: ../tables/ironic-seamicro.rst +.. include:: ../tables/ironic-snmp.rst +.. include:: ../tables/ironic-ssh.rst +.. include:: ../tables/ironic-swift.rst +.. include:: ../tables/ironic-virtualbox.rst +.. include:: ../tables/ironic-zeromq.rst diff --git a/doc/config-reference/source/conf.py b/doc/config-reference/source/conf.py index 3afacbaa9d..439884325c 100644 --- a/doc/config-reference/source/conf.py +++ b/doc/config-reference/source/conf.py @@ -96,8 +96,7 @@ html_context = {"gitsha": gitsha, "bug_tag": bug_tag, # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. exclude_patterns = ['common/cli*', 'common/nova*', 'common/get_started_*', - 'tables/*.rst', 'tables/manual/*.rst', - 'tables/conf-changes/ironic.rst'] + 'tables/*.rst', 'tables/manual/*.rst'] # The reST default role (used for this markup: `text`) to use for all # documents.