openstack/diskimage-builder
Code Issues Proposed changes
f0b70211c6
diskimage-builder/diskimage_builder/elements/dpkg
History
Andreas Florath fdd2c4b236 Semi-automatic doc generation of element dependency 
Currently there is no description of dependencies in the generated
documentation of the elements: therefore a user of an element does not
know which other elements are automatically included and e.g. which
configuration options are available. In addition there are some
copy&pastes of parts of the README.rst scattered thought different
Ubuntu and Debian specific elements.

This patch adds a semi-automatic generation of dependency information
of all elements.  Nevertheless these are not automatically included.
The author of the element's README.rst can decide if and where the
dependency information should appear and can use the descriptor

.. element_deps::

for this.

This patch adds the dependency information for some Debian and
Ubuntu patches - and creates the base for later removing the
duplicated parts.

A call is added to element_dependencies._find_all_elements() to
populate reverse dependencies for Element objects.

(This is a reworking of I31d2b6050b6c46fefe37378698e9a330025db430 for
the feature/v2 branch)

Change-Id: Iebb83916fed71565071246baa550849eef40560b
2017-02-09 09:50:30 +11:00
..
bin Move elements & lib relative to diskimage_builder package 2016-11-01 17:27:41 -07:00
cleanup.d Move elements & lib relative to diskimage_builder package 2016-11-01 17:27:41 -07:00
extra-data.d Move elements & lib relative to diskimage_builder package 2016-11-01 17:27:41 -07:00
finalise.d Move elements & lib relative to diskimage_builder package 2016-11-01 17:27:41 -07:00
pre-install.d Move elements & lib relative to diskimage_builder package 2016-11-01 17:27:41 -07:00
root.d Release 1.24.0 2017-01-31 14:14:19 +11:00
element-deps Move elements & lib relative to diskimage_builder package 2016-11-01 17:27:41 -07:00
README.rst Semi-automatic doc generation of element dependency 2017-02-09 09:50:30 +11:00

README.rst

dpkg

Provide dpkg specific image building glue.

The ubuntu element needs customisations at the start and end of the image build process that do not apply to RPM distributions, such as using the host machine HTTP proxy when installing packages. These customisations live here, where they can be used by any dpkg based element.

The dpkg specific version of install-packages is also kept here.

Environment Variables

DIB_APT_KEYS
Required

No

Default

None

Description

If an extra or updated apt key is needed then define DIB_ADD_APT_KEYS with the path to a folder. Any key files inside will be added to the key ring before any apt-get commands take place.

Example

DIB_APT_KEYS=/etc/apt/trusted.gpg.d

DIB_APT_LOCAL_CACHE
Required

No

Default

1

Description

By default the $DIB_IMAGE_CACHE/apt/$DISTRO_NAME directory is mounted in /var/cache/apt/archives to cache the .deb files downloaded during the image creation. Use this variable if you wish to disable the internal cache of the /var/cache/apt/archives directory

Example

DIB_APT_LOCAL_CACHE=0 will disable internal caching.

DIB_DISABLE_APT_CLEANUP
Required

No

Default

0

Description

At the end of a dib run we clean the apt cache to keep the image size as small as possible. Use this variable to prevent cleaning the apt cache at the end of a dib run.

Example

DIB_DISABLE_APT_CLEANUP=1 will disable cleanup.