fdd2c4b236
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
3.1 KiB
debian-minimal
Create a minimal image based on Debian. We default to unstable but DIB_RELEASE can be set to any series of Debian.
There are two ways to configure apt-sources:
Using the standard way of defining the default, backports, updates and security repositories is the default. In this case you can overwrite the two environment variables to adapt the behavior: `DIB_DISTRIBUTION_MIRROR`: the mirror to use default: http://ftp.us.debian.org/debian `DIB_DEBIAN_COMPONENTS`: (default) main a comma separated list of components. For Debian this can be e.g. main,contrib,non-free.
Note it is not recommended to use http://httpredir.debian.org/ for DIB_DISTRIBUTION_MIRROR due to how unreliable it is. Be sure to select a mirror from the official mirror list:
By default only main component is used. If DIB_DEBIAN_COMPONENTS (comma separated) from the debootstrap element has been set, that list of components will be used instead.
Backports, updates and security are included unless DIB_RELEASE is unstable.
Complete configuration given in the variable DIB_APT_SOURCES_CONF. Each line contains exactly one entry for the sources.list.d directory. The first word must be the logical name (which is used as file name with .list automatically appended), followed by a colon :, followed by the complete repository specification. Example: DIB_APT_SOURCES_CONF= "default:deb http://10.0.0.10/ stretch main contrib mysecurity:deb http://10.0.0.10/ stretch-security main contrib"
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. It is also recommended that the 'debian-keyring' package be installed.
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.