openstack
/
ironic-python-agent
Code Issues Proposed changes

[doc] How to pause the IPA for debugging 

This patch adds two handy methods to pause the IPA when it needs
to be debugged.

Change-Id: I6ab4d6707fce340ee447355c717b19a12f3fe1ec
This commit is contained in:
Arne Wiebalck 2020-02-28 10:58:44 +01:00
parent add4d03349
commit b5e25760af
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/source/admin/troubleshooting.rst
View File

@ -99,6 +99,20 @@ repository by default auto-logins the default
Tiny Core Linux user ``tc`` to the console.
This user has no password and has password-less ``sudo`` permissions.
How to pause the IPA for debugging
----------------------------------
When debugging issues with the IPA, in particular with cleaning, it may be
necessary to log in to the RAM disk before the IPA actually starts (and delay
the launch of the IPA). One easy way to do this is to set ``maintenance``
on the node and then trigger cleaning. Ironic will boot the node into the
RAM disk, but the IPA will stall until the maintenance state is removed. This
opens a time window to log into the node.
Another way to do this is to add simple cleaning steps in a custom hardware
manager which sleep until a certain condition is met, e.g. until a given
file exists. Having multiple of these "barrier steps" allows to go through the
cleaning steps and have a break point in between them.
Set IPA to debug logging
========================
Debug logging can be enabled a several different ways. The easiest way is to