diskimage-builder/diskimage_builder/elements/ubuntu-minimal
Eduardo Santos 5779fa8525 General improvements to the ubuntu-minimal docs
This change:
- adds a note regarding an error when building focal ubuntu-minimal
  images on operating systems with older versions of debootstrap
- adds a reference to where the DIB_RELEASE variable definition can be
  found

Closes-Bug: #1941831
Change-Id: Ibc1e04dba0562c4f4909a8cb8af041d9b8ac45c4
2022-01-21 19:21:00 -03:00
..
environment.d Add 'DIB_UBUNTU_MIRROR_DISTS' to ubuntu-minimal 2021-01-27 10:32:49 +02:00
root.d Mount /sys RO 2021-07-05 11:45:02 +10:00
test-elements ubuntu-minimal: Add Ubuntu Focal test build 2020-05-21 14:03:54 +10:00
element-deps Merge branch 'master' into merge-branch 2017-02-09 13:35:53 +11:00
element-provides Move elements & lib relative to diskimage_builder package 2016-11-01 17:27:41 -07:00
package-installs.yaml Revert "Revert "ubuntu-minimal : only install 16.04 HWE kernel on xenial"" 2020-05-27 06:18:02 +10:00
README.rst General improvements to the ubuntu-minimal docs 2022-01-21 19:21:00 -03:00

==============
ubuntu-minimal
==============

The ``ubuntu-minimal`` element uses debootstrap for generating a
minimal image. In contrast the ``ubuntu`` element uses the cloud-image
as the initial base.

.. note::

   You will need to install a working debootstrap for diskimage-builder. The
   version you install may not support all Debian and Ubuntu releases that you
   want to bootstrap. Consider using the zuul/nodepool-builder docker image
   instead as maximum compatibility is attempted there.

By default this element creates the latest LTS release.  The exact setting can
be found in the `ubuntu-common <https://docs.openstack.org/diskimage-builder/latest/elements/ubuntu-common/README.html>`_
element's ``environment.d`` directory in the variable ``DIB_RELEASE``.  If a
different release of Ubuntu should be created, the variable ``DIB_RELEASE`` can
be set appropriately.

Note that this element installs ``systemd-sysv`` as the init system for
18.04+.

Environment Variables
---------------------

DIB_UBUNTU_KERNEL:
  :Required: No
  :Default: ``linux-image-generic``
  :Description: Specifies the kernel meta package to install in the image.
  :Example: ``DIB_UBUNTU_KERNEL=linux-image-kvm``
  :Options: ``linux-image-generic``, ``linux-image-kvm``,
            ``linux-image-virtual``
  :Notes: The element must know about the package, otherwise it will select
          the default.


DIB_UBUNTU_MIRROR_DISTS:
  :Required: No
  :Default: ``updates,security,backports``
  :Description:  Allow to manage 'dists' repos
  :Example: ``DIB_UBUNTU_MIRROR_DISTS=updates,security``
  :Notes: For some deployment,
          is may be required to disable backport|update|etc packages integration.

.. element_deps::