Go to file
Harald Hoyer 871d63c3be Fix CI badges in README.md and fix dracut description
While fixing the CI badges, I removed some old crufty README text.
2020-05-29 16:15:42 +02:00
.github/workflows CI: remove Fedora 30, add Fedora 32 2020-05-29 10:53:57 +02:00
dracut.conf.d
examples/yocto
install dracut_mkdir(): create parent directories as needed. 2020-03-02 14:48:11 +01:00
modules.d network-manager: set kernel hostname from the command line 2020-05-29 14:42:42 +02:00
skipcpio
test TEST-99: exclude /etc/dnf/* from check 2020-04-09 22:11:16 +02:00
.dir-locals.el
.gitignore
.kateconfig
.kateproject
.mailmap
.travis.yml .travis.yml: reformat 2020-03-12 13:54:39 +01:00
50-dracut.install
51-dracut-rescue-postinst.sh
51-dracut-rescue.install 51-dracut-rescue.install: Don't use BLS fragment shipped by kernel package 2020-05-07 15:16:00 +02:00
AUTHORS NEWS, AUTHORS: update 2020-03-04 11:43:22 +01:00
COPYING
HACKING
Makefile Makefile: really make externally defined CFLAGS work 2020-03-19 16:46:54 +01:00
NEWS NEWS, AUTHORS: update 2020-03-04 11:43:22 +01:00
PKGBUILD
README.cross
README.generic
README.kernel
README.md Fix CI badges in README.md and fix dracut description 2020-05-29 16:15:42 +02:00
README.modules
README.testsuite
TODO
configure
dracut-bash-completion.sh
dracut-catimages.8.asc
dracut-catimages.sh
dracut-functions.sh dracut-functions: fix find_binary() to return full path 2020-05-29 10:27:59 +02:00
dracut-init.sh add DRACUT_NO_XATTR global environment variable 2020-02-27 13:49:21 +01:00
dracut-initramfs-restore.sh
dracut-logger.sh
dracut.8.asc Support the EFI Stub loader's splash image feature. 2020-02-20 11:03:30 +01:00
dracut.asc Documentation: dynamically set current version 2019-11-12 13:24:41 +01:00
dracut.bootup.7.asc Documentation: dynamically set current version 2019-11-12 13:24:41 +01:00
dracut.cmdline.7.asc dracut.cmdline.7.asc: clarify usage of `rd.lvm.vg` and `rd.lvm.lv` 2020-05-29 13:28:27 +02:00
dracut.conf
dracut.conf.5.asc dracut.conf.5.asc: document how to config --no-compress in the config 2020-05-29 14:08:52 +02:00
dracut.css
dracut.logrotate
dracut.modules.7.asc Documentation: dynamically set current version 2019-11-12 13:24:41 +01:00
dracut.png
dracut.sh dracut.sh: add check for invalid configuration files 2020-03-18 16:34:35 +01:00
dracut.spec Fix CI badges in README.md and fix dracut description 2020-05-29 16:15:42 +02:00
dracut.svg
dracut.usage.asc
fedora-test-github.sh fedora-test-github.sh: only fetch tags, if building rpm 2020-03-04 11:06:04 +01:00
fedora-test.sh test: build docs when running TEST-99-RPM 2020-02-28 16:31:43 +01:00
git2spec.pl git2spec: include contents of binaries in patches 2019-11-12 13:27:59 +01:00
logtee.c logtee: time out after a period of no output 2019-11-11 20:30:45 +01:00
lsinitrd-bash-completion.sh
lsinitrd.1.asc Documentation: dynamically set current version 2019-11-12 13:24:41 +01:00
lsinitrd.sh Fix test in lsinitrd 2020-05-04 11:48:09 +02:00
mkinitrd-dracut.sh
mkinitrd-suse.8.asc
mkinitrd-suse.sh mkinitrd-suse.sh: Fix i586 platform detection 2020-04-07 21:10:43 +02:00
mkinitrd.8.asc Documentation: dynamically set current version 2019-11-12 13:24:41 +01:00
profile.py

README.md

dracut

dracut is an event driven initramfs infrastructure.

Build Status Fedora-31 Fedora-32

dracut (the tool) is used to create an initramfs image by copying tools and files from an installed system and combining it with the dracut framework, usually found in /usr/lib/dracut/modules.d.

Unlike other implementations, dracut hard-codes as little as possible into the initramfs. The initramfs has (basically) one purpose in life -- getting the rootfs mounted so that we can transition to the real rootfs. This is all driven off of device availability. Therefore, instead of scripts hard-coded to do various things, we depend on udev to create device nodes for us and then when we have the rootfs's device node, we mount and carry on. This helps to keep the time required in the initramfs as little as possible so that things like a 5 second boot aren't made impossible as a result of the very existence of an initramfs.

Most of the initramfs generation functionality in dracut is provided by a bunch of generator modules that are sourced by the main dracut script to install specific functionality into the initramfs. They live in the modules.d subdirectory, and use functionality provided by dracut-functions to do their work.

Some general rules for writing modules:

  • Use one of the inst family of functions to actually install files on to the initramfs. They handle mangling the pathnames and (for binaries, scripts, and kernel modules) installing dependencies as appropriate so you do not have to.
  • Scripts that end up on the initramfs should be POSIX compliant. dracut will try to use /bin/dash as /bin/sh for the initramfs if it is available, so you should install it on your system -- dash aims for strict POSIX compliance to the extent possible.
  • Hooks MUST be POSIX compliant -- they are sourced by the init script, and having a bashism break your user's ability to boot really sucks.
  • Generator modules should have a two digit numeric prefix -- they run in ascending sort order. Anything in the 90-99 range is stuff that dracut relies on, so try not to break those hooks.
  • Hooks must have a .sh extension.
  • Generator modules are described in more detail in README.modules.
  • We have some breakpoints for debugging your hooks. If you pass 'rdbreak' as a kernel parameter, the initramfs will drop to a shell just before switching to a new root. You can pass 'rdbreak=hookpoint', and the initramfs will break just before hooks in that hookpoint run.

Also, there is an attempt to keep things as distribution-agnostic as possible. Every distribution has their own tool here and it's not something which is really interesting to have separate across them. So contributions to help decrease the distro-dependencies are welcome.

Currently dracut lives on github.com and kernel.org.

The tarballs can be found here: http://www.kernel.org/pub/linux/utils/boot/dracut/ ftp://ftp.kernel.org/pub/linux/utils/boot/dracut/

Git: git://git.kernel.org/pub/scm/boot/dracut/dracut.git http://git.kernel.org/pub/scm/boot/dracut/dracut.git https://git.kernel.org/pub/scm/boot/dracut/dracut.git

git@github.com:dracutdevs/dracut.git

Git Web: https://github.com/dracutdevs/dracut.git

    http://git.kernel.org/?p=boot/dracut/dracut.git

Project Documentation: http://www.kernel.org/pub/linux/utils/boot/dracut/dracut.html

Project Wiki: http://dracut.wiki.kernel.org

See the TODO file for things which still need to be done and HACKING for some instructions on how to get started. There is also a mailing list that is being used for the discussion -- initramfs@vger.kernel.org. It is a typical vger list, send mail to majordomo@vger.kernel.org with body of 'subscribe initramfs email@host.com'

Licensed under the GPLv2