openstack/ironic
Code Issues Proposed changes

Merge "Configuration documentation migrated"

Browse Source
This commit is contained in:
Jenkins 2017-08-23 14:11:16 +00:00 committed by Gerrit Code Review
commit 57ac383316
10 changed files with 96 additions and 67 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
doc/source/admin/index.rst
View File

@ -1,48 +1,31 @@
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
information that may help you understand how to operate and upgrade
the services.
.. toctree::
:maxdepth: 1
Installation Guide </install/index>
gmr
Upgrade Guide <upgrade-guide>
upgrade-to-hardware-types
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>
Enabling Drivers <drivers>
Ironic Python Agent <drivers/ipa>
Node Hardware Inspection <inspection>
Node Cleaning <cleaning>
Node Adoption <adoption>
RAID Configuration <raid>
Configuring to boot from volume <boot-from-volume>
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>
Multi-tenant Networking <multitenancy>
Port Groups <portgroups>
Configuring Web or Serial Console <console>
Enabling Notifications <notifications>
Ceph Object Gateway <radosgw>
Emitting Software Metrics <metrics>
Auditing API Traffic <api-audit-support>
Notifications <notifications>
Ceph Object Gateway support <radosgw>
/configuration/sample-config
/configuration/sample-policy
Service State Reporting <gmr>
Upgrade Guide <upgrade-guide>
Security <security>
Troubleshooting FAQ <troubleshooting>
Dashboard Integration
---------------------

5
doc/source/admin/upgrade-guide.rst
View File

@ -320,6 +320,11 @@ Upgrading from Ocata to Pike
Other upgrade instructions are in the `Pike release notes
<https://docs.openstack.org/releasenotes/ironic/pike.html>`_.
.. toctree::
:maxdepth: 1
upgrade-to-hardware-types.rst
Upgrading from Newton to Ocata
==============================

2
doc/source/conf.py
View File

@ -21,7 +21,9 @@ extensions = ['sphinx.ext.autodoc',
'sphinxcontrib.pecanwsme.rest',
'sphinxcontrib.seqdiag',
'wsmeext.sphinxext',
'oslo_config.sphinxext',
'oslo_config.sphinxconfiggen',
'oslo_policy.sphinxext',
'oslo_policy.sphinxpolicygen',
]

10
doc/source/configuration/config.rst Normal file
View File

@ -0,0 +1,10 @@
=====================
Configuration Options
=====================
The following is an overview of all available configuration options in
Ironic. For a sample configuration file, refer to
:doc:`sample-config`.
.. show-options::
:config-file: tools/config/ironic-config-generator.conf

16
doc/source/configuration/index.rst
View File

@ -1,10 +1,16 @@
Configuration Guide
-------------------
=======================
Configuration Reference
=======================
Here are sample configuration files generated automatically for Ironic.
Many aspects of the Bare Metal service are specific to the environment
it is deployed in. The following pages describe configuration
options that can be used to adjust the service to your particular
situation.
.. toctree::
:maxdepth: 1
sample-config
sample-policy
Configuration Options <config>
Sample Config File <sample-config>
Policies <policy>
Sample Policy File <sample-policy>

9
doc/source/configuration/policy.rst Normal file
View File

@ -0,0 +1,9 @@
========
Policies
========
The following is an overview of all available policies in Ironic. For
a sample configuration file, refer to :doc:`sample-policy`.
.. show-policy::
:config-file: tools/policy/ironic-policy-generator.conf

21
doc/source/configuration/sample-config.rst
View File

@ -1,13 +1,18 @@
============================
Ironic Configuration Options
============================
=========================
Sample Configuration File
=========================
The following is a sample Ironic configuration for adaptation and use. It is
auto-generated from Ironic when this documentation is built, so
if you find issues with an option, please compare your version of
Ironic with the version of this documentation.
The following is a sample Ironic configuration for adaptation and use. For a
detailed overview of all available configuration options, refer to
:doc:`config`.
The sample configuration can also be downloaded as a :download:`file
The sample configuration can also be viewed in :download:`file form
</_static/ironic.conf.sample>`.
.. important::
The sample configuration file is auto-generated from Ironic when this
documentation is built. You must ensure your version of Ironic matches the
version of this documentation.
.. literalinclude:: /_static/ironic.conf.sample

37
doc/source/index.rst
View File

@ -22,6 +22,22 @@ previous release of ironic, append the OpenStack release name to the URL; for
example, the ``ocata`` release is available at
https://docs.openstack.org/ironic/ocata/.
Installation Guide
==================
.. toctree::
:maxdepth: 2
install/index
Upgrade Guide
=============
.. toctree::
:maxdepth: 2
admin/upgrade-guide
User Guide
==========
@ -38,26 +54,14 @@ Administrator Guide
admin/index
Configuration Reference
=======================
Configuration Guide
===================
.. toctree::
:maxdepth: 2
configuration/index
Driver References
=================
Every driver author is expected to document the use and configuration of their
driver. These pages are linked below.
.. toctree::
:maxdepth: 1
Driver Documentation pages <admin/drivers>
Further Considerations for the Agent Drivers <admin/drivers/ipa>
Bare Metal API References
=========================
@ -90,6 +94,11 @@ Contributor Guide
contributor/index
Release Notes
=============
`Release Notes <http://docs.openstack.org/releasenotes/ironic/>`_
Indices and tables
==================

2
doc/source/install/index.rst
View File

@ -1,5 +1,5 @@
=====================================
Bare Metal service installation guide
Bare Metal Service Installation Guide
=====================================
The Bare Metal service is a collection of components that provides support to

6
doc/source/user/index.rst
View File

@ -1,8 +1,8 @@
.. _user-guide:
======================
Introduction to Ironic
======================
=============================
Bare Metal Service User Guide
=============================
Ironic is an OpenStack project which provisions bare metal (as opposed to
virtual) machines. It may be used independently or as part of an OpenStack