100 Commits

Author SHA1 Message Date
Mario Villaplana
689dbf6b5c Add documentation for rescue mode
This adds documentation for rescue mode, including the finalize_rescue
command as well as upstream support in agent images.

Change-Id: Id0834941ee4dacf2e7c0feaa65126d63e8a97c39
Partial-Bug: 1526449
2018-02-07 11:08:15 -05:00
Dmitry Tantsur
ad3c7ad75d Release notes clean up for the upcoming release
Also adds a missing documentation bit and specific versions for pike notes.

Change-Id: I186fe35cdd7a03702c993cae6468ef2d8151778a
2017-10-17 16:18:39 +02:00
Nguyen Van Trung
9ed2677c9d Fix wrong link about Hardware Managers
Change-Id: Ie7d43313692e5f0bd7794ae38e7b86f2204ef90b
2017-09-21 09:13:09 +07:00
Jenkins
e626cd744f Merge "Removes unnecessary utf-8 encoding" 2017-07-25 19:40:23 +00:00
Julia Kreger
7ae28c66bd Correct/update links
Correct instances of http to https and fix any remaining links
that were broken due to the document migration.

Change-Id: I492f7972839e63efdde469a1e16840d9be6d8b31
2017-07-14 20:28:08 +00:00
Julia Kreger
da95c4a891 Move content to admin
Change-Id: Ibffc7407addbdabb9121117366484f907d82f719
2017-07-11 13:45:45 +00:00
Julia Kreger
cace396783 Move install related content
Change-Id: Ib9a3897795993e7bce9a43d4028e1c9a90d47302
2017-07-11 13:33:46 +00:00
Julia Kreger
537dbcd03a Move contributor documentation
Change-Id: I43890d380b3cb6b19cfb84bf5d9dcad4f19c0062
2017-07-10 19:57:58 +00:00
Arundhati Surpur
2d1bff8f0d Removes unnecessary utf-8 encoding
This patches removes unnecessary utf-8
encoding in doc/source/conf.py

Change-Id: I864658137f58e78cd275cf8de7b0774a8d7991cb
2017-07-04 14:19:21 +05:30
Julia Kreger
774d995b7f Switch from oslosphinx to openstackdocstheme
Change-Id: I1aecf894955e8095c11b8fb82d60488e5d0aca5f
2017-07-04 01:10:43 +00:00
Vu Cong Tuan
667ad45615 Remove pbr warnerrors in favor of sphinx check
This change removes the now unused "warnerrors" setting,
which is replaced by "warning-is-error" in sphinx
releases >= 1.5 [1].

[1] http://lists.openstack.org/pipermail/openstack-dev/
2017-March/113085.html

Change-Id: I9bf18ff72f36dfd3496b9672604e8bb98999b133
2017-06-11 18:18:28 +07:00
Annie Lezil
fdcb0922a5 Collect NIC name given by BIOS
Adds an extra field ``biosdevname`` to network interface inventory
collected by ``default`` inspection collector (which collects the whole
inventory returned by hardware manager) of ironic-python-agent.

This feature requires biosdevname utility to collect the bios given NIC
names. The tooling module for tinyIPA is created for the same purpose.
For CoreOS IPA pxe images, biosdevname tooling module is limited,
because Docker repository is created and embedded into CoreOS pxe
images. The Docker repository uses debian to download the packages.
Debian does not have biosdevname package.

Adds an export variable TINYIPA_REQUIRE_BIOSDEVNAME. Set this
variable to ``true`` in your shell before building tinyIPA.

Closes-Bug: #1635351
Change-Id: Ia96af59e2a74868cac59e5a88cfbb3be60d85687
2017-05-18 14:44:11 -07:00
Jenkins
fd7f10b993 Merge "Configure and use SSL-related requests options" 2017-02-07 09:57:49 +00:00
Ramamani Yeleswarapu
73f316d804 Remove switch_port_descr and switch_chassis_descr
Removes two reserved fields ``switch_port_descr`` and
``switch_chassis_descr`` that were deprecated in the Newton cycle.

Change-Id: Icd2251af63a69d60d1e72eddf651a168fdae94fa
2017-02-02 07:01:04 -08:00
Mathieu Mitchell
5b1a217195 Remove vendor_passthru mentions from lookup/heartbeat documentation
Currently, the documentation index provides the old lookup/heartbeat
URLs. Commit b033bfd9 removed usage for these URLs.

This commit replaces old URLs from docs with the ones actually used.

