ironic/doc/source/admin/index.rst
Madhuri Kumari adcbd324af [doc-migration] Add configuration folder for documentation
This patch does the following:
* Adds a configuration folder to contain automated generated config
files for Ironic.
* Adds `oslo_config.sphinxconfiggen` to the extensions list.
* Adds `oslo_policy.sphinxpolicygen` to the extensions list.
* Adds ironic-policy-generator.conf

This is important for Ironic to be included in the list of services
on https://docs.openstack.org/pike/configuration/

Change-Id: I51a7204ce00be2588e427c1951e8be7dc7a22647
Closes-bug: #1706176
2017-08-02 13:14:23 +00:00

55 lines
1.6 KiB
ReStructuredText

Administrator's Guide
=====================
Installation & Operations
-------------------------
If you are a system administrator running Ironic, this section contains
information that should help you understand how to deploy, operate, and upgrade
the services.
.. toctree::
:maxdepth: 1
Installation Guide </install/index>
gmr
Upgrade Guide <upgrade-guide>
Release Notes <http://docs.openstack.org/releasenotes/ironic/>
Troubleshooting FAQ <troubleshooting>
Configuration
-------------
There are many aspects of the Bare Metal service which are environment
specific. The following pages will be helpful in configuring specific aspects
of ironic that may or may not be suitable to every situation.
.. toctree::
:maxdepth: 1
Guide to Node Cleaning <cleaning>
Configuring Node Inspection <inspection>
Configuring RAID during deployment <raid>
Security considerations for your Bare Metal installation <security>
Adopting Nodes in an ACTIVE state <adoption>
Configuring for Multi-tenant Networking <multitenancy>
Configuring for port groups <portgroups>
Configuring node web or serial console <console>
Emitting software metrics <metrics>
Auditing API Traffic <api-audit-support>
Notifications <notifications>
Ceph Object Gateway support <radosgw>
/configuration/sample-config
/configuration/sample-policy
Dashboard Integration
---------------------
A plugin for the OpenStack Dashboard (horizon) service is under development.
Documentation for that can be found within the ironic-ui project.
.. toctree::
:maxdepth: 1
Dashboard (horizon) plugin <http://docs.openstack.org/developer/ironic-ui/>