Move operator docs into into doc/source/admin

Change-Id: I13f90a0b183b7799b4c8b5c340052d96f717fa9f
This commit is contained in:
Sam Betts 2017-07-03 16:33:46 +01:00
parent aeb5306093
commit 02015a4be6
41 changed files with 93 additions and 317 deletions

View File

@ -367,7 +367,7 @@ Set RAID Config
Store the supplied configuration on the Node's ``target_raid_config`` property.
This property must be structured JSON, and will be validated by the driver upon receipt. The request
schema is defined in the `documentation for the RAID feature <http://docs.openstack.org/developer/ironic/deploy/raid.html>`_
schema is defined in the `documentation for the RAID feature <http://docs.openstack.org/ironic/latest/admin/raid.html>`_
.. note:: Calling this API only stores the requested configuration; it will be applied the next time
that the Node transitions through the ``cleaning`` phase.

View File

@ -19,7 +19,7 @@ IPMITool driver
.. toctree::
:maxdepth: 1
../drivers/ipmitool
drivers/ipmitool
DRAC driver
-----------
@ -38,7 +38,7 @@ SNMP driver
.. toctree::
:maxdepth: 1
../drivers/snmp
drivers/snmp
iLO driver
----------
@ -46,7 +46,7 @@ iLO driver
.. toctree::
:maxdepth: 1
../drivers/ilo
drivers/ilo
iRMC driver
-----------
@ -54,7 +54,7 @@ iRMC driver
.. toctree::
:maxdepth: 1
../drivers/irmc
drivers/irmc
Cisco UCS driver
----------------
@ -62,7 +62,7 @@ Cisco UCS driver
.. toctree::
:maxdepth: 1
../drivers/ucs
drivers/ucs
CIMC driver
@ -71,7 +71,7 @@ CIMC driver
.. toctree::
:maxdepth: 1
../drivers/cimc
drivers/cimc
OneView driver
@ -80,7 +80,7 @@ OneView driver
.. toctree::
:maxdepth: 1
../drivers/oneview
drivers/oneview
XenServer ssh driver
@ -89,7 +89,7 @@ XenServer ssh driver
.. toctree::
:maxdepth: 1
../drivers/xenserver
drivers/xenserver
Redfish driver
@ -98,7 +98,7 @@ Redfish driver
.. toctree::
:maxdepth: 1
../drivers/redfish
drivers/redfish
Unsupported drivers

View File

@ -165,7 +165,7 @@ the intermediate floppy image and the boot ISO.
Enable driver
=============
1. Build a deploy ISO (and kernel and ramdisk) image, see :ref:`BuildingDeployRamdisk`
1. Build a deploy ISO (and kernel and ramdisk) image, see :ref:`deploy-ramdisk`
2. See `Glance Configuration`_ for configuring glance image service with its storage
backend as ``swift``.
@ -560,7 +560,7 @@ None.
Configuring and Enabling the driver
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1. Build a deploy image, see :ref:`BuildingDeployRamdisk`
1. Build a deploy image, see :ref:`deploy-ramdisk`
2. Upload this image to glance::
@ -758,7 +758,7 @@ flavor.
Use element ``ubuntu-signed`` or ``fedora`` to build signed deploy iso and
user images from
`diskimage-builder <https://pypi.python.org/pypi/diskimage-builder>`_.
Refer :ref:`BuildingDeployRamdisk` for more information on building
Refer :ref:`deploy-ramdisk` for more information on building
deploy ramdisk.
The below command creates files named cloud-image-boot.iso, cloud-image.initrd,

View File

@ -0,0 +1,55 @@
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 Reference <http://docs.openstack.org/draft/config-reference/bare-metal.html>
Sample configuration file <https://git.openstack.org/cgit/openstack/ironic/tree/etc/ironic/ironic.conf.sample>
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/>

View File

