summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
authorZuul <zuul@review.opendev.org>2022-07-18 17:42:44 +0000
committerGerrit Code Review <review@openstack.org>2022-07-18 17:42:44 +0000
commitdb0e1cc0ec4d1b3fdb1a4cc8d0d408e0b1084318 (patch)
tree0baba07d8cefc83f394b4bfe32fc3bcfe75746c0 /doc/source
parent72411f8259cff79420a48f8e98ac9d480a99b679 (diff)
parent19daab6bae95bf1e911a131c7a67f977a60048f8 (diff)
downloadironic-db0e1cc0ec4d1b3fdb1a4cc8d0d408e0b1084318.tar.gz
Merge "Docs: specify what to do with the created images"
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/install/configure-glance-images.rst92
1 files changed, 52 insertions, 40 deletions
diff --git a/doc/source/install/configure-glance-images.rst b/doc/source/install/configure-glance-images.rst
index 7c7f2ee57..4b8300678 100644
--- a/doc/source/install/configure-glance-images.rst
+++ b/doc/source/install/configure-glance-images.rst
@@ -1,67 +1,69 @@
.. _image-requirements:
Add images to the Image service
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+===============================
-#. Build or download the user images as described in
- :doc:`/user/creating-images`.
+Instance (end-user) images
+~~~~~~~~~~~~~~~~~~~~~~~~~~
-#. Add the user images to the Image service
+Build or download the user images as described in :doc:`/user/creating-images`.
- Load all the images created in the below steps into the Image service,
- and note the image UUIDs in the Image service for each one as it is
- generated.
+Load all the created images into the Image service, and note the image UUIDs in
+the Image service for each one as it is generated.
- - For *whole disk images* just upload the image:
+- For *whole disk images* just upload the image:
- .. code-block:: console
+ .. code-block:: console
- $ openstack image create my-whole-disk-image --public \
- --disk-format qcow2 --container-format bare \
- --file my-whole-disk-image.qcow2
+ $ openstack image create my-whole-disk-image --public \
+ --disk-format qcow2 --container-format bare \
+ --file my-whole-disk-image.qcow2
- .. warning::
- The kernel/ramdisk pair must not be set for whole disk images,
- otherwise they'll be mistaken for partition images.
+ .. warning::
+ The kernel/ramdisk pair must not be set for whole disk images,
+ otherwise they'll be mistaken for partition images.
- - For *partition images* to be used only with *local boot* (the default)
- the ``img_type`` property must be set:
+- For *partition images* to be used only with *local boot* (the default)
+ the ``img_type`` property must be set:
- .. code-block:: console
+ .. code-block:: console
- $ openstack image create my-image --public \
- --disk-format qcow2 --container-format bare \
- --property img_type=partition --file my-image.qcow2
+ $ openstack image create my-image --public \
+ --disk-format qcow2 --container-format bare \
+ --property img_type=partition --file my-image.qcow2
- - For *partition images* to be used with both *local* and *network* boot:
+- For *partition images* to be used with both *local* and *network* boot:
- Add the kernel and ramdisk images to the Image service:
+ Add the kernel and ramdisk images to the Image service:
- .. code-block:: console
+ .. code-block:: console
- $ openstack image create my-kernel --public \
- --disk-format aki --container-format aki --file my-image.vmlinuz
+ $ openstack image create my-kernel --public \
+ --disk-format aki --container-format aki --file my-image.vmlinuz
- Store the image uuid obtained from the above step as ``MY_VMLINUZ_UUID``.
+ Store the image uuid obtained from the above step as ``MY_VMLINUZ_UUID``.
- .. code-block:: console
+ .. code-block:: console
- $ openstack image create my-image.initrd --public \
- --disk-format ari --container-format ari --file my-image.initrd
+ $ openstack image create my-image.initrd --public \
+ --disk-format ari --container-format ari --file my-image.initrd
- Store the image UUID obtained from the above step as ``MY_INITRD_UUID``.
+ Store the image UUID obtained from the above step as ``MY_INITRD_UUID``.
- Add the *my-image* to the Image service which is going to be the OS
- that the user is going to run. Also associate the above created
- images with this OS image. These two operations can be done by
- executing the following command:
+ Add the *my-image* to the Image service which is going to be the OS
+ that the user is going to run. Also associate the above created
+ images with this OS image. These two operations can be done by
+ executing the following command:
- .. code-block:: console
+ .. code-block:: console
- $ openstack image create my-image --public \
- --disk-format qcow2 --container-format bare --property \
- kernel_id=$MY_VMLINUZ_UUID --property \
- ramdisk_id=$MY_INITRD_UUID --file my-image.qcow2
+ $ openstack image create my-image --public \
+ --disk-format qcow2 --container-format bare --property \
+ kernel_id=$MY_VMLINUZ_UUID --property \
+ ramdisk_id=$MY_INITRD_UUID --file my-image.qcow2
+
+Deploy ramdisk images
+~~~~~~~~~~~~~~~~~~~~~
#. Build or download the deploy images
@@ -90,3 +92,13 @@ Add images to the Image service
--file ironic-python-agent.initramfs
Store the image UUID obtained from the above step as ``DEPLOY_INITRD_UUID``.
+
+#. Configure the Bare Metal service to use the produced images. It can be done
+ per node as described in :doc:`enrollment` or globally in the configuration
+ file:
+
+ .. code-block:: ini
+
+ [conductor]
+ deploy_kernel = <insert DEPLOY_VMLINUZ_UUID>
+ deploy_ramdisk = <insert DEPLOY_INITRD_UUID>