Go to file
Harald Hoyer 821e08da03 fedora-test-github.sh: only fetch tags, if building rpm 2020-03-04 11:06:04 +01:00
.github/workflows .github/workflows: bump timeout to 45min 2020-03-04 09:23:46 +01: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 dracut_mkdir(): create parent directories as needed. 2020-03-02 14:48:11 +01:00
modules.d Consider also drm_dev_register when looking for gpu driver 2020-03-04 10:41:04 +01:00
skipcpio skipcpio/skipcpio.c: linux kernel only accepts "070701" signature 2015-07-07 13:44:13 +02:00
test TEST-04-FULL-SYSTEMD: use seperate marker disk for root creation 2020-03-03 16:56:43 +01: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: add note about test container 2020-02-28 12:53:42 +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 50-dracut: synchronize option reading code with 51-dracut.install 2019-08-27 18:33:13 +02:00
AUTHORS AUTHORS: update 2018-10-08 15:31:49 +02: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: fix RPM build 2020-02-28 16:31:43 +01:00
NEWS NEWS: update 2018-10-08 15:31:08 +02: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 Version 006 2010-06-17 10:58:27 +02:00
README.md Add github workflow 2020-02-27 15:27:30 +01: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 Allow running on a cross-compiled rootfs 2019-10-25 11:58:58 +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 network/net-lib.sh: Configure all iBFT interfaces 2020-02-14 10:42:34 +01:00
dracut.conf dracut.conf: remove example parameters 2015-07-09 15:36:25 +02:00
dracut.conf.5.asc Support the EFI Stub loader's splash image feature. 2020-02-20 11:03:30 +01: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 Merge branch 'master' into regenerate_all 2020-03-03 19:25:16 +01:00
dracut.spec spec: dracut-network is happy with either NM or dhclient 2019-11-12 13:11:40 +01:00
dracut.svg added dracut logo 2010-12-02 17:13:04 +01:00
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 Make lsinitrd usable for images made with Debian mkinitramfs 2020-03-03 12:48:58 +01:00
mkinitrd-dracut.sh Allow running on a cross-compiled rootfs 2019-10-25 11:58:58 +02:00
mkinitrd-suse.8.asc Fix misspellings in man pages and usage 2018-08-30 13:12:00 +02:00
mkinitrd-suse.sh Allow running on a cross-compiled rootfs 2019-10-25 11:58:58 +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-30 Fedora-31

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 existing initramfs's, this is an attempt at having as little as possible hard-coded into the initramfs as possible. 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. It's likely that we'll grow some hooks for running arbitrary commands in the flow of the script, but it's worth trying to resist the urge as much as we can as hooks are guaranteed to be the path to slow-down.

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