@ -1,231 +0,0 @@
.. _install-guide:
==================
Installation Guide
==================
.. warning:: This installation guide has moved to the `Bare Metal
service installation guide`_. This page will not be
updated.
.. _`Bare Metal service installation guide`: http://docs.openstack.org/project-install-guide/baremetal/draft/
Service overview
================
See the `service overview`_ section in the installation guide for the Bare
Metal service.
.. _`service overview`: http://docs.openstack.org/project-install-guide/baremetal/draft/get_started.html
Install and configure prerequisites
===================================
See the `prerequisites`_ section in the installation guide for the Bare Metal
service.
.. _`prerequisites`: http://docs.openstack.org/project-install-guide/baremetal/draft/install-ubuntu.html#prerequisites
Install the Bare Metal service
==============================
See the `Install and configure components`_ section in the installation guide
for the Bare Metal service.
.. _`Install and configure components`: http://docs.openstack.org/project-install-guide/baremetal/draft/install-ubuntu.html#install-and-configure-components
Configure the Bare Metal service
================================
See the `Install and configure components`_ section in the installation guide
for the Bare Metal service.
.. _`Install and configure components`: http://docs.openstack.org/project-install-guide/baremetal/draft/install-ubuntu.html#install-and-configure-components
Configure Compute to use the Bare Metal service
===============================================
See the `Configure Compute to use the Bare Metal service`_ section in the
installation guide for the Bare Metal service.
.. _`Configure Compute to use the Bare Metal service`: http://docs.openstack.org/project-install-guide/baremetal/draft/configure-integration.html#configure-compute-to-use-the-bare-metal-service
.. _NeutronFlatNetworking:
Configure Networking to communicate with the bare metal server
==============================================================
See the `Configure Networking to communicate with the bare metal server`_
section in the installation guide for the Bare Metal service.
.. _`Configure Networking to communicate with the bare metal server`: http://docs.openstack.org/project-install-guide/baremetal/draft/configure-integration.html#configure-networking-to-communicate-with-the-bare-metal-server
Configuring Tenant Networks
===========================
See :ref:`multitenancy`
.. _CleaningNetworkSetup:
Configure the Bare Metal service for cleaning
=============================================
See the `Configure the Bare Metal service for cleaning`_ section in the
installation guide for the Bare Metal service.
.. _`Configure the Bare Metal service for cleaning`: http://docs.openstack.org/project-install-guide/baremetal/draft/configure-cleaning.html
.. _ImageRequirement:
Image requirements
==================
See the `Image requirements`_ section in the installation guide for the Bare
Metal service.
.. _`Image requirements`: http://docs.openstack.org/project-install-guide/baremetal/draft/configure-integration.html#configure-the-image-service
Flavor creation
===============
See the `Flavor creation`_ section in the installation guide for the Bare Metal
service.
.. _`Flavor creation`: http://docs.openstack.org/project-install-guide/baremetal/draft/configure-integration.html#configure-compute-flavors-for-use-with-the-bare-metal-service
Setup the drivers for the Bare Metal service
============================================
See the `Setup the drivers for the Bare Metal service`_ section in the
installation guide for the Bare Metal service.
.. _`Setup the drivers for the Bare Metal service`: http://docs.openstack.org/project-install-guide/baremetal/draft/setup-drivers.html
Local boot with partition images
================================
See the `Local boot with partition images`_ section in the installation guide
for the Bare Metal service.
.. _`Local boot with partition images`: http://docs.openstack.org/project-install-guide/baremetal/draft/advanced.html#local-boot-with-partition-images
Enrollment
==========
See the `Enrollment`_ section in the installation guide for the Bare Metal
service.
.. _`Enrollment`: http://docs.openstack.org/project-install-guide/baremetal/draft/enrollment.html
Specifying the disk for deployment
==================================
See the `Specifying the disk for deployment`_ section in the installation guide
for the Bare Metal service.
.. _`Specifying the disk for deployment`: http://docs.openstack.org/project-install-guide/baremetal/draft/advanced.html#specifying-the-disk-for-deployment-root-device-hints
.. _EnableHTTPSinSwift:
Enabling HTTPS in Swift
=======================
See the `Enabling HTTPS in Swift`_ section in the installation guide for the
Bare Metal service.
.. _`Enabling HTTPS in Swift`: http://docs.openstack.org/project-install-guide/baremetal/draft/enabling-https.html#enabling-https-in-swift
.. _EnableHTTPSinGlance:
Enabling HTTPS in Image service
===============================
See the `Enabling HTTPS in Image service`_ section in the installation guide
for the Bare Metal service.
.. _`Enabling HTTPS in Image service`: http://docs.openstack.org/project-install-guide/baremetal/draft/enabling-https.html#enabling-https-in-image-service
Enabling HTTPS communication between Image service and Object storage
=====================================================================
See the `Enabling HTTPS communication between Image service and Object
storage`_ section in the installation guide for the Bare Metal service.
.. _`Enabling HTTPS communication between Image service and Object storage`: http://docs.openstack.org/project-install-guide/baremetal/draft/enabling-https.html#enabling-https-communication-between-image-service-and-object-storage
Enabling HTTPS communication between Image service and Bare Metal service
=========================================================================
See the `Enabling HTTPS communication between Image service and Bare Metal
service`_ section in the installation guide for the Bare Metal service.
.. _`Enabling HTTPS communication between Image service and Bare Metal service`: http://docs.openstack.org/project-install-guide/baremetal/draft/enabling-https.html#enabling-https-communication-between-image-service-and-bare-metal-service
Using Bare Metal service as a standalone service
================================================
See the `Using Bare Metal service as a standalone service`_ section in the
installation guide for the Bare Metal service.
.. _`Using Bare Metal service as a standalone service`: http://docs.openstack.org/project-install-guide/baremetal/draft/standalone.html
.. _`Enabling local boot without Compute`: http://docs.openstack.org/project-install-guide/baremetal/draft/local-boot-partition-images.html#enabling-local-boot-without-compute
Enabling the configuration drive (configdrive)
==============================================
See the `Enabling the configuration drive (configdrive)`_ section in the
installation guide for the Bare Metal service.
.. _`Enabling the configuration drive (configdrive)`: http://docs.openstack.org/project-install-guide/baremetal/draft/configdrive.html
Appending kernel parameters to boot instances
=============================================
See the `Appending kernel parameters to boot instances`_ section in the
installation guide for the Bare Metal service.
.. _`Appending kernel parameters to boot instances`: http://docs.openstack.org/project-install-guide/baremetal/draft/advanced.html#appending-kernel-parameters-to-boot-instances
.. _BuildingDeployRamdisk:
Building or downloading a deploy ramdisk image
==============================================
See the `Building or downloading a deploy ramdisk image`_ section in the
installation guide for the Bare Metal service.
.. _`Building or downloading a deploy ramdisk image`: http://docs.openstack.org/project-install-guide/baremetal/draft/deploy-ramdisk.html
Trusted boot with partition image
=================================
See the `Trusted boot with partition image`_ section in the installation guide
for the Bare Metal service.
.. _`Trusted boot with partition image`: http://docs.openstack.org/project-install-guide/baremetal/draft/advanced.html#trusted-boot-with-partition-image
Troubleshooting
===============
See the `Troubleshooting`_ section in the installation guide for the Bare Metal
service.
.. _`Troubleshooting`: http://docs.openstack.org/project-install-guide/baremetal/draft/troubleshooting.html

