openstack/ironic
Code Issues Proposed changes

Remove references to EOLed version of Ironic from the install guide

Browse Source 
The guide is versioned anyway, so there is no point to keep them.

Change-Id: I021c06669b00a31ac0875d891f98a6a929991768
This commit is contained in:
Dmitry Tantsur 2017-05-02 17:57:23 +02:00
parent 6f237ecfd9
commit ed90bdc93e
9 changed files with 37 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
install-guide/source/configdrive.rst
View File

@ -3,8 +3,8 @@
Enabling the configuration drive (configdrive) Enabling the configuration drive (configdrive)
============================================== ==============================================
Starting with the Kilo release, the Bare Metal service supports exposing The Bare Metal service supports exposing a configuration drive image to
a configuration drive image to the instances. the instances.
The configuration drive is used to store instance-specific metadata and is present to The configuration drive is used to store instance-specific metadata and is present to
the instance as a disk partition labeled ``config-2``. The configuration drive has the instance as a disk partition labeled ``config-2``. The configuration drive has

35
install-guide/source/enrollment.rst
View File

@ -74,15 +74,13 @@ and may be combined if desired.
| ... | ... | | ... | ... |
+------------------------+--------------------------------------+ +------------------------+--------------------------------------+
Beginning with the Kilo release a node may also be referred to by a logical A node may also be referred to by a logical name as well as its UUID.
name as well as its UUID. To utilize this new feature a name must be A name can be assigned to the node during creating by adding the ``-n``
assigned to the node. This can be done when the node is created by option to the ``node-create`` command or by updating an existing node with
adding the ``-n`` option to the ``node-create`` command or by updating an the ``node-update`` command. See `Logical Names`_ for examples.
existing node with the ``node-update`` command. See `Logical Names`_ for
examples.
Beginning with the Liberty release, with API version 1.11 and above, a newly Beginning with the API version 1.11 and above, a newly created node will
created node will have an initial provision state of ``enroll`` as opposed to have an initial provision state of ``enroll`` as opposed to
``available``. See `Enrolling a node`_ for more details. ``available``. See `Enrolling a node`_ for more details.
#. Update the node ``driver_info`` so that Bare Metal service can manage the #. Update the node ``driver_info`` so that Bare Metal service can manage the
@ -137,9 +135,8 @@ and may be combined if desired.
ironic node-update $NODE_UUID add \ ironic node-update $NODE_UUID add \
properties/capabilities=key1:val1,key2:val2 properties/capabilities=key1:val1,key2:val2
#. As mentioned in the :ref:`flavor-creation` section, if using the Kilo or later #. As mentioned in the :ref:`flavor-creation` section, you should specify
release of Bare Metal service, you should specify a deploy kernel and a deploy kernel and ramdisk compatible with the node's driver, for example::
ramdisk which correspond to the node's driver, for example::
ironic node-update $NODE_UUID add \ ironic node-update $NODE_UUID add \
driver_info/deploy_kernel=$DEPLOY_VMLINUZ_UUID \ driver_info/deploy_kernel=$DEPLOY_VMLINUZ_UUID \
@ -209,8 +206,8 @@ and may be combined if desired.
Enrolling a node Enrolling a node
---------------- ----------------
In the Liberty cycle, starting with API version 1.11, the Bare Metal service Starting with API version 1.11, the Bare Metal service added a new initial
added a new initial provision state of ``enroll`` to its state machine. provision state of ``enroll`` to its state machine.
Existing automation tooling that use an API version lower than 1.11 are not Existing automation tooling that use an API version lower than 1.11 are not
affected, since the initial provision state is still ``available``. affected, since the initial provision state is still ``available``.
@ -348,10 +345,10 @@ documentation.
Logical names Logical names
------------- -------------
Beginning with the Kilo release a Node may also be referred to by a A Node may also be referred to by a logical name as well as its UUID.
logical name as well as its UUID. Names can be assigned either when Names can be assigned either when creating the node by adding the ``-n``
creating the node by adding the ``-n`` option to the ``node-create`` command or option to the ``node-create`` command or by updating an existing node with
by updating an existing node with the ``node-update`` command. the ``node-update`` command.
Node names must be unique, and conform to: Node names must be unique, and conform to:
@ -409,7 +406,7 @@ UUID interchangeably.
Hardware Inspection Hardware Inspection
------------------- -------------------
Starting with the Kilo release, Bare Metal service supports hardware inspection The Bare Metal service supports hardware inspection that simplifies enrolling
that simplifies enrolling nodes - please see `inspection`_ for details. nodes - please see `inspection`_ for details.
.. _`inspection`: http://docs.openstack.org/developer/ironic/deploy/inspection.html .. _`inspection`: http://docs.openstack.org/developer/ironic/deploy/inspection.html

6
install-guide/source/include/configure-ironic-conductor.rst
View File

