ironic/doc/source/install/configure-glance-images.rst
Dmitry Tantsur 203660a0be
Fix *_by_arch documentation and un-deprecate the options without it
First, the *_by_arch options are not a replacement for plain options:
the cpu_arch property is neither required not standardized. This is why
older options with *_by_arch equivalents are not deprecated.

Second, the example in the documentation is wrong: oslo.config does not
use Python dictionaries. Which makes me suspect that the feature has
never been properly tested (indeed, it's not used in the devstack CI,
and Bifrost uses the older options).

Change-Id: If1e633930909ce9d80e14f3ec3daa0bf8d48b7f0
2023-11-27 18:12:58 +01:00

4.0 KiB

Add images to the Image service

Instance (end-user) images

Build or download the user images as described in /user/creating-images.

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:

    $ 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.

  • For partition images to be used only with local boot (the default) the img_type property must be set:

    $ 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:

    Add the kernel and ramdisk images to the Image service:

    $ 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.

    $ 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.

    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:

    $ 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

  1. Build or download the deploy images

    The deploy images are used initially for preparing the server (creating disk partitions) before the actual OS can be deployed.

    There are several methods to build or download deploy images, please read the deploy-ramdisk section.

  2. Add the deploy images to the Image service

    Add the deployment kernel and ramdisk images to the Image service:

    $ openstack image create deploy-vmlinuz --public \
      --disk-format aki --container-format aki \
      --file ironic-python-agent.vmlinuz

    Store the image UUID obtained from the above step as DEPLOY_VMLINUZ_UUID (or a different name when using the parameter specified by node architecture).

    $ openstack image create deploy-initrd --public \
      --disk-format ari --container-format ari \
      --file ironic-python-agent.initramfs

    Store the image UUID obtained from the above step as DEPLOY_INITRD_UUID (or a different name when using the parameter specified by node architecture).

  3. Configure the Bare Metal service to use the produced images. It can be done per node as described in enrollment or in the configuration file either using a dictionary to specify them by architecture (matching the node's cpu_arch property) as follows:

    [conductor]
    deploy_kernel_by_arch = x86_64:<DEPLOY_VMLINUZ_X86_64_UUID>,aarch64:<DEPLOY_VMLINUZ_AARCH64_UUID>
    deploy_ramdisk_by_arch = x86_64:<DEPLOY_INITRD_X86_64_UUID>,aarch64:<DEPLOY_INITRD_AARCH64_UUID>

    or globally using the general configuration parameters:

    [conductor]
    deploy_kernel = <insert DEPLOY_VMLINUZ_UUID>
    deploy_ramdisk = <insert DEPLOY_INITRD_UUID>

    In the case when both general parameters and parameters specified by architecture are defined, the parameters specified by architecture take priority.