openstack/diskimage-builder
Code Issues Proposed changes

Update dpkg elements README from free text to table formatting

Browse Source 
Change-Id: Iaf890c85b72f01999d3ae31398bdb65a356218e7
This commit is contained in:
Augustina Ragwitz 2015-08-31 10:35:30 -07:00
parent 12d71c6447
commit 2cffdcda30
1 changed files with 25 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
elements/dpkg/README.rst
View File

@ -13,14 +13,28 @@ The dpkg specific version of install-packages is also kept here.
Environment Variables Environment Variables
--------------------- ---------------------
* DIB\_ADD\_APT\_KEYS: If an extra or updated apt key is needed then define DIB_APT_KEYS
DIB\_ADD\_APT\_KEYS with the path to a folder. Any key files inside will be :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. 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 :Example: ``DIB_APT_KEYS=/etc/apt/trusted.gpg.d``
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 DIB_APT_LOCAL_CACHE
/var/cache/apt/archives, this to cache the .deb files downloaded during the image :Required: No
creation. :Default: 1
* At the end of a dib run we clean the apt cache to keep the image size as :Description: By default the ``$DIB_IMAGE_CACHE/apt/$DISTRO_NAME`` directory is
small as possible. You can set DIB\_DISABLE\_APT\_CLEANUP=1 if you would mounted in ``/var/cache/apt/archives`` to cache the .deb files downloaded
like to prevent this. 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.