@ -79,9 +79,9 @@ Configuring ironic-conductor service
.. note:: .. note::
Swift backend for the Image service should be installed and configured Swift backend for the Image service should be installed and configured
for ``agent_*`` drivers. Starting with Mitaka the Bare Metal service also for ``agent_*`` drivers. Ceph Object Gateway (RADOS Gateway) is also
supports Ceph Object Gateway (RADOS Gateway) as the Image service's backend supported as the Image service's backend (`radosgw support
(`radosgw support <http://docs.openstack.org/developer/ironic/deploy/radosgw.html#radosgw-support>`_). <http://docs.openstack.org/developer/ironic/deploy/radosgw.html#radosgw-support>`_).
#. Set the URL (replace ``NEUTRON_IP``) for connecting to the Networking #. Set the URL (replace ``NEUTRON_IP``) for connecting to the Networking
service, to be the Networking service endpoint: service, to be the Networking service endpoint:

14
install-guide/source/include/local-boot-partition-images.rst
View File

@ -3,10 +3,10 @@
Local boot with partition images Local boot with partition images
-------------------------------- --------------------------------
Starting with the Kilo release, Bare Metal service supports local boot with The Bare Metal service supports local boot with partition images, meaning that
partition images, meaning that after the deployment the node's subsequent after the deployment the node's subsequent reboots won't happen via PXE or
reboots won't happen via PXE or Virtual Media. Instead, it will boot from a Virtual Media. Instead, it will boot from a local boot loader installed on
local boot loader installed on the disk. the disk.
It's important to note that in order for this to work the image being It's important to note that in order for this to work the image being
deployed with Bare Metal service **must** contain ``grub2`` installed within it. deployed with Bare Metal service **must** contain ``grub2`` installed within it.
@ -15,12 +15,6 @@ Enabling the local boot is different when Bare Metal service is used with
Compute service and without it. Compute service and without it.
The following sections will describe both methods. The following sections will describe both methods.
.. note::
The local boot feature is dependent upon a updated deploy ramdisk built
with diskimage-builder_ **version >= 0.1.42** or ironic-python-agent_
in the kilo-era.
.. _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/

5
install-guide/source/include/root-device-hints.rst
View File

@ -3,9 +3,8 @@
Specifying the disk for deployment (root device hints) Specifying the disk for deployment (root device hints)
------------------------------------------------------ ------------------------------------------------------
Starting with the Kilo release, Bare Metal service supports passing The Bare Metal service supports passing hints to the deploy ramdisk about
hints to the deploy ramdisk about which disk it should pick for the which disk it should pick for the deployment. The list of supported hints is:
deployment. The list of support hints is:
* model (STRING): device identifier * model (STRING): device identifier
* vendor (STRING): device vendor * vendor (STRING): device vendor

4
install-guide/source/include/trusted-boot.rst
View File

@ -3,8 +3,8 @@
Trusted boot with partition image Trusted boot with partition image
--------------------------------- ---------------------------------
Starting with the Liberty release, Ironic supports trusted boot with partition The Bare metal service supports trusted boot with partition images.
image. This means at the end of the deployment process, when the node is This means at the end of the deployment process, when the node is
rebooted with the new user image, ``trusted boot`` will be performed. It will rebooted with the new user image, ``trusted boot`` will be performed. It will
measure the node's BIOS, boot loader, Option ROM and the Kernel/Ramdisk, to measure the node's BIOS, boot loader, Option ROM and the Kernel/Ramdisk, to
determine whether a bare metal node deployed by Ironic should be trusted. determine whether a bare metal node deployed by Ironic should be trusted.

3
install-guide/source/setup-drivers.rst
View File

@ -219,9 +219,6 @@ isn't recommended since it is not being supported.
iPXE setup iPXE setup
---------- ----------
An alternative to PXE boot, iPXE was introduced in the Juno release
(2014.2.0) of Bare Metal service.
If you will be using iPXE to boot instead of PXE, iPXE needs to be set up If you will be using iPXE to boot instead of PXE, iPXE needs to be set up
on the Bare Metal service node(s) where ``ironic-conductor`` is running. on the Bare Metal service node(s) where ``ironic-conductor`` is running.

11
install-guide/source/standalone.rst
View File

@ -2,9 +2,7 @@
Using Bare Metal service as a standalone service Using Bare Metal service as a standalone service
================================================ ================================================
Starting with the Kilo release, it's possible to use Bare Metal service without It's possible to use the Bare Metal service without other OpenStack services.
other OpenStack services.
You should make the following changes to ``/etc/ironic/ironic.conf``: You should make the following changes to ``/etc/ironic/ironic.conf``:
#. To disable usage of Identity service tokens:: #. To disable usage of Identity service tokens::
@ -153,10 +151,9 @@ For iLO drivers, fields that should be provided are:
* ``ilo_boot_iso``, ``image_source``, ``root_gb`` under ``instance_info``. * ``ilo_boot_iso``, ``image_source``, ``root_gb`` under ``instance_info``.
.. note:: .. note::
Before Liberty release Ironic was not able to track non-Glance images' The Bare metal service tracks content changes for non-Glance images by
content changes. Starting with Liberty, it is possible to do so using image checking their modification date and time. For example, for HTTP image,
modification date. For example, for HTTP image, if 'Last-Modified' header if 'Last-Modified' header value from response to a HEAD request to
value from response to a HEAD request to
"http://my.server.net/images/deploy.ramdisk" is greater than cached image "http://my.server.net/images/deploy.ramdisk" is greater than cached image
modification time, Ironic will re-download the content. For "file://" modification time, Ironic will re-download the content. For "file://"
images, the file system modification time is used. images, the file system modification time is used.

7
install-guide/source/troubleshooting.rst
View File

@ -94,9 +94,10 @@ with the following command.
$ ironic node-set-maintenance $NODE_UUID on $ ironic node-set-maintenance $NODE_UUID on
As of the Kilo release, a maintenance reason may be included with the optional A maintenance reason may be included with the optional ``--reason`` command
``--reason`` command line option. This is a free form text field that will be line option. This is a free form text field that will be displayed in the
displayed in the ``maintenance_reason`` section of the ``node-show`` command. ``maintenance_reason`` section of the ``node-show`` command.
:: ::
$ ironic node-set-maintenance $UUID on --reason "Need to add ram." $ ironic node-set-maintenance $UUID on --reason "Need to add ram."