openstack/ironic
Code Issues Proposed changes

Merge "Fix markup in documentation"

Browse Source
This commit is contained in:
Jenkins 2016-06-06 18:25:31 +00:00 committed by Gerrit Code Review
commit faa43c9564
11 changed files with 69 additions and 69 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
doc/source/deploy/drivers.rst
View File

@ -1,8 +1,8 @@
.. _drivers: .. _drivers:
================= ================
Enabling drivers Enabling drivers
================= ================
Ironic-Python-Agent (agent) Ironic-Python-Agent (agent)
--------------------------- ---------------------------
@ -13,16 +13,16 @@ nodes, and runs processes inside of a ramdisk.
For more information on this, see :ref:`IPA`. For more information on this, see :ref:`IPA`.
IPMITool IPMITool driver
-------- ---------------
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
../drivers/ipmitool ../drivers/ipmitool
DRAC DRAC driver
---- -----------
DRAC with PXE deploy DRAC with PXE deploy
^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^
@ -31,16 +31,16 @@ DRAC with PXE deploy
``/etc/ironic/ironic.conf`` ``/etc/ironic/ironic.conf``
- Install python-dracclient package - Install python-dracclient package
AMT AMT driver
---- ----------
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
../drivers/amt ../drivers/amt
SNMP SNMP driver
---- -----------
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
@ -63,16 +63,16 @@ SeaMicro driver
../drivers/seamicro ../drivers/seamicro
iRMC iRMC driver
---- -----------
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
../drivers/irmc ../drivers/irmc
VirtualBox drivers VirtualBox driver
------------------ -----------------
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
@ -108,7 +108,7 @@ iBoot driver
CIMC driver CIMC driver
------------ -----------
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1

1
doc/source/deploy/install-guide.rst
View File

@ -2588,5 +2588,4 @@ following command.
$ ironic node-set-maintenance $NODE_UUID off $ ironic node-set-maintenance $NODE_UUID off
.. _diskimage-builder: http://docs.openstack.org/developer/diskimage-builder/
.. _ironic-python-agent: http://docs.openstack.org/developer/ironic-python-agent/ .. _ironic-python-agent: http://docs.openstack.org/developer/ironic-python-agent/

1
doc/source/deploy/raid.rst
View File

@ -337,3 +337,4 @@ The hardware manager that supports RAID configuration should do the following:
{'step': 'delete_configuration', {'step': 'delete_configuration',
'interface': 'raid', 'interface': 'raid',
'priority': 0}] 'priority': 0}]

4
doc/source/deploy/upgrade-guide.rst
View File

@ -1,8 +1,8 @@
.. _upgrade-guide: .. _upgrade-guide:
===================================== ================================
Bare Metal Service Upgrade Guide Bare Metal Service Upgrade Guide
===================================== ================================
This document outlines various steps and notes for operators to consider when This document outlines various steps and notes for operators to consider when
upgrading their Ironic-driven clouds from previous versions of OpenStack. upgrading their Ironic-driven clouds from previous versions of OpenStack.

77
doc/source/deploy/user-guide.rst
View File

@ -1,8 +1,8 @@
.. _user-guide: .. _user-guide:
======================= ======================
Introduction to Ironic Introduction to Ironic
======================= ======================
Ironic is an OpenStack project which provisions physical hardware as opposed to Ironic is an OpenStack project which provisions physical hardware as opposed to
virtual machines. Ironic provides several reference drivers which leverage virtual machines. Ironic provides several reference drivers which leverage
@ -97,47 +97,44 @@ other resource needs to provision a bare metal instance.
Key Technologies for Bare Metal Hosting Key Technologies for Bare Metal Hosting
======================================= =======================================
PXE Preboot Execution Environment (PXE)
----- -----------------------------------
Preboot Execution Environment (PXE) is part of the Wired for Management (WfM) PXE is part of the Wired for Management (WfM) specification developed by Intel
specification developed by Intel and Microsoft. The PXE enables system's BIOS and Microsoft. The PXE enables system's BIOS and network interface card (NIC)
and network interface card (NIC) to bootstrap a computer from the network in to bootstrap a computer from the network in place of a disk. Bootstrapping is
place of a disk. Bootstrapping is the process by which a system loads the OS the process by which a system loads the OS into local memory so that it can be
into local memory so that it can be executed by the processor. This capability executed by the processor. This capability of allowing a system to boot over a
of allowing a system to boot over a network simplifies server deployment and network simplifies server deployment and server management for administrators.
server management for administrators.
DHCP Dynamic Host Configuration Protocol (DHCP)
------ ------------------------------------------
Dynamic Host Configuration Protocol (DHCP) is a standardized networking DHCP is a standardized networking protocol used on Internet Protocol (IP)
protocol used on Internet Protocol (IP) networks for dynamically distributing networks for dynamically distributing network configuration parameters, such
network configuration parameters, such as IP addresses for interfaces and as IP addresses for interfaces and services. Using PXE, the BIOS uses DHCP to
services. Using PXE, the BIOS uses DHCP to obtain an IP address for the obtain an IP address for the network interface and to locate the server that
network interface and to locate the server that stores the network bootstrap stores the network bootstrap program (NBP).
program (NBP).
NBP Network Bootstrap Program (NBP)
------ -------------------------------
Network Bootstrap Program (NBP) is equivalent to GRUB (GRand Unified NBP is equivalent to GRUB (GRand Unified Bootloader) or LILO (LInux LOader) -
Bootloader) or LILO (LInux LOader) - loaders which are traditionally used in loaders which are traditionally used in local booting. Like the boot program
local booting. Like the boot program in a hard drive environment, the NBP is in a hard drive environment, the NBP is responsible for loading the OS kernel
responsible for loading the OS kernel into memory so that the OS can be into memory so that the OS can be bootstrapped over a network.
bootstrapped over a network.
TFTP Trivial File Transfer Protocol (TFTP)
------ -------------------------------------
Trivial File Transfer Protocol (TFTP) is a simple file transfer protocol that TFTP is a simple file transfer protocol that is generally used for automated
is generally used for automated transfer of configuration or boot files between transfer of configuration or boot files between machines in a local
machines in a local environment. In a PXE environment, TFTP is used to environment. In a PXE environment, TFTP is used to download NBP over the
download NBP over the network using information from the DHCP server. network using information from the DHCP server.
IPMI Intelligent Platform Management Interface (IPMI)
------ ------------------------------------------------
Intelligent Platform Management Interface (IPMI) is a standardized computer IPMI is a standardized computer system interface used by system administrators
system interface used by system administrators for out-of-band management of for out-of-band management of computer systems and monitoring of their
computer systems and monitoring of their operation. It is a method to manage operation. It is a method to manage systems that may be unresponsive or powered
systems that may be unresponsive or powered off by using only a network off by using only a network connection to the hardware rather than to an
connection to the hardware rather than to an operating system. operating system.
Ironic Deployment Architecture Ironic Deployment Architecture
@ -297,7 +294,7 @@ This process is used with pxe_* family of drivers.
(From a `talk`_ and `slides`_) (From a `talk`_ and `slides`_)
Example 2: PXE Boot and Direct Deploy Process Example 2: PXE Boot and Direct Deploy Process
---------------------------------------------- ---------------------------------------------
This process is used with agent_* family of drivers. This process is used with agent_* family of drivers.

