diskimage-builder/elements/dpkg/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\_ADD\_APT\_KEYS: 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.
* DIB\_APT\_LOCAL\_CACHE: You can use this variable to disable the internal cache
  of the /var/cache/apt/archives directory by setting it to 0. The default is to bind
  mount the $DIB_IMAGE_CACHE/apt/$DISTRO_NAME directory in
  /var/cache/apt/archives, this to cache the .deb files downloaded during the image
  creation.
Create docs site containing element READMEs We currently do not have the ability to create a docs site which outlines all the elements. Change-Id: I77ccf61e0c4b1509b3e7ce9b8f15ea5ccfd50d9b 2015-02-07 10:30:02 +00:00			`====`
			`dpkg`
			`====`
Move the dpkg specific stuff to a dpkg element rather than being hardcoded. This includes the install-packages implementation for dpkg, apt http proxy config, daemon blocking and unblocking. Change-Id: I8f159021d2b223d7003cec067de3aa605ad06974 2013-02-13 22:16:00 +00:00			`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.`
Add ability to add extra apt keys Adds an environment variable DIB_ADD_APT_KEYS pointing to a folder of apt repo GPG keys. Each key will be verified and installed with apt-key to the apt keyring. Change-Id: I4b15347a76aa3241e741931bb94f17598641ae42 2014-03-27 21:49:43 +00:00
dpkg: local cache for .deb files With this patch, /var/cache/apt/archives directory content is preserved. The directory is actually a bind mount of the ~/.cache/image-create/apt/$DISTRO_NAME directory, much like what we do for ccache. You can use DIB_APT_LOCAL_CACHE=0 to disable this behavior. This trivial change improve performance A LOT (>30%), even if a local HTTP proxy because: - there is no need to copy again and again the same files - we avoid network latency The patch has been tested with Debian and Ubuntu with every elements from the tripleo-image-elements repository, the final size of the cache directory is about 700MB per distribution subdirectory. Change-Id: I4fab499493f734c7c546d4d23b1a98f0e7523a39 2014-05-31 13:50:52 +00:00			`### Environment Variables ###`

			`* DIB\_ADD\_APT\_KEYS: 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.`
			`* DIB\_APT\_LOCAL\_CACHE: You can use this variable to disable the internal cache`
			`of the /var/cache/apt/archives directory by setting it to 0. The default is to bind`
Use DIB_IMAGE_CACHE in dpkg element The dpkg element was hardcoding ~/.cache/image-create as the cache path, but elements should use DIB_IMAGE_CACHE as the root for the cache to allow users to override the path. Replace the hardcoded path with one that is rooted at $DIB_IMAGE_CACHE. Change-Id: I76030654e7dfc7b7d4dfa87e082c14e7cee479b9 2015-01-13 22:22:10 +00:00			`mount the $DIB_IMAGE_CACHE/apt/$DISTRO_NAME directory in`
dpkg: local cache for .deb files With this patch, /var/cache/apt/archives directory content is preserved. The directory is actually a bind mount of the ~/.cache/image-create/apt/$DISTRO_NAME directory, much like what we do for ccache. You can use DIB_APT_LOCAL_CACHE=0 to disable this behavior. This trivial change improve performance A LOT (>30%), even if a local HTTP proxy because: - there is no need to copy again and again the same files - we avoid network latency The patch has been tested with Debian and Ubuntu with every elements from the tripleo-image-elements repository, the final size of the cache directory is about 700MB per distribution subdirectory. Change-Id: I4fab499493f734c7c546d4d23b1a98f0e7523a39 2014-05-31 13:50:52 +00:00			`/var/cache/apt/archives, this to cache the .deb files downloaded during the image`
			`creation.`