openstack/ironic
Code Issues Proposed changes

Docs: specify what to do with the created images

Browse Source 
Also make the Glance image docs easier to navigate.

Change-Id: Ib7f891c2086c556cffca94eb0e37db87b6a68e7b
This commit is contained in:
Dmitry Tantsur 2022-06-22 10:51:15 +02:00 committed by Jay Faulkner
parent 39a7f58002
commit 19daab6bae
1 changed files with 52 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

92
doc/source/install/configure-glance-images.rst
View File

@ -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>