When setting parameters revolving around boot
mode, options, firmware, it is necessary to
extract and edit the XML document.
Some details, however, are not automatically
extracted and libvirt must be told to provide
secure information. This change prevents us
from accidently loosing such configuration
parameters
Story: 2010382
Task: 46651
Change-Id: I0da2f37c5b630d2a180f59b74f23c027ee56e17b
The current code logs the milliseconds twice:
2020-09-21 00:24:21,706.706 3484 DEBUG VirtualBMC [-] Get power...
The documentation for the logging module in py3 is quite
unambiguous about %(asctime) providing milliseconds.
The documentation in py2 is unclear on what is supposed
to offer, but in practice it works exactly as py3.
Change-Id: Ibb050c58d5fb949316700d7d2db4c77bd62f5e25
Now that we no longer support py27, we can use the standard library
unittest.mock module instead of the third party mock lib.
Change-Id: I436eab174b823c1e0e028529fed9009cc38776bc
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
The new version enables a lot of standard flake8 checks, so a few
fixes are required. W503 is disabled as it conflicts with W504
and the latter seems to be preferred nowadays.
Change-Id: Ic1efc86ec41daf6fadb4cebb8a73b4dd158f880a
The daemon child processes do not respond to a SIGTERM. This means that
they stay running indefinitely. This is because the manager process
installs a SIGTERM handler to propagate the signal to children, and this
handler is inherited by the children.
Return children to the default handler for SIGTERM.
Change-Id: I784e7cd9e0545a591150dc21a8232bd85672c21c
Story: 2003534
Task: 24819
Removes the backward compatibility feature of `vbmc` to
automatically start up `vbmcd` daemon process if it is not running.
From now on, `vbmcd` should be started by systemd or some other
mechanism.
Change-Id: I931751d7cdd591cae6f9a1bca8d72a4b3935a45f
Properly closes standard I/O streams to prevent shell-piped
processes from hanging infinitely on a dead pipe.
Change-Id: Id9dedac4f778cf37d626f2777d519f73cc4b5f2c
Story: 2007219
Task: 38471
Added `error` status to `vbmc list` and `vbmc start`
commands output. If the instance is failing to start, such
instance will be shown as being in `error` satte rather
than being `down`.
Change-Id: I3ad307f97442c6b30c3e60bd8186bfb30903c0b0
Story: 2006457
Task: 36378
Currently we log any exceptions as INFO and without much details.
Start logging them as ERROR with tracebacks. Add missing logging.
However, don't treat KeyboardInterrupt as an exception, just exit.
Also log the successful start-up, its absence is confusing.
Change-Id: I7464ce425ed05248152f264d64950e0ab1c0aec0
Add validation to fix error of "'<' not supported between
instances of 'str' and 'int'" when defining server_response_timeout
value in virtualbmc.conf. The error is trigger because the
config parameters from the configuration file are read as strings
and everything else assume that value is an integer (as the default of 5000).
The patch also include validations for server_spawn_wait and server_port to
check the values are valid integers.
Updates test_config.test_validate for test coverage
Task: 37947
Story: 2007066
Change-Id: Ie4e74585d8e14bd73e5e30b21b4dd7bd7d88f13d
Signed-off-by: William Caban <william.caban@gmail.com>
Virtualbmc is now Python 3 only, encoding for ET can be set to
unicode only.
Removing import sys from vbmc.py as it was used only for that
check.
Change-Id: I35ac19308337f9fb603efa5b8a3dc97aea234cbc
Since we've dropped support for Python 2.7, it's time to look at
the bright future that Python 3.x will bring and stop forcing
compatibility with older versions.
This patch removes the six library from requirements, not
looking back.
Change-Id: Iff319bfedc2c20c139419bb625aa5de83de93538
Adds the ability to override default configuration file location
by exporting the ``VIRTUALBMC_CONFIG`` variable, pointing to the
desired config file, into ``vbmcd`` and ``vbmc`` processes
environment.
Change-Id: I89f7cab09f4c0b2c1d2517c4b6f607ed291f235c
This helps preserving backward-compatible behaviour, as previous
implementation has required the user to explicitly "start" enabled
instances. With current virtualbmc, only the master process needs to
be started.
Change-Id: I3f95cdbd497f7ae3e06d37bb6afac17331f0469b
Since log messages interpolation is frequently postponed
till the logging time, occasional bugs in message
templates may go unnoticed.
This patch attempts to enable full logging in unit tests.
Unfortunately, exceptions caused by interpolation failures
get inhibited by the logging module code so they do not
actually fail tests. But at least those exceptions are
noticeable on stdout.
Change-Id: I1b32476c5bb631cef9b1269effd05a88a9fafd2d
When running with debug enabled, misnamed variable
in log message templates causes the whole app to
crash miserably. /o\
This patch makes vbmc immortal again.\o/
Change-Id: Ib863aea5699e16649a729f30d09ab4b1501d52ae
Apparently, variable interpolation in the log
messages turned out to be buggy and inconsistent.
This patch hopefully fixes all such issues and unifies
interpolation code across the project.
Change-Id: If49fd2d3c012a1792fe978c77a216a52fc52f6bf
This is a followup patch to [1] utilizing built-in tempfile module for
creating PID file securely.
1. https://review.openstack.org/#/c/488874
Change-Id: I419e68302995232dd12639d33821444ced9b1498
This is a followup patch to [1] making the `start` command accepting
multiple domain names in the same way as `stop` command does.
Possible duplicate domain names given on the command line removed
to avoid runtime errors.
1. https://review.openstack.org/#/c/488874
Change-Id: I48987d01187e4b4878e5d501d263e958be4e7693
This is a followup patch to [1] introducing configurable timing
parameters for the client to wait for automatic vbmcd start up and
vbmcd response timeout.
1. https://review.openstack.org/#/c/488874
Change-Id: Id1cdcecd8d407b31dc69166fb0fda555fc4a679f
This is a followup patch to [1] improve code style at multiple places.
1. https://review.openstack.org/#/c/488874
Change-Id: I38a87ecf7215cbf3ff4f94cefedc4f2a297e70f9
This is a followup patch to [1] addressing minor
fixes and improvements in the area of logging.
1. https://review.openstack.org/#/c/488874
Change-Id: I6c703b35c32644d8769a863fbe7940a002a185f0
Original design of the VirtualBMC tool was that user manages
config files for individual VirtualBMC (via a cli tool), then
requests the tool to start the instances representing
individual VirtualBMC instances (via the cli tool). Then
the instances become independent processes. The only way
to know their whereabouts is through the pidfiles
they maintain.
There were certain practical inconveniences with the
original design, namely:
* Cumbersome to start/stop/monitor free-standing
vBMC instances processes
* No two-way communication between the parent process
and the VirtualBMC instances what makes child state check
or modification unnecessary difficult
This commit turns server part of the tool into a single
process spawning multiple children processes and herding
them via ZMQ client/server.
The parent process runs server part of the control
interface, maintains persistent VirtualBMC instances
configuration and ensures all its children are alive
and kicking. Each VirtualBMC instance is still a separate
parent fork.
If child dies, parent respawns it right away. If parent
is about to die, it tries its best to kill all the
prospective orphans.
This new implementation tries to stay compatible with
the original one in part of `vbmc` tool CLI interface
and behaviour. Whenever it can't connect to the `vbmcd`
it tries to fork and spawn the daemon behind the scenes.
While the threading design for this tool might look better,
the underlying pyghmi library is apparently rather
complicated to use its concurrency capabilities reliably.
The other minor consideration is that running multiple
processes leverages CPU-based concurrency.
Other changes:
* The `start` command now accepts more than one domains
to be started
Change-Id: Ie10f4598c7039a7afa9b45d01df3b3c3db252c1d
Story: 1751570
Task: 12057
With pyghmi API, some methods return generic IPMI error
codes, while some return payload values. This patch fixes
the `get_power_state()` method to raise exception instead
of returning IPMI error code because the latter goes against
pyghmi API.
Change-Id: If30c1ee49982a7a1198a39a7afdc1edc2c516078
This reverts commit 9f7bfb9f6b.
It seems that the SOL feature introduced by patch [1] led to
the VirtualBMC daemons leaking two file descriptors (ends of
UNIX pipe, perhaps) per each IPMI query it processes. Given the
default ulimit of 1024 open files per process, in circa 500 IPMI
queries vbmc renders itself not quite functional.
The quick research of the problem reveals that the leak comes
to life once the virEventRegisterDefaultImpl() call is made
which prepares libvirt for asynchronous operations over a dedicated
connection to libvirtd. Even though once SOL session is gone and
libvirt is cleaned up (well, dedicated connection is closed),
the libvirt connection, which is open every time when IPMI query
comes in, leaks 2 FDs per query.
This problem has been reported about some other libvirt application
in the past [2] so the problem might go away if we turn the IPMI
part of vbmc to the asynchronous operation mode as well.
Another observation is that libvirt API may not [3] offer a full
clean up upon exiting from the asynchronous operation mode.
To summarize: the real cause of this behaviour is not yet properly
understood.
1. https://review.openstack.org/#/c/482853/
2. https://www.redhat.com/archives/libvir-list/2013-September/msg00019.html
3. https://github.com/libvirt/libvirt/blob/master/src/util/virevent.c#L224
Change-Id: Id599f62e0eaf8c96e4552d2cd263f93155f8afa6
Story: 2001976
Task: 19585
It seems that at times of high concurrency, libvirt
occassionally fails on supposedly some race condition
what leads to client failure (e.g. Ironic). This change
is to tell Ironic that it should try some more times rather
than bailing out right away.
Change-Id: I5848d721305c887fb7803ca4b302565aa4b83c88
Story: #2001798
Task: #15076
This patch adds some methods to support Serial-over-LAN capability.
We'll be able to connect serial console of a domain with
"ipmitool sol activate" command.
SOL capability requires a persistent libvirt connection, so this
patchset adds libvirt_open.get_conn() method and use it.
Change-Id: I7f9dfbd2b3eb1320be755bade2f97b9f0621d409
This patch replaces the use of argparse module
by the cliff package. The rationale is that
cliff infrastructure is easier to use and more
functional. Some other OpenStack projects seem
to migrate to cliff already.
Change-Id: Ib2185dad50e64de354222669d2e65f411ddc96a4
Closes-Bug: #1752911
"boot" entries under "devices/*" are mutually exclusive with those
under "os". If such entries are present, vbmc fails when adding "boot"
entry under "os".
Closes-Bug: #1746983
Change-Id: I357d3b8a92ee764e6f47f564fdef54d3a79f0782
There was usage of things like: return 0xd5
Change it to: return IPMI_COMMAND_NOT_SUPPORTED
Also give a pointer to the IPMI specification.
Change-Id: I7dbbe593fbf7f49aa5151bbff1678db63b5f172c
Some OpenStack installer such as [1] use power reset when switching
from bootstrap kernel to OS installation kernel. So we'd better
implement this.
[1] https://review.openstack.org/#/admin/projects/openstack/daisycloud-core
Change-Id: I60df3a31c7600d35d50212538fbfffd22bf7c729
Signed-off-by: Zhijiang Hu <hu.zhiiang@zte.com.cn>
Pierre Riteau