From 3272b5478ba2bc0dbdbe2a3aa0323bb100f4d21c Mon Sep 17 00:00:00 2001 From: Dmitry Tantsur Date: Mon, 20 Jun 2022 14:08:49 +0200 Subject: [PATCH] Document building an image with patches Change-Id: Ice5ffaa0b8eea9afacc58c64dcfdaa58d3147a26 --- doc/source/contributor/index.rst | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst index e7efc80..7d43b84 100644 --- a/doc/source/contributor/index.rst +++ b/doc/source/contributor/index.rst @@ -3,3 +3,31 @@ =========================== .. include:: ../../../CONTRIBUTING.rst + +Testing changes in DIB images +============================= + +Testing a local ironic-python-agent change in :doc:`/admin/dib` requires +rebuilding an image with the following procedure. + +#. Make sure your changes are committed to your local repository. DIB needs to + know a branch name to use (``my-test-branch`` in the example below). + +#. Build an image as described in :doc:`/admin/dib`, providing a location of + your local repository and the branch name, for example: + + .. code-block:: bash + + DIB_REPOLOCATION_ironic_python_agent=/home/user/path/to/repo \ + DIB_REPOREF_ironic_python_agent=my-test-branch \ + ironic-python-agent-builder -o my-ipa --release 9-stream centos + +#. A similar process (with one additional variable) can be used for ironic-lib + changes: + + .. code-block:: bash + + DIB_REPOLOCATION_ironic_lib=/home/user/path/to/repo \ + DIB_REPOREF_ironic_lib=my-test-branch \ + IRONIC_LIB_FROM_SOURCE=true \ + ironic-python-agent-builder -o my-ipa --release 9-stream centos