diskimage-builder/diskimage_builder/elements/dpkg
Amrith Kumar 43e32116bd fix readme.rst to reflect correct environment variable
The readme.rst incorrectly refers to the environment variable
DIB_APT_KEYS which should be DIB_ADD_APT_KEYS. See [1] for usage in
code.

This is a minor correction to the readme only, no runnable code is
modified.

[1] http://git.openstack.org/cgit/openstack/diskimage-builder/tree/diskimage_builder/elements/dpkg/extra-data.d/01-copy-apt-keys#n23

Change-Id: I04129cef9f40ec75a206c126bfd40ee61e4e6a2b
2017-07-06 22:54:08 -04: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 fix readme.rst to reflect correct environment variable 2017-07-06 22:54:08 -04:00

====
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_ADD_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_ADD_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.

.. element_deps::