Change-Id: I375045c23663768e4971d76162c87b731ee82eb3
Related-bug: #1640533
2017-01-31 07:02:59 -05:00
Pavlo Shchelokovskyy
fdd11b54a5 Configure and use SSL-related requests options
This patch adds standard SSL options to IPA config and makes use of them
when making HTTP requests.

For now, a single set of certificates is used when needed.
In the future configuration can be expanded to allow per-service
certificates.

Besides, the 'insecure' option (defaults to False) can be overridden
through kernel command line parameter 'ipa-insecure'.
This will allow running IPA in CI-like environments with self-signed SSL
certificates.

Change-Id: I259d9b3caa9ba1dc3d7382f375b8e086a5348d80
Closes-Bug: #1642515
2017-01-13 11:33:44 +02:00
Lucas Alvares Gomes
b272426562 Add HCTL to BlockDevices
This patch is adding a "hctl" attribute to the BlockDevices. HCTL stands
for: Host, Channel, Target and Lun, which is basically the SCSI address.

The idea behind this patch is to allow root device hints to find the
disk for deployment based on the SCSI address.

Partial-Bug: #1648036
Change-Id: If8897c68609e0df0378ee919b803ca5e497def02
2016-12-07 16:51:30 +00:00
Jenkins
bf3c4fb38c Merge "Fixed typo in doc file" 2016-10-05 02:15:36 +00:00
Dao Cong Tien
c2b305513a Invalid URL and typo in .rst files
Change-Id: I17377b4b7b2e8ecc0ce3dbc4ac7de9398912ada9
2016-10-03 13:38:07 +07:00
Anh Tran
8f8e9f921e Fixed typo in doc file
TrivialFix

Change-Id: I6e680ccae6c169eae433f376890a8f2e5a19849a
2016-09-28 08:45:07 +07:00
Pavlo Shchelokovskyy
1dcb656886 Add info on tinyipa to docs
Mention tinyipa in Image Builders section and in troubleshooting.

Change-Id: Ic6cfe64255aba0460cc960a98b18580b7798b204
2016-09-22 14:16:28 +03:00
Moshe Levi
fe3b630360 Add vendor, product to interface information
This patch updates the interfaces JSON to include
vendor and  product
u'interfaces': [
    {
        u'mac_address': u'00:0c:29:8c:11:b1',
        u'name': u'eth0',
        u'ipv4_address': None,
        u'switch_chassis_descr': None,
        u'switch_port_descr': None,
        u'lldp': None,
        u'vendor': u'0x15b3',
        u'product': u'0x1014,
    }]

Co-Authored-By: yogananth subramanian <ysubrama@redhat.com>

Closes-Bug: #1611856

Change-Id: I8fa58dde29601abee959f74b69b692ed9eaffb94
2016-09-21 10:14:26 -04:00
Ruby Loo
ad7926365e Minor updates to metrics documentation
This is a follow up to Ic08d4ff78b6fb614b474b956a32eac352a14262a.
It enhances an example, fixes a spelling error, and modifies some
sentences for better readability.

Change-Id: Icfc89edd426ddee6a93be40c5b2f56d9d78fbd0c
2016-08-11 23:09:12 -04:00
Jim Rollenhagen
5f146d465d Make code blocks real code blocks in metrics docs
Makes them an RST block quote and 4 space indents instead of 2.

Change-Id: If2b727ac431e70d714f3df0c622c5516901f3393
2016-08-11 07:24:06 -04:00
Josh Gachnang
fd874652e3 Add metrics support to IPA
This utilizes the new metrics support in ironic-lib to allow the agent to
report timing metrics for agent API methods as configured in ironic-lib.

Additionally, this adds developer docs on how to use metrics in IPA,
including some caveats specific to ironic-lib.metrics use in IPA.

Co-Authored-By: Jay Faulkner <jay@jvf.cc>
Co-Authored-By: Alex Weeks <alex.weeks@gmail.com>
Change-Id: Ic08d4ff78b6fb614b474b956a32eac352a14262a
Partial-bug: #1526219
2016-08-03 11:24:54 -07:00
Jim Rollenhagen
2e10d7b32c Fix doc warnings
Per Doug's email[0], 'warnerrors' in setup.cfg hasn't actually been
working for some time now, and we've piled up a few warnings. Fix these
before a pbr release to unbreak it gets pushed out and breaks our doc
builds.

[0] http://lists.openstack.org/pipermail/openstack-dev/2016-June/097849.html

Change-Id: I6576a56234918febb21e7e4860544eb952123c09
2016-07-14 14:37:02 -04:00
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