diskimage-builder/diskimage_builder/elements/debootstrap
zhouxinyong 621cbfca26 fix some errors for ill-syntax in README.rst
Change-Id: I0daf36848e8ddb09fcae6cbd55f460a8e49d209c
2018-11-13 15:05:51 +08:00
..
cleanup.d Clean out apt index caches at end of image build 2017-04-09 11:57:23 -04:00
environment.d Move elements & lib relative to diskimage_builder package 2016-11-01 17:27:41 -07:00
install.d Allow debootstrap to cleanup without a kernel 2018-10-08 16:02:25 +11:00
root.d Replace architecture-emulation-binaries with qemu-debootstrap 2017-03-11 13:58:37 +00:00
README.rst fix some errors for ill-syntax in README.rst 2018-11-13 15:05:51 +08:00
element-deps Allow debootstrap to cleanup without a kernel 2018-10-08 16:02:25 +11:00
package-installs.yaml Drop support for Ubuntu precise 2017-05-31 14:36:30 +02:00
pkg-map Drop support for Ubuntu precise 2017-05-31 14:36:30 +02:00

README.rst

debootstrap

Base element for creating minimal debian-based images.

This element is incomplete by itself, you'll want to use elements like debian-minimal or ubuntu-minimal to get an actual base image.

There are two ways to configure apt-sources:

  1. 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://deb.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.

    By default only the 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.

  2. 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.

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