View File

@ -16,7 +16,7 @@ with a unified interface to a heterogeneous fleet of servers while also
providing the Compute service with an interface that allows physical servers to
be managed as though they were virtual machines.
:doc:`An introduction to ironic's conceptual architecture <deploy/user-guide>`
:doc:`An introduction to ironic's conceptual architecture <user/index>`
is available for those new to the project.
Site Notes
@ -130,59 +130,10 @@ configuration for devstack to bring up this environment.
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 <deploy/upgrade-guide>
Release Notes <http://docs.openstack.org/releasenotes/ironic/>
Troubleshooting FAQ <deploy/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 <deploy/cleaning>
Configuring Node Inspection <deploy/inspection>
Configuring RAID during deployment <deploy/raid>
Security considerations for your Bare Metal installation <deploy/security>
Adopting Nodes in an ACTIVE state <deploy/adoption>
Configuring for Multi-tenant Networking <deploy/multitenancy>
Configuring for port groups <deploy/portgroups>
Configuring node web or serial console <deploy/console>
Emitting software metrics <deploy/metrics>
Auditing API Traffic <deploy/api-audit-support>
Notifications <deploy/notifications>
Ceph Object Gateway support <deploy/radosgw>
Configuration Reference <http://docs.openstack.org/draft/config-reference/bare-metal.html>
Sample configuration file <https://git.openstack.org/cgit/openstack/ironic/tree/etc/ironic/ironic.conf.sample>
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/>
admin/index
Driver References
=================
@ -191,10 +142,10 @@ Every driver author is expected to document the use and configuration of their
driver. These pages are linked below.
.. toctree::
:maxdepth: 2
:maxdepth: 1
Driver Documentation pages <deploy/drivers>
Further Considerations for the Agent Drivers <drivers/ipa>
Driver Documentation pages <admin/drivers>
Further Considerations for the Agent Drivers <admin/drivers/ipa>
Command References
==================
@ -216,12 +167,13 @@ Indices and tables
.. # NOTE(jaegerandi): This is where we hide things that we don't want
# shown in the top level table of contents. api/autoindex is hidden
# since it's in the modindex link above.
# deploy/user-guide is referenced above but not in a toctree.
# user/index is referenced above but not in a toctree.
.. toctree::
:hidden:
api/autoindex
deploy/install-guide.rst
deploy/user-guide.rst
admin/install-guide.rst
user/index
releasenotes/index
webapi/v1.rst
admin/index

