From a8529db5fc131ffdb961a2bf113f6c7f1c3be978 Mon Sep 17 00:00:00 2001
From: Mark Goddard <mark@stackhpc.com>
Date: Mon, 10 Feb 2020 13:02:54 +0000
Subject: [PATCH] Ironic: fix documentation
Backport: train
* Ironic dropped CoreOS IPA images in Train - use CentOS DIB images
* Nova flavor requires dropping standard resources
* Link to sections in ironic docs
Change-Id: Id65ada7cd6766d3a907a5a1da54978b56319979c
---
.../reference/bare-metal/ironic-guide.rst | 26 ++++++++++++-------
1 file changed, 17 insertions(+), 9 deletions(-)
diff --git a/doc/source/reference/bare-metal/ironic-guide.rst b/doc/source/reference/bare-metal/ironic-guide.rst
index 5c00792534..2e1f79f60d 100644
--- a/doc/source/reference/bare-metal/ironic-guide.rst
+++ b/doc/source/reference/bare-metal/ironic-guide.rst
@@ -6,7 +6,7 @@ Ironic - Bare Metal provisioning
Overview
~~~~~~~~
-Ironic works well in Kolla, though it is not currently tested as part of Kolla
+Ironic works well in Kolla, though it is not thoroughly tested as part of Kolla
CI, so may be subject to instability.
Pre-deployment Configuration
@@ -51,10 +51,10 @@ be used:
.. code-block:: console
- $ curl https://tarballs.openstack.org/ironic-python-agent/coreos/files/coreos_production_pxe.vmlinuz \
+ $ curl https://tarballs.openstack.org/ironic-python-agent/dib/files/ipa-centos7-master.kernel \
-o /etc/kolla/config/ironic/ironic-agent.kernel
- $ curl https://tarballs.openstack.org/ironic-python-agent/coreos/files/coreos_production_pxe_image-oem.cpio.gz \
+ $ curl https://tarballs.openstack.org/ironic-python-agent/dib/files/ipa-centos7-master.initramfs \
-o /etc/kolla/config/ironic/ironic-agent.initramfs
You may optionally pass extra kernel parameters to the inspection kernel using:
@@ -112,8 +112,10 @@ initialise the cloud with some defaults (only to be used for demo purposes):
tools/init-runonce
-Add the deploy kernel and ramdisk to Glance. Here we're reusing the same images
-that were fetched for the Inspector:
+The :ironic-doc:`Ironic documentation <install/configure-glance-images>`
+describes how to create the deploy kernel and ramdisk and register them with
+Glance. In this example we're reusing the same images that were fetched for the
+Inspector:
.. code-block:: console
@@ -123,16 +125,22 @@ that were fetched for the Inspector:
openstack image create --disk-format ari --container-format ari --public \
--file /etc/kolla/config/ironic/ironic-agent.initramfs deploy-initrd
-Create a baremetal flavor:
+The :ironic-doc:`Ironic documentation <install/configure-nova-flavors>`
+describes how to create Nova flavors for bare metal. For example:
.. code-block:: console
openstack flavor create --ram 512 --disk 1 --vcpus 1 my-baremetal-flavor
openstack flavor set my-baremetal-flavor --property \
- resources:CUSTOM_BAREMETAL_RESOURCE_CLASS=1
+ resources:CUSTOM_BAREMETAL_RESOURCE_CLASS=1 \
+ resources:resources:VCPU=0 \
+ resources:resources:MEMORY_MB=0 \
+ resources:resources:DISK_GB=0
-Create the baremetal node and associate a port. (Ensure to substitute correct
-values for the kernel, ramdisk, and MAC address for your baremetal node)
+The :ironic-doc:`Ironic documentation <install/enrollment>` describes how to
+enroll baremetal nodes and ports. In the following example ensure to
+substitute correct values for the kernel, ramdisk, and MAC address for your
+baremetal node.
.. code-block:: console