openstack/diskimage-builder
Code Issues Proposed changes

docs: add two contextual warnings to the replace-partition element

Browse Source 
I observed some issues while testing, and just wanted to note them
in the documentation for the element so users have greater context
into it's use.

Change-Id: Ia273a8313b2ebdb35bb378e815b276c3c07e711c
This commit is contained in:
Julia Kreger 2024-09-10 07:24:49 -07:00
parent 3e4062e35d
commit a91d57c389
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
diskimage_builder/elements/replace-partition/README.rst
View File

@ -14,6 +14,21 @@ for this element include:
See element ``replace-partition-redhat`` for a full example of how to use this element
.. WARNING::
When using this element or elements based upon it, differences in the
needs of ramdisk component artifacts are generally **not** accounted for.
I.E. if you rebuild an image which did not have LVM to a disk layout with
LVM, then the image is *unlikely* to work because the ramdisk lacks the
contents necessary to detect and initailize the ramdisk.
.. WARNING::
When rebuilding images, specifically with filesystems like XFS, you should
utilize diskimage-builder on the same OS and Version as the image you
are rebuilding. This is because some filesystem version and metadata
characteristics of newer host kernels can prevent the image from being used
by the kernel inside of the image. This is most pertinant with the XFS
filesystem, but there may be other cases we are unaware of.
Arguments
=========