diskimage-builder/elements/debian
Xiang Chen ff234b65ea Explain difference between two envvars
Explain difference between 'DIB_OFFLINE' and
 'DIB_DEBIAN_USE_DEBOOTSTRAP_CACHE'

Those variables are not redundant,they hava different effective ranges.
However,some people may be confused about this and reported a bug.
So,this difference should be writen in the README file.

Closes-Bug: #1506275

Change-Id: Ie5316de41d129bf98781708954f09ef0b2592b53
2016-08-25 10:07:29 +08:00
..
bin Standarise tracing for scripts 2015-02-12 10:41:32 +11:00
install.d Debian: dont set always the hostname to debian 2016-04-06 11:05:53 +02:00
test-elements/build-succeeds Fix apt-sources configuration for debian-minimal 2016-05-13 09:26:49 +02:00
element-deps Split the debootstrap functions into an element 2015-04-26 18:04:59 +00:00
element-provides Use provides to note an element provides an OS 2014-04-10 14:42:04 +01:00
package-installs.yaml Fix debian-minimal image building 2016-01-28 16:41:35 +03:00
README.rst Explain difference between two envvars 2016-08-25 10:07:29 +08:00

debian

Create an image based on Debian. We default to unstable but DIB_RELEASE is mapped to any series of Debian.

Note that the default Debian series is unstable, and the default mirrors for Debian can be problematic for unstable. Because apt does not handle changing Packages files well across multiple out of sync mirrors, it is recommended that you choose a single mirror of debian, and pass it in via DIB_DISTRIBUTION_MIRROR.

If necessary, a custom apt keyring and debootstrap script can be supplied to the debootstrap command via DIB_APT_KEYRING and DIB_DEBIAN_DEBOOTSTRAP_SCRIPT respectively. Both options require the use of absolute rather than relative paths.

Use of this element will also require the tool 'debootstrap' to be available on your system. It should be available on Ubuntu, Debian, and Fedora.

The DIB_OFFLINE or more specific DIB_DEBIAN_USE_DEBOOTSTRAP_CACHE variables can be set to prefer the use of a pre-cached root filesystem tarball.

The DIB_DEBOOTSTRAP_EXTRA_ARGS environment variable may be used to pass extra arguments to the debootstrap command used to create the base filesystem image. If --keyring is is used in DIB_DEBOOTSTRAP_EXTRA_ARGS, it will override DIB_APT_KEYRING if that is used as well.

For further information about DIB_DEBIAN_DEBOOTSTRAP_SCRIPT , DIB_DEBIAN_USE_DEBOOTSTRAP_CACHE and DIB_DEBOOTSTRAP_EXTRA_ARGS please consult "README.rst" of the debootstrap element.

Note on ARM systems

Because there is not a one-to-one mapping of ARCH to a kernel package, if you are building an image for ARM on debian, you need to specify which kernel you want in the environment variable DIB_ARM_KERNEL. For instance, if you want the linux-image-mx5 package installed, set DIB_ARM_KERNEL to mx5.