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
This commit is contained in:
Eduardo Santos 2021-08-27 02:22:08 -03:00
parent a6ee4d0c21
commit 5779fa8525
2 changed files with 18 additions and 4 deletions

View File

@ -6,10 +6,18 @@ The ``ubuntu-minimal`` element uses debootstrap for generating a
minimal image. In contrast the ``ubuntu`` element uses the cloud-image
as the initial base.
By default this element creates the latest LTS release. The exact
setting can be found in the 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::
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+.

View File

@ -0,0 +1,6 @@
---
fixes:
- |
Added a note about a known issue with debootstrap versions when building
the ubuntu-minimal element and added a reference to where exactly to find
the DIB_RELEASE variable.