From 5779fa85256ebe35896c220714eb755844f564d3 Mon Sep 17 00:00:00 2001 From: Eduardo Santos Date: Fri, 27 Aug 2021 02:22:08 -0300 Subject: [PATCH] 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 --- .../elements/ubuntu-minimal/README.rst | 16 ++++++++++++---- ...ove-ubuntu-minimal-docs-b4c20a37a4daea2f.yaml | 6 ++++++ 2 files changed, 18 insertions(+), 4 deletions(-) create mode 100644 releasenotes/notes/improve-ubuntu-minimal-docs-b4c20a37a4daea2f.yaml diff --git a/diskimage_builder/elements/ubuntu-minimal/README.rst b/diskimage_builder/elements/ubuntu-minimal/README.rst index 2259d54d..e9188232 100644 --- a/diskimage_builder/elements/ubuntu-minimal/README.rst +++ b/diskimage_builder/elements/ubuntu-minimal/README.rst @@ -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 `_ +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+. diff --git a/releasenotes/notes/improve-ubuntu-minimal-docs-b4c20a37a4daea2f.yaml b/releasenotes/notes/improve-ubuntu-minimal-docs-b4c20a37a4daea2f.yaml new file mode 100644 index 00000000..dcdb4bd2 --- /dev/null +++ b/releasenotes/notes/improve-ubuntu-minimal-docs-b4c20a37a4daea2f.yaml @@ -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.