View File

@ -7,7 +7,7 @@ Configure the Bare Metal service for cleaning
(which is enabled by default), you will need to set the
``cleaning_network`` configuration option.
.. _`Node cleaning`: http://docs.openstack.org/developer/ironic/deploy/cleaning.html#node-cleaning
.. _`Node cleaning`: http://docs.openstack.org/ironic/latest/admin/cleaning.html#node-cleaning
#. Note the network UUID (the `id` field) of the network you created in
:ref:`configure-networking` or another network you created for cleaning:

View File

@ -82,4 +82,4 @@ these are ``Temperature``, ``Fan``, ``Voltage``, ``Current``.
Special value ``All`` (the default) designates all supported sensor types.
.. _IPMI: https://en.wikipedia.org/wiki/Intelligent_Platform_Management_Interface
.. _ipmitool driver page: https://docs.openstack.org/developer/ironic/drivers/ipmitool.html
.. _ipmitool driver page: https://docs.openstack.org/ironic/latest/admin/drivers/ipmitool.html

View File

@ -359,7 +359,7 @@ on the Bare Metal service node(s) where ``ironic-conductor`` is running.
you have to ensure that iPXE firmware on the nodes can indeed
boot from generated temporary URLs that use HTTPS protocol.
.. _Ceph Object Gateway support: http://docs.openstack.org/developer/ironic/deploy/radosgw.html
.. _Ceph Object Gateway support: http://docs.openstack.org/ironic/latest/admin/radosgw.html
#. Restart the ``ironic-conductor`` process:

View File

