97c01e48ed
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 |
||
|---|---|---|
| .. | ||
| cleanup.d | ||
| environment.d | ||
| extra-data.d | ||
| install.d | ||
| pre-install.d | ||
| root.d | ||
| element-deps | ||
| package-installs.yaml | ||
| pkg-map | ||
| README.rst | ||
==== base ==== This is the base element. Almost all users will want to include this in their disk image build, as it includes a lot of useful functionality. The `DIB_CLOUD_INIT_ETC_HOSTS` environment variable can be used to customize cloud-init's management of `/etc/hosts`: * If the variable is set to something, write that value as cloud-init's manage_etc_hosts. * If the variable is set to an empty string, don't create manage_etc_hosts setting (cloud-init will use its default value). * If the variable is not set, use "localhost" for now. Later, not setting the variable will mean using cloud-init's default. (To preserve diskimage-builder's current default behavior in the future, set the variable to "localhost" explicitly.) Notes: * If you are getting warnings during the build about your locale being missing, consider installing/generating the relevant locale. This may be as simple as having language-pack-XX installed in the pre-install stage * This element ensures /tmp/ccache will be available in the chroot during the root, extra-data, pre-install, install and post-install stages. /tmp/ccache is unavailable during block-device, finalise and cleanup stages as it will have been automatically unmounted by then.