24 Commits

Author SHA1 Message Date
Jenkins
56eea51564 Merge "Documentation follow-up to the LLDP patch" 2016-06-27 16:17:01 +00:00
Jenkins
3397ee8175 Merge "Update doc about lookup action" 2016-06-27 08:29:49 +00:00
Cao ShuFeng
ff9f0ad76b Update doc about lookup action
Doc about lookup action is updated according to the code[1].

TrivialFix

[1]: https://github.com/openstack/ironic-python-agent/blob/master/ironic_python_agent/ironic_api_client.py#L101

Change-Id: Ib7617cb64b5fede1b6e118db47a85238fc473098
2016-06-27 04:37:26 -04:00
John L. Villalovos
d89dfb1b26 Documentation follow-up to the LLDP patch
Documentation follow-up to the LLDP patch, commit
a7f0af722f96950e3bf67e26b922f80c1bd503ab. Provide the meaning of the
acronymns TLV and LLDP.

Change-Id: Icce3eb5519dfcfc9b6f7e23003cf056646da6c50
2016-06-24 13:00:32 -07:00
Sam Betts
a7f0af722f Support LLDP data as part of interfaces in inventory
To support multi-tenant networking in Ironic we need to be able to
discover not just the NICs a baremetal machine has but also the physical
connectivity to switches in the network.

This patch collects LLDP (Link Layer Discovery Protocol) data as part of
the list interfaces stage of the generic hardware manager. This
information can then be processed by the ironic inspector to populate
the local link information on each ironic port.

The processing done on this data in ironic python agent is limited, this
is to allow for server side processing hooks to process as much or as
little of the data as they want. This is to allow for multi-vendor
environments that might use different parts of the LLDP packet to use a
generic ramdisk and configure the processing server side using inspector
plugins.

Reserved fields switch_port_descr and switch_chassis_descr have been
deprecated for removal in Ocata in favor of passing the whole packet.

Change-Id: Idae9b1ede1797029da1bd521501b121957ca1f1a
Partial-Bug: #1526403
2016-06-22 18:26:04 +01:00
Chris Krelle
91c25d9616 Add basic troubleshooting doc
A troubleshooting doc for IPA.

Change-Id: I0bc71e8c0a1a4e99d6edd12f1c8654299cc1f4f4
2016-06-10 12:25:43 -07:00
Jenkins
031593614e Merge "Add boot information into the inventory" 2016-06-02 19:11:35 +00:00
Jenkins
928b10cbd3 Merge "Returns CPU flags in the CPU inventory" 2016-06-01 18:21:21 +00:00
Dmitry Tantsur
6670da4ed1 Returns CPU flags in the CPU inventory
These flags will be processed in a new ironic-inspector plugin
to support setting capabilities like cpu_vt (virtualization enabled).

Change-Id: I5fe9310c316841eabdd2d5e2ef2ae30afa03d29a
Partial-Bug: #1571580
2016-06-01 16:12:32 +02:00
Dmitry Tantsur
53b187a4c3 Add boot information into the inventory
Adds a new BootInfo object with 2 fields:

* current_boot_mode - bios or uefi, detected from presence of /sys/firmware/efi
  as per the following answer: http://askubuntu.com/a/162896
  This field will be used for setting the boot_mode capability in ironic-inspector
* pxe_interface - PXE booting interface, if it can be detected.
  This fields is already used by ironic-inspector, added here for consistency.

Change-Id: Ib36b592ffaba3bfa055d65c9526607867d302584
Partial-Bug: #1571580
2016-05-26 17:05:11 +02:00
Mathieu Mitchell
f412b931cb Remove links to github for OpenStack things
Github is not the official reference for OpenStack code repositories,
and as such should not be used in documentation.

Update links that are meant to be links to a project as a whole with
links to the project's documentation.

Update links directly to code to git.openstack.org.

This change follows Iee09b6b86628e46dc5e9436bd0f98a40c50244b7

Change-Id: I6c0ba75c1ba04916413847cce56441ff4670bd62
2016-05-26 08:12:29 -04:00
Jim Rollenhagen
99f70370b7 Correct link to enabling agent drivers
The current link points to a section of the docs that is just a pointer
to another section of our docs. Change this to point directly to the
correct docs, saving users an extra click.

