openstack
/
ironic-python-agent-builder
Code Issues Proposed changes

Merge "Document building an image with patches"

This commit is contained in:
Zuul 2022-07-18 17:26:01 +00:00 committed by Gerrit Code Review
parent 9d5ce06ac0 3272b5478b
commit a63bb7081c
1 changed files with 28 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
doc/source/contributor/index.rst
View File

@ -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