diskimage-builder

History

Ian Wienand fb942b752d Use strings in package-installs follow output I noticed in debugging that with python3 all the pkg-installs output is preceeded by a b'foo', which suggests coding issues lurking. The universal_newlines argument makes subprocess readline() returns a decoded str (via locale) instead of a byte-string. This clears up a couple of points where we explicitly decode and cleans up the print output. Minor formatting cleanup of command and exit display. Don't strip the leading spaces so indents retain in the output Change-Id: I2894f10a0c2fc618563641b9d106b716f4a544aa		2017-01-18 19:26:40 +11:00
..
bin	Use strings in package-installs follow output	2017-01-18 19:26:40 +11:00
extra-data.d	Prioritize venv python on host	2016-02-28 20:50:02 -08:00
install.d	Package installs defaults to tracing off	2015-12-20 00:03:51 +00:00
post-install.d	Reorder the package-uninstall action	2016-02-11 18:30:05 -06:00
pre-install.d	Package installs defaults to tracing off	2015-12-20 00:03:51 +00:00
element-deps	Add install-bin element	2016-05-13 11:52:23 +10:00
README.rst	Allow package-installs to parse DIB_PYTHON_VERSION	2016-12-14 12:13:40 +11:00

README.rst

================
package-installs
================

The package-installs element allows for a declarative method of installing and
uninstalling packages for an image build. This is done by creating a
package-installs.yaml or package-installs.json file in the element directory.

In order to work on Gentoo hosts you will need to manually install
`dev-python/pyyaml`.

example ``package-installs.yaml``

.. code-block:: YAML

  libxml2:
  grub2:
    phase: pre-install.d
  networkmanager:
    uninstall: True
  os-collect-config:
    installtype: source
  linux-image-amd64:
    arch: amd64
  dmidecode:
    not-arch: ppc64, ppc64le
  lshw:
    arch: ppc64, ppc64le
  python-dev:
    dib_python_version: 2
  python3-dev:
    dib_python_version: 3

example package-installs.json

.. code-block:: json

    {
    "libxml2": null,
    "grub2": {"phase": "pre-install.d"},
    "networkmanager": {"uninstall": true}
    "os-collect-config": {"installtype": "source"}
    }


Setting phase, uninstall, or installtype properties for a package overrides
the following default values::

    phase: install.d
    uninstall: False
    installtype: * (Install package for all installtypes)
    arch: * (Install package for all architectures)
    dib_python_version: (2 or 3 depending on DIB_PYTHON_VERSION, see dib-python)

Setting the installtype property causes the package only to be installed if
the specified installtype would be used for the element. See the
diskimage-builder docs for more information on installtypes.

The ``arch`` property is a comma-separated list of architectures to
install for.  The ``not-arch`` is a comma-separated list of
architectures the package should be excluded from.  Either ``arch`` or
``not-arch`` can be given for one package - not both.  See
documentation about the ARCH variable for more information.

DEPRECATED: Adding a file under your elements pre-install.d, install.d, or
post-install.d directories called package-installs-<element-name> will cause
the list of packages in that file to be installed at the beginning of the
respective phase.  If the package name in the file starts with a "-", then
that package will be removed at the end of the install.d phase.

Using post-install.d for cleanup
================================

Package removal is done in post-install.d at level 95.  If you a
running cleanup functions before this, you need to be careful not
to clean out any temporary files relied upon by this element.
For this reason, generally post-install cleanup functions should
occupy the higher levels between 96 and 99.