12
doc/source/dev/contributing.rst
View File

@ -33,15 +33,15 @@ authentication.
* https://launchpad.net/ironic * https://launchpad.net/ironic
Related Projects Related Projects
----------------- ----------------
* https://launchpad.net/ironic-inspector * https://launchpad.net/ironic-inspector
* https://launchpad.net/python-ironicclient * https://launchpad.net/python-ironicclient
* https://launchpad.net/python-ironic-inspector-client * https://launchpad.net/python-ironic-inspector-client
* https://launchpad.net/bifrost * https://launchpad.net/bifrost
Project Hosting Details Project Hosting Details
------------------------- -----------------------
Bug tracker Bug tracker
http://launchpad.net/ironic http://launchpad.net/ironic

1
doc/source/dev/dev-quickstart.rst
View File

@ -638,3 +638,4 @@ commands to build the documentation set::
Now use your browser to open the top-level index.html located at:: Now use your browser to open the top-level index.html located at::
ironic/doc/build/html/index.html ironic/doc/build/html/index.html

3
doc/source/drivers/ilo.rst
View File

@ -317,7 +317,7 @@ Hardware Inspection
Refer to `Hardware Inspection Support`_ for more information. Refer to `Hardware Inspection Support`_ for more information.
Swiftless deploy for intermediate deploy and boot images Swiftless deploy for intermediate deploy and boot images
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Refer to `Swiftless deploy for intermediate images`_ for more information. Refer to `Swiftless deploy for intermediate images`_ for more information.
HTTP(S) Based Deploy HTTP(S) Based Deploy
@ -1483,3 +1483,4 @@ To create an agent ramdisk with ``Proliant Hardware Manager``,
use the ``proliant-tools`` element in DIB:: use the ``proliant-tools`` element in DIB::
disk-image-create -o proliant-agent-ramdisk ironic-agent fedora proliant-tools disk-image-create -o proliant-agent-ramdisk ironic-agent fedora proliant-tools

1
doc/source/drivers/ipa.rst
View File

@ -124,3 +124,4 @@ that you have to update the node's ``driver_info`` field and set the
example, the below command sets this configuration in a specific node:: example, the below command sets this configuration in a specific node::
ironic node-update <UUID or name> add driver_info/deploy_forces_oob_reboot=True ironic node-update <UUID or name> add driver_info/deploy_forces_oob_reboot=True

2
doc/source/drivers/oneview.rst
View File

@ -168,7 +168,7 @@ Here is an overview of the deploy process for this driver:
12. Baremetal node is active and ready to be used. 12. Baremetal node is active and ready to be used.
Registering a OneView node in Ironic Registering a OneView node in Ironic
===================================== ====================================
Nodes configured to use any of the OneView drivers should have the ``driver`` Nodes configured to use any of the OneView drivers should have the ``driver``
property set to ``iscsi_pxe_oneview`` or ``agent_pxe_oneview``. Considering property set to ``iscsi_pxe_oneview`` or ``agent_pxe_oneview``. Considering

6
doc/source/webapi/v1.rst
View File

@ -1,6 +1,6 @@
===================== ====================
RESTful Web API (v1) RESTful Web API (v1)
===================== ====================
API Versioning API Versioning
============== ==============