You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Daniel Molkentin e473057ae1 Update AUTHORS, NEWS 3 years ago
.github Adding stalebot file 3 years ago
dracut.conf.d Fix a missing space in example configs 5 years ago
examples/yocto Add documentation and Yocto examples 5 years ago
install dracut-install: Globbing support for resolving "firmware:" 4 years ago
modules.d Revert "Retrieve service, rpc and protcol entries via getent in hostonly mode" 3 years ago
skipcpio skipcpio/skipcpio.c: linux kernel only accepts "070701" signature 9 years ago
test TEST-99: exclude /etc/dnf/* from check 4 years ago
.dir-locals.el .dir-locals.el: changed to sane style 7 years ago
.gitignore tests: Ignore .testdir 5 years ago
.kateconfig add kate and emacs per directory config files 10 years ago
.kateproject kate config 8 years ago
.mailmap Update AUTHORS, NEWS 3 years ago
.travis.yml .travis.yml: reformat 4 years ago
50-dracut.install 50-dracut: synchronize option reading code with 51-dracut.install 5 years ago
51-dracut-rescue.install 51-dracut-rescue.install: Don't use BLS fragment shipped by kernel package 4 years ago
AUTHORS Update AUTHORS, NEWS 3 years ago
COPYING COPYING: updated to recent version of http://www.gnu.org/licenses/gpl-2.0.txt 12 years ago
HACKING removed trailing whitespaces 13 years ago
Makefile Makefile: really make externally defined CFLAGS work 4 years ago
NEWS Update AUTHORS, NEWS 3 years ago
PKGBUILD PKGFILE: prevent out of tree builds 9 years ago
README.cross Add documentation and Yocto examples 5 years ago
README.generic removed trailing whitespaces 13 years ago
README.kernel Version 006 14 years ago
README.md Fix CoC URL 4 years ago
README.modules consistently lowercase "dracut" 12 years ago
README.testsuite Drop dependency on bridge-utils 7 years ago
TODO TODO: remove some items 8 years ago
configure configure: Find FTS library with --as-needed 4 years ago
dracut-bash-completion.sh Revert "Add --uefi-output for custom output filename" 4 years ago
dracut-catimages.8.asc replace xml documentation with asciidoc 12 years ago
dracut-catimages.sh remove all vim and emacs code format comments 10 years ago
dracut-functions.sh dracut-init.sh: Add a helper for detect device kernel modules 4 years ago
dracut-init.sh Don't print when a module is explicitly omitted (by default) 4 years ago
dracut-initramfs-restore.sh dracut-initramfs-restore: set selinux labels 6 years ago
dracut-logger.sh dracut.sh: only create one TMPDIR 9 years ago
dracut.8.asc Update AUTHORS, NEWS 3 years ago
dracut.asc Documentation: dynamically set current version 5 years ago
dracut.bootup.7.asc Documentation: dynamically set current version 5 years ago
dracut.cmdline.7.asc Improve documentation of iso-scan/filename feature 4 years ago
dracut.conf dracut.conf: remove example parameters 9 years ago
dracut.conf.5.asc Revert "Add --uefi-output for custom output filename" 4 years ago
dracut.css Doc: cleanup, extend and split and reuse 11 years ago
dracut.logrotate dracut.logrotate: remove "yearly" 13 years ago
dracut.modules.7.asc Document initqueue/online hook 4 years ago
dracut.png dracut.png: Optimize with zopflipng -m 8 years ago
dracut.sh Revert "Add --uefi-output for custom output filename" 4 years ago
dracut.spec Drop 51-dracut-rescue-postinst.sh entirely 3 years ago
dracut.svg added dracut logo 14 years ago
dracut.usage.asc Use eurlatgr as default console font 5 years ago
fedora-test-github.sh fedora-test-github.sh: only fetch tags, if building rpm 4 years ago
fedora-test.sh test: build docs when running TEST-99-RPM 4 years ago
git2spec.pl git2spec: include contents of binaries in patches 5 years ago
logtee.c logtee: time out after a period of no output 5 years ago
lsinitrd-bash-completion.sh remove all vim and emacs code format comments 10 years ago
lsinitrd.1.asc Documentation: dynamically set current version 5 years ago
lsinitrd.sh Fix test in lsinitrd 4 years ago
mkinitrd-dracut.sh mkinitrd-dracut.sh: use vmlinux regex for ppc*, vmlinuz for i686 4 years ago
mkinitrd-suse.8.asc Fix misspellings in man pages and usage 6 years ago
mkinitrd-suse.sh mkinitrd-suse.sh: Fix i586 platform detection 4 years ago
mkinitrd.8.asc Documentation: dynamically set current version 5 years ago
profile.py profile.py: do not count negative timestamp differences 12 years ago

README.md

dracut

dracut is an event driven initramfs infrastructure.

Contributor Covenant 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