Commit Graph

20 Commits

Author SHA1 Message Date
Jay Faulkner e6fa558879 Bugs are now in Launchpad, update docs to reflect
Update docs to reflect bugs being in LP now.

Change-Id: Ibe43fe463af1d7a3998acaa8b6c985b068249f91
2023-05-18 07:12:30 -07:00
wangjiaqi07 7aac77d406 remove unicode from code
Change-Id: Id68c3c917acaef59f5cb92dea035d0e104c92a57
2022-08-24 20:29:21 +08:00
Iury Gregory Melo Ferreira 122f4ba5db Add doc/requirements
We need to specify doc requirements in doc/requirements.txt
to avoid problems with the pip resolver for the release team.
Removed specific doc requirements from test-requirements.txt

Change-Id: Ib2570e01bef426c0e5ecfd59249d08ea00749b28
2021-01-04 18:19:04 +01:00
Amy Marrich (spotz) 9d0750a5f6 Correct vmbc add command
Command example had an extra node-01 so failed

Change-Id: I6eabf05707ca33049a81bf04f7b76e89246451be
2020-07-30 13:41:59 -05:00
Andreas Jaeger e9854ff408 Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.

Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.

openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: I20ea481c1dd9651258b8ae13da9b1e1ec710482b
2020-05-25 09:43:04 +00:00
Kaifeng Wang e3681c1390 Build pdf doc
The is one of community goals that each project could produce a
single PDF file. The pdf should be in the output of openstack-tox-docs
job.

TeX packages are required to build PDF locally, following is recommended:

* inkscape
* texlive-latex-base
* texlive-latex-extra
* texlive-fonts-recommended

More about the goal:
https://governance.openstack.org/tc/goals/train/pdf-doc-generation.html
https://etherpad.openstack.org/p/train-pdf-support-goal
https://etherpad.openstack.org/p/pdf-goal-train-common-problems

Change-Id: I5f2caba62595946f8ade6db22a1aba080b927fc8
2019-09-06 10:36:22 +08:00
chenxing 2c76dc8c62 Tiny fix for documentation RST convention
Change-Id: I6a458a84808be46e74c543573d14e9335626ecc6
2019-08-29 14:24:23 +08:00
Ilya Etingof 71d16192d3 Reword config file search logic in the docs
This is a follow up to Change-Id: 651202

Change-Id: Id41a302d4ae233a20578686433fd8f3da56e69b9
2019-05-10 10:25:10 +02:00
Ilya Etingof 216b60c961 Respect VIRTUAL_BMC for non-default config path
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
2019-05-09 11:02:08 +02:00
Ilya Etingof 6d9c5ed424 Tolerate missing openstackdocstheme in docs
Change-Id: I658d08fdb0e9946a660b079571b406d935e34441
2018-09-20 23:04:09 +02:00
Ilya Etingof 036e36128e Improve the documentation
This is a followup patch to [1] addressing minor
fixes and improvements in the documentation.

1. https://review.openstack.org/#/c/488874

Change-Id: I20f020feecf3e7d97ed6771d2061a12834ea5250
2018-06-14 21:26:49 +02:00
Ilya Etingof 7ace4293e9 multiprocess server, ZMQ-based management cli tool
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
2018-05-11 17:29:47 +02:00
Ilya Etingof 189457ba9d Unrevert usage example inconsistency fix in docs
Change-Id: Ia20056819c3ebeb0a746e4de4be34287f615379e
Story: 2001976
Task: 19585
2018-05-09 12:53:35 +02:00
Ilya Etingof 30e168e792 Revert "Add Serial-over-LAN (SOL) support"
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
2018-05-09 11:53:57 +02:00
Akira Yoshiyama 9f7bfb9f6b Add Serial-over-LAN (SOL) support
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
2018-03-20 23:35:37 +09:00
Arundhati Surpur 99a0277970 Removes unnecessary utf-8 encoding
This patches removes unnecessary utf-8
encoding in doc/source/conf.py

Change-Id: I6fe1610ae245e18deb94e80a9f12c41ea3d493b6
2017-07-20 15:42:03 +05:30
Ilya Etingof 93043f32a1 rearrange existing documentation to follow the new layout standard
Change-Id: I2ac8f8f78147a5f75a2394f240154ee4472a7879
2017-07-17 14:57:41 +02:00
Lucas Alvares Gomes a63b7e8191 Fix documentation title and README
This patch fixes the documentation title, the name of the project is
VirtualBMC (with the capital cases) and also fix the README, it changes
the order of "team and repository tag" title to be the last and add
graceful shutdown and NMI as supported commands for ipmitool.

Change-Id: Ieb857b4c1065d5fff2028ee78a4a4e8586cd4724
2017-02-10 12:19:44 +00:00
Lucas Alvares Gomes d6976c5f38 Document some usage with examples
This patch is adding some documentation showing the basic usage of
VirtualBMC.

Change-Id: Idfd7fbe19b58212e0f81d7a2ba302ec21b5e2f04
2017-02-09 14:07:03 +00:00
Lucas Alvares Gomes 85a0b201ff Restructure the repository according to OpenStack
This patch is restructuring the VirtualBMC repository according to the
OpenStack template for projects (Cookiecutter).

This patch also removes the dependency on the python-daemon library
since it is not present in the OpenStack global-requirements, now a new
class called "detach_process" has been added to the virtualbmc/utils.py
module that will take care of detaching the process context from its
parent and session.

Change-Id: Id4ae1db5b73a18abc54276fe1dfbf3ceff7adc06
2016-05-09 12:35:50 +01:00