diskimage-builder/diskimage_builder/elements/dracut-ramdisk
Ian Wienand 97c01e48ed Move elements & lib relative to diskimage_builder package
Currently we have all our elements and library files in a top-level
directory and install them into
<root>/share/diskimage-builder/[elements|lib] (where root is either /
or the root of a virtualenv).

The problem with this is that editable/development installs (pip -e)
do *not* install data_files.  Thus we have no canonical location to
look for elements -- leading to the various odd things we do such as a
whole bunch of guessing at the top of disk-image-create and having a
special test-loader in tests/test_elements.py so we can run python
unit tests on those elements that have it.

data_files is really the wrong thing to use for what are essentially
assets of the program.  data_files install works well for things like
config-files, init.d files or dropping documentation files.

By moving the elements under the diskimage_builder package, we always
know where they are relative to where we import from.  In fact,
pkg_resources has an api for this which we wrap in the new
diskimage_builder/paths.py helper [1].

We use this helper to find the correct path in the couple of places we
need to find the base-elements dir, and for the paths to import the
library shell functions.

Elements such as svc-map and pkg-map include python unit-tests, which
we do not need tests/test_elements.py to special-case load any more.
They just get found automatically by the normal subunit loader.

I have a follow-on change (I69ca3d26fede0506a6353c077c69f735c8d84d28)
to move disk-image-create to a regular python entry-point.

Unfortunately, this has to move to work with setuptools.  You'd think
a symlink under diskimage_builder/[elements|lib] would work, but it
doesn't.

[1] this API handles stuff like getting files out of .zip archive
modules, which we don't do.  Essentially for us it's returning
__file__.

Change-Id: I5e3e3c97f385b1a4ff2031a161a55b231895df5b
2016-11-01 17:27:41 -07:00
..
binary-deps.d Move elements & lib relative to diskimage_builder package 2016-11-01 17:27:41 -07:00
dracut-drivers.d Move elements & lib relative to diskimage_builder package 2016-11-01 17:27:41 -07:00
environment.d Move elements & lib relative to diskimage_builder package 2016-11-01 17:27:41 -07:00
extra-data.d/scripts/module Move elements & lib relative to diskimage_builder package 2016-11-01 17:27:41 -07:00
init.d Move elements & lib relative to diskimage_builder package 2016-11-01 17:27:41 -07:00
install.d Move elements & lib relative to diskimage_builder package 2016-11-01 17:27:41 -07:00
post-install.d Move elements & lib relative to diskimage_builder package 2016-11-01 17:27:41 -07:00
element-deps Move elements & lib relative to diskimage_builder package 2016-11-01 17:27:41 -07:00
pkg-map Move elements & lib relative to diskimage_builder package 2016-11-01 17:27:41 -07:00
README.rst Move elements & lib relative to diskimage_builder package 2016-11-01 17:27:41 -07:00
source-repository-dracut Move elements & lib relative to diskimage_builder package 2016-11-01 17:27:41 -07:00

==============
dracut-ramdisk
==============
Build Dracut-based ramdisks

This is an alternative to the `ramdisk` element that uses
Dracut to provide the base system functionality instead of
Busybox.

For elements that need additional drivers in the ramdisk image,
a dracut-drivers.d feature is included that works in a similar
fashion to the binary-deps.d feature.  The element needing to
add drivers should create a dracut-drivers.d directory and
populate it with a single file listing all of the kernel modules
it needs added to the ramdisk.  Comments are not supported in this
file.  Note that these modules must be installed in the chroot first.

By default, the virtio, virtio_net, and virtio_blk modules are
included so that ramdisks are able to function properly in a
virtualized environment.