@ -149,4 +149,4 @@ provisioning will happen in a multi-tenant environment (which means using the
See `Multitenancy in Bare Metal service`_ for required node configuration.
.. _`Multitenancy in Bare Metal service`: http://docs.openstack.org/developer/ironic/deploy/multitenancy.html#multitenancy
.. _`Multitenancy in Bare Metal service`: http://docs.openstack.org/ironic/latest/admin/multitenancy.html#multitenancy

View File

@ -283,11 +283,11 @@ be installed locally. For example,
See `driver-specific documentation`_ for required configuration of each driver.
.. _driver composition reform specification: http://specs.openstack.org/openstack/ironic-specs/specs/approved/driver-composition-reform.html
.. _driver-specific documentation: https://docs.openstack.org/developer/ironic/deploy/drivers.html
.. _driver-specific documentation: https://docs.openstack.org/ironic/latest/admin/drivers.html
.. _setup.cfg: https://git.openstack.org/cgit/openstack/ironic/tree/setup.cfg
.. _`Configuring Web or Serial Console`: http://docs.openstack.org/developer/ironic/deploy/console.html
.. _`Configuring Web or Serial Console`: http://docs.openstack.org/ironic/latest/admin/console.html
.. _iSCSI: https://en.wikipedia.org/wiki/ISCSI
.. _ironic-inspector: https://docs.openstack.org/developer/ironic-inspector/
.. _inspection documentation: https://docs.openstack.org/developer/ironic/deploy/inspection.html
.. _RAID documentation: https://docs.openstack.org/developer/ironic/deploy/raid.html
.. _inspection documentation: https://docs.openstack.org/ironic/latest/admin/inspection.html
.. _RAID documentation: https://docs.openstack.org/ironic/latest/admin/raid.html
.. _vendor methods documentation: https://docs.openstack.org/developer/ironic/dev/vendor-passthru.html

View File

@ -82,7 +82,7 @@ command:
The properties marked as required must be supplied either during node creation
or shortly after. Some properties may only be required for certain features.
.. _driver-specific documentation: https://docs.openstack.org/developer/ironic/deploy/drivers.html
.. _driver-specific documentation: https://docs.openstack.org/ironic/latest/admin/drivers.html
Note on API versions
--------------------
@ -644,7 +644,7 @@ Hardware Inspection
The Bare Metal service supports hardware inspection that simplifies enrolling
nodes - please see `inspection`_ for details.
.. _`inspection`: http://docs.openstack.org/developer/ironic/deploy/inspection.html
.. _`inspection`: http://docs.openstack.org/ironic/latest/admin/inspection.html
Tenant Networks and Port Groups
-------------------------------
@ -652,5 +652,5 @@ Tenant Networks and Port Groups
See `Multitenancy in Bare Metal service`_ and
`Port groups configuration in Bare Metal service`_.
.. _`Multitenancy in Bare Metal service`: http://docs.openstack.org/developer/ironic/deploy/multitenancy.html
.. _`Port groups configuration in Bare Metal service`: http://docs.openstack.org/developer/ironic/deploy/portgroups.html
.. _`Multitenancy in Bare Metal service`: http://docs.openstack.org/ironic/latest/admin/multitenancy.html
.. _`Port groups configuration in Bare Metal service`: http://docs.openstack.org/ironic/latest/admin/portgroups.html

View File

@ -69,7 +69,7 @@ Configuring ironic-conductor service
Swift backend for the Image service should be installed and configured
for ``agent_*`` drivers. Ceph Object Gateway (RADOS Gateway) is also
supported as the Image service's backend (`radosgw support
<http://docs.openstack.org/developer/ironic/deploy/radosgw.html#radosgw-support>`_).
<http://docs.openstack.org/ironic/latest/admin/radosgw.html#radosgw-support>`_).
#. Set the URL (replace ``NEUTRON_IP``) for connecting to the Networking
service, to be the Networking service endpoint:
@ -82,7 +82,7 @@ Configuring ironic-conductor service
url=http://NEUTRON_IP:9696
To configure the network for ironic-conductor service to perform node
cleaning, see `CleaningNetworkSetup <http://docs.openstack.org/developer/ironic/deploy/cleaning.html>`_
cleaning, see `CleaningNetworkSetup <http://docs.openstack.org/ironic/latest/admin/cleaning.html>`_
from the Ironic deploy guide.
#. Configure credentials for accessing other OpenStack services.

View File

@ -5,4 +5,4 @@ See `Configuring Web or Serial Console`_.
.. TODO(dtantsur): move the installation documentation here
.. _`Configuring Web or Serial Console`: http://docs.openstack.org/developer/ironic/deploy/console.html
.. _`Configuring Web or Serial Console`: http://docs.openstack.org/ironic/latest/admin/console.html

View File

@ -13,4 +13,4 @@ resources from the Bare Metal service.
Notifications are disabled by default. For a complete list of available
notifications and instructions for how to enable them, see the `deploy
guide <http://docs.openstack.org/developer/ironic/deploy/notifications.html>`_.
guide <http://docs.openstack.org/ironic/latest/admin/notifications.html>`_.