Change-Id: I6814fda9292921aeedb90041563b3dbb997de9c6
2016-04-01 06:27:36 -07:00
Jenkins
dcd1c8f19b Merge "Document hardware inventory sent to lookup and inspection" 2016-03-15 17:04:25 +00:00
Kurt Taylor
f961169302 Update DIB description for IPA docs
Updating information in the IPA documentation for diskimage-builder usage.

Change-Id: Id81797c5f56b55cbee2bc6e3a3950cbff0af8150
2016-02-26 11:47:26 -06:00
Dmitry Tantsur
c9674da220 Document hardware inventory sent to lookup and inspection
Also add a missing docstring to HardwareManager.list_hardware_info.

Change-Id: Iee3584320f0591398e7761513ff588efeb62886d
2016-02-18 13:32:43 +01:00
Jim Rollenhagen
d1859274ac Fix trivial typo in docs
Change-Id: I97adeaa68a08e975dfc0cfb4a27e6a9869a2a6b1
2015-12-15 14:40:42 -08:00
Naohiro Tamura
505b34575c Fix to preserve double dashes of command line option in HTML.
This patch fixes the ReST doc so that generated HTML file can keep
double dashes of command line option by enclosing the option in double
back quote such as ``--standalone`` and ``--debug``.

Change-Id: Icf25ff8ddfb7c04d82d6e63885cad0ec62e86cba
2015-11-16 09:29:50 +09:00
Dmitry Tantsur
e3e6000524 Follow-up to inspection patch 096830414b
Change-Id: I7ec05e501ec40802efa14cabe14752972919c7a9
2015-09-16 10:36:33 +00:00
Dmitry Tantsur
096830414b Add support for inspection using ironic-inspector
Adds a new module ironic_python_agent.inspector and new entry point
for extensions, which will allow vendor-specific inspection.

Inspection is run on service start up just before the lookup.
Due to this early start, and due to the fact we don't even know
MAC address of nodes on inspection (to say nothing about IP addresses),
exception handling is a bit different from other agent features:
we try hard not to error out until we send at least something to inspector.

Change-Id: I00932463d41819fd0a050782e2c88eddf6fc08c6
2015-09-07 18:22:54 +02:00
Lindsay K
b2a86e0b43 Fix plural agreement grammar error
Change-Id: Iab2bc4bee2ef256c43a9c203a4f7495d9716c79a
Partial-Bug: #1367915
2015-09-03 12:54:23 -07:00
Josh Gachnang
2c28cca71d Enable --debug for debug logging
oslo_log wasn't getting the correct config values passed in, so adding
'--debug' to the command line wouldn't enable debug logging.

Added docs about --debug and --standalone (the only two flags I've
seen used/supported).

Change-Id: Ie1ba64992444a65a40f2d65933942153b93e70c1
2015-08-28 12:25:06 -07:00
Josh Gachnang
0bc303a8ae Cleaning with custom hardware manager docs
While working on using multiple hardware managers, I noticed
the docs were a bit lacking. Also fixed a few typos.

Change-Id: Ia86928e3803009b680cb366a3dd41de98359842b
2015-08-12 14:27:23 -07:00
Jay Faulkner
ae369492c1 Docs on HardwareManager, building, and workflow
Documentation on IPA hardware managers, how to build an IPA ramdisk
and some ways Ironic interacts with the IPA API.

Change-Id: I94db188e1e1333e71437f551d1dfe00acdd7fc8a
Co-Authored-By: Josh Gachnang <josh@servercobra.com>
2015-04-01 14:02:20 -07:00
Jay Faulkner
be97525975 Add sphinx build + basic documentation
This adds and configures a sphinx doc builder. This is based on the code
in Ironic to build documentation.

The goal is for this to contain development documentation relevant to
hacking on the agent, including how to make custom HardwareManagers.

Change-Id: Ib6cecb9959f4ad5c71440fb37827b996582a9545
2015-03-31 16:22:12 -07:00