diff --git a/doc/source/dev/states.rst b/doc/source/dev/states.rst new file mode 100644 index 0000000000..6b370bb51f --- /dev/null +++ b/doc/source/dev/states.rst @@ -0,0 +1,21 @@ +.. _states: + +====================== +Ironic's State Machine +====================== + +The diagram below shows the states that an Ironic node goes through during the +lifetime of a node. The diagram also depicts the events that transition +the node to different states. + +.. figure:: ../images/states.png + :width: 660px + :align: left + :alt: Ironic state transitions + +.. note:: + + For more information about the states, see the specification located at + `ironic-state-machine`_. + +.. _ironic-state-machine: http://specs.openstack.org/openstack/ironic-specs/specs/kilo/new-ironic-state-machine.html diff --git a/doc/source/images/states.png b/doc/source/images/states.png new file mode 100644 index 0000000000..879b8d73bb Binary files /dev/null and b/doc/source/images/states.png differ diff --git a/doc/source/index.rst b/doc/source/index.rst index d504dda75b..d4cdc6a2d3 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -30,6 +30,7 @@ Introduction :maxdepth: 1 dev/architecture + dev/states dev/contributing .. toctree::