Go to file
Martin Wilck ceca74ccc3 dracut-functions: add ip_params_for_remote_addr() helper
This helper function takes a remote IP address, and tries to
determine the dracut command line arguments ip= and ifname= that
will make this remote address reachable during boot.

Functionality was taken from the module-setup.sh scripts of 95iscsi and 95nfs,
cleaned up and fixed some issues in particular with statically configured
networks, where the old code would print the unsupported string
"$ifname:static".
2020-08-04 08:43:32 +02:00
.github/workflows CI: remove Fedora 30, add Fedora 32 2020-05-29 10:53:57 +02:00
dracut.conf.d Fix a missing space in example configs 2019-01-21 13:35:04 +01:00
examples/yocto Add documentation and Yocto examples 2019-10-25 11:58:58 +02:00
install install: also install post weak dependencies of kernel modules 2020-07-02 16:06:44 +02:00
modules.d 95nvmf: add NVMe over TCP support 2020-08-04 08:22:25 +02:00
skipcpio skipcpio/skipcpio.c: linux kernel only accepts "070701" signature 2015-07-07 13:44:13 +02:00
test TEST-99: exclude /etc/dnf/* from check 2020-04-09 22:11:16 +02:00
.dir-locals.el .dir-locals.el: changed to sane style 2017-01-16 14:27:39 +01:00
.gitignore tests: Ignore .testdir 2019-07-19 00:25:29 +02:00
.kateconfig add kate and emacs per directory config files 2014-08-29 13:38:47 +02:00
.kateproject kate config 2016-04-15 10:27:48 +02:00
.mailmap version 047 2018-02-19 10:00:33 +01:00
.travis.yml .travis.yml: reformat 2020-03-12 13:54:39 +01:00
50-dracut.install 50-dracut: synchronize option reading code with 51-dracut.install 2019-08-27 18:33:13 +02:00
51-dracut-rescue-postinst.sh Bring back 51-dracut-rescue-postinst.sh 2018-07-26 12:58:21 +02:00
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 COPYING: updated to recent version of http://www.gnu.org/licenses/gpl-2.0.txt 2012-08-01 15:53:25 +02:00
HACKING removed trailing whitespaces 2011-05-10 11:56:09 +02:00
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 PKGFILE: prevent out of tree builds 2015-11-08 12:57:33 +01:00
README.cross Add documentation and Yocto examples 2019-10-25 11:58:58 +02:00
README.generic removed trailing whitespaces 2011-05-10 11:56:09 +02:00
README.kernel
README.md Fix CI badges in README.md and fix dracut description 2020-05-29 16:15:42 +02:00
README.modules consistently lowercase "dracut" 2012-10-10 14:15:11 +02:00
README.testsuite Drop dependency on bridge-utils 2017-02-14 14:10:24 +01:00
TODO TODO: remove some items 2016-11-03 15:05:36 +01:00
configure configure: find cflags and libs for fts on musl 2019-11-10 01:47:30 +01:00
dracut-bash-completion.sh Remove obsolete prelinking functionality 2018-06-14 12:58:59 +02:00
dracut-catimages.8.asc replace xml documentation with asciidoc 2012-03-14 15:48:33 +01:00
dracut-catimages.sh remove all vim and emacs code format comments 2014-08-29 13:38:47 +02:00
dracut-functions.sh dracut-functions: add ip_params_for_remote_addr() helper 2020-08-04 08:43:32 +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-initramfs-restore: set selinux labels 2018-11-27 16:05:48 +01:00
dracut-logger.sh dracut.sh: only create one TMPDIR 2015-11-25 14:21:33 +01:00
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: remove example parameters 2015-07-09 15:36:25 +02:00
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 Doc: cleanup, extend and split and reuse 2013-10-08 15:13:12 +02:00
dracut.logrotate dracut.logrotate: remove "yearly" 2011-07-20 17:21:02 +02:00
dracut.modules.7.asc Documentation: dynamically set current version 2019-11-12 13:24:41 +01:00
dracut.png dracut.png: Optimize with zopflipng -m 2016-07-07 13:54:47 +03:00
dracut.sh dracut.sh: fix ia32 detection for uefi executables 2020-08-03 18:51:49 +02:00
dracut.spec 95nvmf: add module for NVMe-oF 2020-06-17 09:34:53 +02:00
dracut.svg
dracut.usage.asc Use eurlatgr as default console font 2019-10-21 13:07:07 +02:00
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 remove all vim and emacs code format comments 2014-08-29 13:38:47 +02:00
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-dracut.sh: use vmlinux regex for ppc*, vmlinuz for i686 2020-08-03 17:59:01 +02:00
mkinitrd-suse.8.asc Fix misspellings in man pages and usage 2018-08-30 13:12:00 +02:00
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 profile.py: do not count negative timestamp differences 2012-06-29 12:41:25 +02:00

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