docs: document stance on partition image use
Change-Id: Ice381b2d22af48a99081080f5985f609a13dc939
This commit is contained in:
parent
c85d9c8326
commit
91ee72800f
@ -13,15 +13,16 @@ the end user. There are two types of user images:
|
|||||||
a kernel and with an initramfs.
|
a kernel and with an initramfs.
|
||||||
|
|
||||||
.. warning::
|
.. warning::
|
||||||
To use partition images with local boot, Grub2 must be installed on
|
To use partition images, Grub2 must be installed in the image.
|
||||||
them.
|
This is *not* a recommended path.
|
||||||
|
|
||||||
*whole disk images*
|
*whole disk images*
|
||||||
contain a complete partition table with one or more partitions.
|
contain a complete partition table with one or more partitions.
|
||||||
|
|
||||||
.. warning::
|
.. warning::
|
||||||
The kernel/initramfs pair must not be used with whole disk images,
|
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
|
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
|
images that are built for legacy boot mode (not UEFI), with Ubuntu being an
|
||||||
|
@ -83,8 +83,7 @@ You need to specify image information in the node's ``instance_info``
|
|||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
Older versions of the Bare Metal service used to require a positive
|
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
|
integer for ``root_gb`` even for whole-disk images.
|
||||||
it for compatibility.
|
|
||||||
|
|
||||||
* ``image_checksum`` - MD5 checksum of the image specified by
|
* ``image_checksum`` - MD5 checksum of the image specified by
|
||||||
``image_source``, only required for ``http://`` images when using
|
``image_source``, only required for ``http://`` images when using
|
||||||
|
@ -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.
|
Loading…
Reference in New Issue
Block a user