particle-os-modules/modules/initramfs
fiftydinar 23e36119b9
feat: initramfs module (#376)
* feat: `initramfs` module

* chore: Add `initramfs` to `modules.json`

* docs: Mention `dracut.conf.d` files as modifications which need initramfs regeneration

* docs: Style fix

* docs: Style fix

* docs: One more style fix

* docs: Add note about difference between `rpm-ostree initramfs` & this module

* docs: Further explanation of initramfs

* docs: Style fixes

* docs: Style fix

* docs: Grammar fixes

* chore: Add check for Fedora 41+

* docs: Add note about F41+ support

* docs: Add 3 dots for note

* chore: Grammar improvement in log

* chore: Some more explanations in log for old Fedora version

* chore: Add error message for cliwrapped images

* chore: Use cliwrapped dracut if available

* docs: Apply caution card suggestion

Co-authored-by: xyny <60004820+xynydev@users.noreply.github.com>

* docs: Apply suggestion about modifications list

Co-authored-by: xyny <60004820+xynydev@users.noreply.github.com>

* docs: Apply grammar suggestion for when this module should be used

Co-authored-by: xyny <60004820+xynydev@users.noreply.github.com>

* chore: Make log message about initramfs regeneration state clearer

Co-authored-by: xyny <60004820+xynydev@users.noreply.github.com>

* docs: Apply suggestion about expanded module description

Co-authored-by: xyny <60004820+xynydev@users.noreply.github.com>

* docs: RAM instead of ram

* chore: Fix log typo

* docs: Update description in typeschema

* docs: Update description in module.yml

* chore: Notify of more than 1 qualified kernel before initramfs image variable

* chore: finalize shortdesc wording

---------

Co-authored-by: xyny <60004820+xynydev@users.noreply.github.com>
2024-12-15 11:02:37 +01:00
..
initramfs.sh feat: initramfs module (#376) 2024-12-15 11:02:37 +01:00
initramfs.tsp feat: initramfs module (#376) 2024-12-15 11:02:37 +01:00
module.yml feat: initramfs module (#376) 2024-12-15 11:02:37 +01:00
README.md feat: initramfs module (#376) 2024-12-15 11:02:37 +01:00

initramfs

:::caution This module is only supported for Fedora 41+ images. :::

The initramfs module is used to regenerate initramfs, which is the temporary file system loaded into RAM, as part of the early Linux startup process, used by many things happening during boot.

If you are trying to modify something related to the kernel or boot sequence (such as plymouth), but you don't see any changes applied to the system, you'll likely need to use this module.

You need to regenerate initramfs at least when doing any of the following:

  • modifying modprobe.d config files
  • modifying modules-load.d config files
  • modifying dracut.conf.d config files
  • customizing plymouth theming
  • other unknown modifications

You only need to run the regeneration once per build, not separately for each modification requiring it. It is recommended to set this module as one of the last in your recipe, to ensure that initramfs regeneration will cover all the modifications done before it.

:::note Client-side initramfs regeneration like rpm-ostree initramfs & rpm-ostree initramfs-etc are for local-users only & not to be confused with this module's build-time initramfs regeneration. This module regenerates the system initramfs during the build process, while rpm-ostree initramfs & rpm-ostree initramfs-etc regenerate the local initramfs on top of the system one every update on the local-user's system. :::