openstack/ironic
Code Issues Proposed changes

docs: document stance on partition image use

Browse Source 
Change-Id: Ice381b2d22af48a99081080f5985f609a13dc939
This commit is contained in:
Julia Kreger 2024-04-09 17:33:04 -07:00
parent c85d9c8326
commit 91ee72800f
3 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/source/user/creating-images.rst
View File

@ -13,15 +13,16 @@ the end user. There are two types of user images:
a kernel and with an initramfs.
.. warning::
To use partition images with local boot, Grub2 must be installed on
them.
To use partition images, Grub2 must be installed in the image.
This is *not* a recommended path.
*whole disk images*
contain a complete partition table with one or more partitions.
.. warning::
The kernel/initramfs pair must not be used with whole disk images,
otherwise they'll be mistaken for partition images.
otherwise they'll be mistaken for partition images. Whole disk images
are the recommended type of images to use.
Many distributions publish their own cloud images. These are usually whole disk
images that are built for legacy boot mode (not UEFI), with Ubuntu being an

3
doc/source/user/deploy.rst
View File

@ -83,8 +83,7 @@ You need to specify image information in the node's ``instance_info``
.. note::
Older versions of the Bare Metal service used to require a positive
integer for ``root_gb`` even for whole-disk images. You may want to set
it for compatibility.
integer for ``root_gb`` even for whole-disk images.
* ``image_checksum`` - MD5 checksum of the image specified by
``image_source``, only required for ``http://`` images when using

10
releasenotes/notes/set-stance-on-image-types-4905f00a09a6521f.yaml Normal file
View File

@ -0,0 +1,10 @@
---
other:
- |
Moving forward, Ironic will discourage the use of "partition" images,
in favor of "whole disk images", largely due to the underlying complexity
in the code to maintain partition image support. This is not the
deprecation of the functionality as the community has agreed to keep the
functionality and fix any issues we become aware of. UEFI Partition images,
where EFI assets are copied from a partition image, are the only partition
images Ironic intends to test on a regular basis moving forward.