diff --git a/doc/source/user/creating-images.rst b/doc/source/user/creating-images.rst index efcd632a5f..8ff3ba4966 100644 --- a/doc/source/user/creating-images.rst +++ b/doc/source/user/creating-images.rst @@ -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 diff --git a/doc/source/user/deploy.rst b/doc/source/user/deploy.rst index 723b1024b2..9fc67e68db 100644 --- a/doc/source/user/deploy.rst +++ b/doc/source/user/deploy.rst @@ -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 diff --git a/releasenotes/notes/set-stance-on-image-types-4905f00a09a6521f.yaml b/releasenotes/notes/set-stance-on-image-types-4905f00a09a6521f.yaml new file mode 100644 index 0000000000..07bb2e2440 --- /dev/null +++ b/releasenotes/notes/set-stance-on-image-types-4905f00a09a6521f.yaml @@ -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.