openstack/tripleo-docs
Code Issues Proposed changes

Consistently reference ironic-inspector

Browse Source 
Update references from ironic-discoverd to ironic-inspector since it is
the new name of the project starting from Liberty.

This commit also introduce a subtle change of semantic: what was
previously known as discovery is now called introspection.

Co-Authored-By: Ignacio Bravo <ibravo@hotmail.com>

Change-Id: If7618d9c9815ad201bafc0929fdf72120aba590f
This commit is contained in:
Martin André 2015-12-02 11:33:46 +09:00
parent 67197ae322
commit b6abd69f64
9 changed files with 780 additions and 261 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
doc/source/_images/discovery_diagram.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 62 KiB

192
doc/source/_images/discovery_diagram.svg
View File

@ -1,192 +0,0 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- Generator: Adobe Illustrator 16.0.4, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
width="1075.511px" height="793.5px" viewBox="1020 0 1075.511 793.5" enable-background="new 1020 0 1075.511 793.5"
xml:space="preserve">
<g>
<rect x="1046.5" y="42.271" fill="#FFFFFF" width="230.863" height="82.729"/>
<g>
<polyline fill="none" stroke="#000000" stroke-miterlimit="10" points="1277.363,122 1277.363,125 1274.363,125 "/>
<line fill="none" stroke="#000000" stroke-miterlimit="10" stroke-dasharray="6.0774,6.0774" x1="1268.286" y1="125" x2="1052.539" y2="125"/>
<polyline fill="none" stroke="#000000" stroke-miterlimit="10" points="1049.5,125 1046.5,125 1046.5,122 "/>
<line fill="none" stroke="#000000" stroke-miterlimit="10" stroke-dasharray="5.9022,5.9022" x1="1046.5" y1="116.098" x2="1046.5" y2="48.222"/>
<polyline fill="none" stroke="#000000" stroke-miterlimit="10" points="1046.5,45.271 1046.5,42.271 1049.5,42.271 "/>
<line fill="none" stroke="#000000" stroke-miterlimit="10" stroke-dasharray="6.0774,6.0774" x1="1055.577" y1="42.271" x2="1271.324" y2="42.271"/>
<polyline fill="none" stroke="#000000" stroke-miterlimit="10" points="1274.363,42.271 1277.363,42.271 1277.363,45.271 "/>
<line fill="none" stroke="#000000" stroke-miterlimit="10" stroke-dasharray="5.9022,5.9022" x1="1277.363" y1="51.173" x2="1277.363" y2="119.049"/>
</g>
</g>
<rect x="1048.5" y="73.745" fill="none" width="228.863" height="21.781"/>
<text transform="matrix(1 0 0 1 1138.9512 87.4243)" font-family="'OpenSans'" font-size="18">Client</text>
<g>
<rect x="1310.675" y="42.271" fill="#FFFFFF" width="230.863" height="82.729"/>
<g>
<polyline fill="none" stroke="#000000" stroke-miterlimit="10" points="1541.538,122 1541.538,125 1538.538,125 "/>
<line fill="none" stroke="#000000" stroke-miterlimit="10" stroke-dasharray="6.0774,6.0774" x1="1532.461" y1="125" x2="1316.714" y2="125"/>
<polyline fill="none" stroke="#000000" stroke-miterlimit="10" points="1313.675,125 1310.675,125 1310.675,122 "/>
<line fill="none" stroke="#000000" stroke-miterlimit="10" stroke-dasharray="5.9022,5.9022" x1="1310.675" y1="116.097" x2="1310.675" y2="48.222"/>
<polyline fill="none" stroke="#000000" stroke-miterlimit="10" points="1310.675,45.271 1310.675,42.271 1313.675,42.271 "/>
<line fill="none" stroke="#000000" stroke-miterlimit="10" stroke-dasharray="6.0774,6.0774" x1="1319.752" y1="42.271" x2="1535.499" y2="42.271"/>
<polyline fill="none" stroke="#000000" stroke-miterlimit="10" points="1538.538,42.271 1541.538,42.271 1541.538,45.271 "/>
<line fill="none" stroke="#000000" stroke-miterlimit="10" stroke-dasharray="5.9022,5.9022" x1="1541.538" y1="51.173" x2="1541.538" y2="119.048"/>
</g>
</g>
<rect x="1310.675" y="73.745" fill="none" width="230.863" height="21.781"/>
<text transform="matrix(1 0 0 1 1402.4023 87.4243)" font-family="'OpenSans'" font-size="18">Ironic</text>
<g>
<rect x="1577.004" y="43.271" fill="#FFFFFF" width="230.863" height="82.729"/>
<g>
<polyline fill="none" stroke="#000000" stroke-miterlimit="10" points="1807.867,123 1807.867,126 1804.867,126 "/>
<line fill="none" stroke="#000000" stroke-miterlimit="10" stroke-dasharray="6.0774,6.0774" x1="1798.79" y1="126" x2="1583.043" y2="126"/>
<polyline fill="none" stroke="#000000" stroke-miterlimit="10" points="1580.004,126 1577.004,126 1577.004,123 "/>
<line fill="none" stroke="#000000" stroke-miterlimit="10" stroke-dasharray="5.9022,5.9022" x1="1577.004" y1="117.097" x2="1577.004" y2="49.222"/>
<polyline fill="none" stroke="#000000" stroke-miterlimit="10" points="1577.004,46.271 1577.004,43.271 1580.004,43.271 "/>
<line fill="none" stroke="#000000" stroke-miterlimit="10" stroke-dasharray="6.0774,6.0774" x1="1586.081" y1="43.271" x2="1801.828" y2="43.271"/>
<polyline fill="none" stroke="#000000" stroke-miterlimit="10" points="1804.867,43.271 1807.867,43.271 1807.867,46.271 "/>
<line fill="none" stroke="#000000" stroke-miterlimit="10" stroke-dasharray="5.9022,5.9022" x1="1807.867" y1="52.173" x2="1807.867" y2="120.048"/>
</g>
</g>
<rect x="1578.582" y="74.745" fill="none" width="230.863" height="21.781"/>
<text transform="matrix(1 0 0 1 1615.3076 88.4243)" font-family="'OpenSans'" font-size="18">Discovery Ramdisk</text>
<g>
<rect x="1837.637" y="42.271" fill="#FFFFFF" width="230.863" height="82.729"/>
<g>
<polyline fill="none" stroke="#000000" stroke-miterlimit="10" points="2068.5,122 2068.5,125 2065.5,125 "/>
<line fill="none" stroke="#000000" stroke-miterlimit="10" stroke-dasharray="6.0774,6.0774" x1="2059.423" y1="125" x2="1843.676" y2="125"/>
<polyline fill="none" stroke="#000000" stroke-miterlimit="10" points="1840.637,125 1837.637,125 1837.637,122 "/>
<line fill="none" stroke="#000000" stroke-miterlimit="10" stroke-dasharray="5.9022,5.9022" x1="1837.637" y1="116.097" x2="1837.637" y2="48.222"/>
<polyline fill="none" stroke="#000000" stroke-miterlimit="10" points="1837.637,45.271 1837.637,42.271 1840.637,42.271 "/>
<line fill="none" stroke="#000000" stroke-miterlimit="10" stroke-dasharray="6.0774,6.0774" x1="1846.714" y1="42.271" x2="2062.461" y2="42.271"/>
<polyline fill="none" stroke="#000000" stroke-miterlimit="10" points="2065.5,42.271 2068.5,42.271 2068.5,45.271 "/>
<line fill="none" stroke="#000000" stroke-miterlimit="10" stroke-dasharray="5.9022,5.9022" x1="2068.5" y1="51.173" x2="2068.5" y2="119.048"/>
</g>
</g>
<rect x="1835.637" y="73.745" fill="none" width="232.863" height="21.781"/>
<text transform="matrix(1 0 0 1 1910.4697 87.4243)" font-family="'OpenSans'" font-size="18">Discoverd</text>
<g>
<g>
<line fill="none" stroke="#000000" stroke-width="2" stroke-miterlimit="10" x1="1161.932" y1="126" x2="1161.932" y2="132"/>
<line fill="none" stroke="#000000" stroke-width="2" stroke-miterlimit="10" stroke-dasharray="12.1939,12.1939" x1="1161.932" y1="144.193" x2="1161.932" y2="723.403"/>
<line fill="none" stroke="#000000" stroke-width="2" stroke-miterlimit="10" x1="1161.932" y1="729.5" x2="1161.932" y2="735.5"/>
</g>
</g>
<g>
<g>
<line fill="none" stroke="#000000" stroke-width="2" stroke-miterlimit="10" x1="1426.106" y1="126" x2="1426.106" y2="132"/>
<line fill="none" stroke="#000000" stroke-width="2" stroke-miterlimit="10" stroke-dasharray="12.1939,12.1939" x1="1426.106" y1="144.193" x2="1426.106" y2="723.403"/>
<line fill="none" stroke="#000000" stroke-width="2" stroke-miterlimit="10" x1="1426.106" y1="729.5" x2="1426.106" y2="735.5"/>
</g>
</g>
<g>
<g>
<line fill="none" stroke="#000000" stroke-width="2" stroke-miterlimit="10" x1="1692.436" y1="126" x2="1692.436" y2="132"/>
<line fill="none" stroke="#000000" stroke-width="2" stroke-miterlimit="10" stroke-dasharray="12.1939,12.1939" x1="1692.436" y1="144.193" x2="1692.436" y2="723.403"/>
<line fill="none" stroke="#000000" stroke-width="2" stroke-miterlimit="10" x1="1692.436" y1="729.5" x2="1692.436" y2="735.5"/>
</g>
</g>
<g>
<g>
<line fill="none" stroke="#000000" stroke-width="2" stroke-miterlimit="10" x1="1953.068" y1="126" x2="1953.068" y2="132"/>
<line fill="none" stroke="#000000" stroke-width="2" stroke-miterlimit="10" stroke-dasharray="12.1939,12.1939" x1="1953.068" y1="144.193" x2="1953.068" y2="723.403"/>
<line fill="none" stroke="#000000" stroke-width="2" stroke-miterlimit="10" x1="1953.068" y1="729.5" x2="1953.068" y2="735.5"/>
</g>
</g>
<rect x="1156.932" y="169.729" fill="#820E0A" stroke="#000000" stroke-width="2" stroke-linejoin="round" stroke-miterlimit="10" width="12" height="537.771"/>
<rect x="1420.106" y="169.729" fill="#820E0A" stroke="#000000" stroke-width="2" stroke-linejoin="round" stroke-miterlimit="10" width="12" height="158.771"/>
<rect x="1420.106" y="386" fill="#820E0A" stroke="#000000" stroke-width="2" stroke-linejoin="round" stroke-miterlimit="10" width="12" height="319.635"/>
<rect x="1946.068" y="612.5" fill="#820E0A" stroke="#000000" stroke-width="2" stroke-linejoin="round" stroke-miterlimit="10" width="12" height="92.089"/>
<g>
<g>
<line fill="none" stroke="#000000" stroke-width="2" stroke-linejoin="round" x1="1182.5" y1="169.729" x2="1394.43" y2="169.729"/>
<g>
<path d="M1406.5,169.729c-5.68,2.107-12.727,5.703-17.095,9.512l3.44-9.512l-3.44-9.51
C1393.773,164.028,1400.82,167.624,1406.5,169.729z"/>
</g>
</g>
</g>
<g>
<g>
<line fill="none" stroke="#000000" stroke-width="2" stroke-linejoin="round" x1="1182.5" y1="383.729" x2="1394.43" y2="383.729"/>
<g>
<path d="M1406.5,383.729c-5.68,2.107-12.727,5.703-17.095,9.512l3.44-9.512l-3.44-9.509
C1393.773,378.027,1400.82,381.623,1406.5,383.729z"/>
</g>
</g>
</g>
<g>
<g>
<line fill="none" stroke="#000000" stroke-width="2" stroke-linejoin="round" x1="1706.5" y1="612.5" x2="1918.43" y2="612.5"/>
<g>
<path d="M1930.5,612.5c-5.68,2.107-12.727,5.703-17.095,9.512l3.44-9.512l-3.44-9.51
C1917.773,606.799,1924.82,610.395,1930.5,612.5z"/>
</g>
</g>
</g>
<rect x="1686.436" y="386" fill="#820E0A" stroke="#000000" stroke-width="2" stroke-linejoin="round" stroke-miterlimit="10" width="12" height="226.5"/>
<g>
<g>
<line fill="none" stroke="#000000" stroke-width="2" stroke-linejoin="round" x1="1450.436" y1="386" x2="1662.365" y2="386"/>
<g>
<path d="M1674.436,386c-5.68,2.107-12.727,5.703-17.095,9.512l3.44-9.512l-3.44-9.51
C1661.709,380.299,1668.756,383.895,1674.436,386z"/>
</g>
</g>
</g>
<g>
<g>
<line fill="none" stroke="#000000" stroke-width="2" stroke-linejoin="round" x1="1460.506" y1="704.589" x2="1930.5" y2="704.589"/>
<g>
<path d="M1448.436,704.589c5.68,2.107,12.727,5.703,17.095,9.512l-3.44-9.512l3.44-9.51
C1461.162,698.888,1454.115,702.483,1448.436,704.589z"/>
</g>
</g>
</g>
<rect x="1180.068" y="134.706" fill="none" width="228.863" height="33.317"/>
<text transform="matrix(1 0 0 1 1180.0684 145.3457)"><tspan x="0" y="0" font-family="'OpenSans'" font-size="14">Register nodes’</tspan><tspan x="0" y="16.8" font-family="'OpenSans'" font-size="14">power management details</tspan></text>
<rect x="1182.5" y="348.047" fill="none" width="228.863" height="33.316"/>
<text transform="matrix(1 0 0 1 1182.5 375.4868)" font-family="'OpenSans'" font-size="14">Send nodes for introspection</text>
<rect x="1448.004" y="350.047" fill="none" width="228.863" height="33.316"/>
<text transform="matrix(1 0 0 1 1448.0039 360.687)"><tspan x="0" y="0" font-family="'OpenSans'" font-size="14">Reboot nodes -&gt; PXE boot generic </tspan><tspan x="0" y="16.799" font-family="'OpenSans'" font-size="14">discovery ramdisk image</tspan></text>
<rect x="1584.004" y="669.545" fill="none" width="346.496" height="33.316"/>
<text transform="matrix(1 0 0 1 1599.0186 696.9844)" font-family="'OpenSans'" font-size="14">Facts checking and registration of hardware details</text>
<rect x="1705.068" y="579.184" fill="none" width="228.863" height="33.316"/>
<text transform="matrix(1 0 0 1 1705.0684 606.623)" font-family="'OpenSans'" font-size="14">Post hardware metrics</text>
<g>
<g>
<line fill="none" stroke="#000000" stroke-width="2" stroke-linejoin="round" x1="1192.139" y1="321.729" x2="1404.068" y2="321.729"/>
<g>
<path d="M1180.068,321.729c5.68,2.107,12.727,5.703,17.095,9.512l-3.44-9.512l3.44-9.51
C1192.795,316.027,1185.748,319.623,1180.068,321.729z"/>
</g>
</g>
</g>
<rect x="1179.068" y="286.047" fill="none" width="228.863" height="33.316"/>
<text transform="matrix(1 0 0 1 1295.7676 313.4868)" font-family="'OpenSans'" font-size="14">Nodes registered</text>
<rect x="1258.858" y="748.158" fill="none" width="346.496" height="33.316"/>
<text transform="matrix(1 0 0 1 1341.6709 758.7988)"><tspan x="0" y="0" font-family="'OpenSans-Bold'" font-size="14">Nodes are fully registered</tspan><tspan x="-38.877" y="16.799" font-family="'OpenSans-Bold'" font-size="14">wth full stack of hardware attributes</tspan></text>
</svg>
Side by Side

Before

Width:  |  Height:  |  Size: 12 KiB

BIN
doc/source/_images/introspection_diagram.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 31 KiB

717
doc/source/_images/introspection_diagram.svg Normal file
View File

@ -0,0 +1,717 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- Generator: Adobe Illustrator 16.0.4, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
<svg
xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:cc="http://creativecommons.org/ns#"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns="http://www.w3.org/2000/svg"
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
version="1.1"
id="Layer_1"
x="0px"
y="0px"
width="1075.511px"
height="793.5px"
viewBox="1020 0 1075.511 793.5"
enable-background="new 1020 0 1075.511 793.5"
xml:space="preserve"
inkscape:version="0.91 r13725"
sodipodi:docname="introspection_diagram.svg"
inkscape:export-filename="/home/martin/dev/openstack/tripleo-docs/doc/source/_images/introspection_diagram.png"
inkscape:export-xdpi="60.835228"
inkscape:export-ydpi="60.835228"><metadata
id="metadata261"><rdf:RDF><cc:Work
rdf:about=""><dc:format>image/svg+xml</dc:format><dc:type
rdf:resource="http://purl.org/dc/dcmitype/StillImage" /><dc:title /></cc:Work></rdf:RDF></metadata><defs
id="defs259" /><sodipodi:namedview
pagecolor="#ffffff"
bordercolor="#666666"
borderopacity="1"
objecttolerance="10"
gridtolerance="10"
guidetolerance="10"
inkscape:pageopacity="0"
inkscape:pageshadow="2"
inkscape:window-width="1341"
inkscape:window-height="925"
id="namedview257"
showgrid="false"
inkscape:snap-text-baseline="false"
inkscape:zoom="0.84122092"
inkscape:cx="370.2174"
inkscape:cy="415.93122"
inkscape:window-x="260"
inkscape:window-y="1274"
inkscape:window-maximized="0"
inkscape:current-layer="Layer_1" /><g
id="g3"><rect
x="1046.5"
y="42.271"
fill="#FFFFFF"
width="230.863"
height="82.729"
id="rect5" /><g
id="g7"><polyline
fill="none"
stroke="#000000"
stroke-miterlimit="10"
points="1277.363,122 1277.363,125 1274.363,125 "
id="polyline9" /><line
fill="none"
stroke="#000000"
stroke-miterlimit="10"
stroke-dasharray="6.0774,6.0774"
x1="1268.286"
y1="125"
x2="1052.539"
y2="125"
id="line11" /><polyline
fill="none"
stroke="#000000"
stroke-miterlimit="10"
points="1049.5,125 1046.5,125 1046.5,122 "
id="polyline13" /><line
fill="none"
stroke="#000000"
stroke-miterlimit="10"
stroke-dasharray="5.9022,5.9022"
x1="1046.5"
y1="116.098"
x2="1046.5"
y2="48.222"
id="line15" /><polyline
fill="none"
stroke="#000000"
stroke-miterlimit="10"
points="1046.5,45.271 1046.5,42.271 1049.5,42.271 "
id="polyline17" /><line
fill="none"
stroke="#000000"
stroke-miterlimit="10"
stroke-dasharray="6.0774,6.0774"
x1="1055.577"
y1="42.271"
x2="1271.324"
y2="42.271"
id="line19" /><polyline
fill="none"
stroke="#000000"
stroke-miterlimit="10"
points="1274.363,42.271 1277.363,42.271 1277.363,45.271 "
id="polyline21" /><line
fill="none"
stroke="#000000"
stroke-miterlimit="10"
stroke-dasharray="5.9022,5.9022"
x1="1277.363"
y1="51.173"
x2="1277.363"
y2="119.049"
id="line23" /></g></g><rect
x="1048.5"
y="73.745"
fill="none"
width="228.863"
height="21.781"
id="rect25" /><text
transform="matrix(1 0 0 1 1138.9512 87.4243)"
font-family="'OpenSans'"
font-size="18"
id="text27">Client</text>
<g
id="g29"><rect
x="1310.675"
y="42.271"
fill="#FFFFFF"
width="230.863"
height="82.729"
id="rect31" /><g
id="g33"><polyline
fill="none"
stroke="#000000"
stroke-miterlimit="10"
points="1541.538,122 1541.538,125 1538.538,125 "
id="polyline35" /><line
fill="none"
stroke="#000000"
stroke-miterlimit="10"
stroke-dasharray="6.0774,6.0774"
x1="1532.461"
y1="125"
x2="1316.714"
y2="125"
id="line37" /><polyline
fill="none"
stroke="#000000"
stroke-miterlimit="10"
points="1313.675,125 1310.675,125 1310.675,122 "
id="polyline39" /><line
fill="none"
stroke="#000000"
stroke-miterlimit="10"
stroke-dasharray="5.9022,5.9022"
x1="1310.675"
y1="116.097"
x2="1310.675"
y2="48.222"
id="line41" /><polyline
fill="none"
stroke="#000000"
stroke-miterlimit="10"
points="1310.675,45.271 1310.675,42.271 1313.675,42.271 "
id="polyline43" /><line
fill="none"
stroke="#000000"
stroke-miterlimit="10"
stroke-dasharray="6.0774,6.0774"
x1="1319.752"
y1="42.271"
x2="1535.499"
y2="42.271"
id="line45" /><polyline
fill="none"
stroke="#000000"
stroke-miterlimit="10"
points="1538.538,42.271 1541.538,42.271 1541.538,45.271 "
id="polyline47" /><line
fill="none"
stroke="#000000"
stroke-miterlimit="10"
stroke-dasharray="5.9022,5.9022"
x1="1541.538"
y1="51.173"
x2="1541.538"
y2="119.048"
id="line49" /></g></g><rect
x="1310.675"
y="73.745"
fill="none"
width="230.863"
height="21.781"
id="rect51" /><text
transform="matrix(1 0 0 1 1402.4023 87.4243)"
font-family="'OpenSans'"
font-size="18"
id="text53">Ironic</text>
<g
id="g55"><rect
x="1577.004"
y="43.271"
fill="#FFFFFF"
width="230.863"
height="82.729"
id="rect57" /><g
id="g59"><polyline
fill="none"
stroke="#000000"
stroke-miterlimit="10"
points="1807.867,123 1807.867,126 1804.867,126 "
id="polyline61" /><line
fill="none"
stroke="#000000"
stroke-miterlimit="10"
stroke-dasharray="6.0774,6.0774"
x1="1798.79"
y1="126"
x2="1583.043"
y2="126"
id="line63" /><polyline
fill="none"
stroke="#000000"
stroke-miterlimit="10"
points="1580.004,126 1577.004,126 1577.004,123 "
id="polyline65" /><line
fill="none"
stroke="#000000"
stroke-miterlimit="10"
stroke-dasharray="5.9022,5.9022"
x1="1577.004"
y1="117.097"
x2="1577.004"
y2="49.222"
id="line67" /><polyline
fill="none"
stroke="#000000"
stroke-miterlimit="10"
points="1577.004,46.271 1577.004,43.271 1580.004,43.271 "
id="polyline69" /><line
fill="none"
stroke="#000000"
stroke-miterlimit="10"
stroke-dasharray="6.0774,6.0774"
x1="1586.081"
y1="43.271"
x2="1801.828"
y2="43.271"
id="line71" /><polyline
fill="none"
stroke="#000000"
stroke-miterlimit="10"
points="1804.867,43.271 1807.867,43.271 1807.867,46.271 "
id="polyline73" /><line
fill="none"
stroke="#000000"
stroke-miterlimit="10"
stroke-dasharray="5.9022,5.9022"
x1="1807.867"
y1="52.173"
x2="1807.867"
y2="120.048"
id="line75" /></g></g><rect
x="1578.582"
y="74.745"
fill="none"
width="230.863"
height="21.781"
id="rect77" /><text
font-size="18"
id="text79"
style="font-size:18px;font-family:OpenSans"
x="1591.3076"
y="88.424301">Introspection Ramdisk</text>
<g
id="g81"><rect
x="1837.637"
y="42.271"
fill="#FFFFFF"
width="230.863"
height="82.729"
id="rect83" /><g
id="g85"><polyline
fill="none"
stroke="#000000"
stroke-miterlimit="10"
points="2068.5,122 2068.5,125 2065.5,125 "
id="polyline87" /><line
fill="none"
stroke="#000000"
stroke-miterlimit="10"
stroke-dasharray="6.0774,6.0774"
x1="2059.423"
y1="125"
x2="1843.676"
y2="125"
id="line89" /><polyline
fill="none"
stroke="#000000"
stroke-miterlimit="10"
points="1840.637,125 1837.637,125 1837.637,122 "
id="polyline91" /><line
fill="none"
stroke="#000000"
stroke-miterlimit="10"
stroke-dasharray="5.9022,5.9022"
x1="1837.637"
y1="116.097"
x2="1837.637"
y2="48.222"
id="line93" /><polyline
fill="none"
stroke="#000000"
stroke-miterlimit="10"
points="1837.637,45.271 1837.637,42.271 1840.637,42.271 "
id="polyline95" /><line
fill="none"
stroke="#000000"
stroke-miterlimit="10"
stroke-dasharray="6.0774,6.0774"
x1="1846.714"
y1="42.271"
x2="2062.461"
y2="42.271"
id="line97" /><polyline
fill="none"
stroke="#000000"
stroke-miterlimit="10"
points="2065.5,42.271 2068.5,42.271 2068.5,45.271 "
id="polyline99" /><line
fill="none"
stroke="#000000"
stroke-miterlimit="10"
stroke-dasharray="5.9022,5.9022"
x1="2068.5"
y1="51.173"
x2="2068.5"
y2="119.048"
id="line101" /></g></g><rect
x="1835.637"
y="73.745"
fill="none"
width="232.863"
height="21.781"
id="rect103" /><text
font-size="18"
id="text105"
style="font-size:18px;font-family:OpenSans;text-align:center;text-anchor:middle"
x="1953.521"
y="87.424301">Ironic-inspector</text>
<g
id="g107"><g
id="g109"><line
fill="none"
stroke="#000000"
stroke-width="2"
stroke-miterlimit="10"
x1="1161.932"
y1="126"
x2="1161.932"
y2="132"
id="line111" /><line
fill="none"
stroke="#000000"
stroke-width="2"
stroke-miterlimit="10"
stroke-dasharray="12.1939,12.1939"
x1="1161.932"
y1="144.193"
x2="1161.932"
y2="723.403"
id="line113" /><line
fill="none"
stroke="#000000"
stroke-width="2"
stroke-miterlimit="10"
x1="1161.932"
y1="729.5"
x2="1161.932"
y2="735.5"
id="line115" /></g></g><g
id="g117"><g
id="g119"><line
fill="none"
stroke="#000000"
stroke-width="2"
stroke-miterlimit="10"
x1="1426.106"
y1="126"
x2="1426.106"
y2="132"
id="line121" /><line
fill="none"
stroke="#000000"
stroke-width="2"
stroke-miterlimit="10"
stroke-dasharray="12.1939,12.1939"
x1="1426.106"
y1="144.193"
x2="1426.106"
y2="723.403"
id="line123" /><line
fill="none"
stroke="#000000"
stroke-width="2"
stroke-miterlimit="10"
x1="1426.106"
y1="729.5"
x2="1426.106"
y2="735.5"
id="line125" /></g></g><g
id="g127"><g
id="g129"><line
fill="none"
stroke="#000000"
stroke-width="2"
stroke-miterlimit="10"
x1="1692.436"
y1="126"
x2="1692.436"
y2="132"
id="line131" /><line
fill="none"
stroke="#000000"
stroke-width="2"
stroke-miterlimit="10"
stroke-dasharray="12.1939,12.1939"
x1="1692.436"
y1="144.193"
x2="1692.436"
y2="723.403"
id="line133" /><line
fill="none"
stroke="#000000"
stroke-width="2"
stroke-miterlimit="10"
x1="1692.436"
y1="729.5"
x2="1692.436"
y2="735.5"
id="line135" /></g></g><g
id="g137"><g
id="g139"><line
fill="none"
stroke="#000000"
stroke-width="2"
stroke-miterlimit="10"
x1="1953.068"
y1="126"
x2="1953.068"
y2="132"
id="line141" /><line
fill="none"
stroke="#000000"
stroke-width="2"
stroke-miterlimit="10"
stroke-dasharray="12.1939,12.1939"
x1="1953.068"
y1="144.193"
x2="1953.068"
y2="723.403"
id="line143" /><line
fill="none"
stroke="#000000"
stroke-width="2"
stroke-miterlimit="10"
x1="1953.068"
y1="729.5"
x2="1953.068"
y2="735.5"
id="line145" /></g></g><rect
x="1156.932"
y="169.729"
fill="#820E0A"
stroke="#000000"
stroke-width="2"
stroke-linejoin="round"
stroke-miterlimit="10"
width="12"
height="537.771"
id="rect147" /><rect
x="1420.106"
y="169.729"
fill="#820E0A"
stroke="#000000"
stroke-width="2"
stroke-linejoin="round"
stroke-miterlimit="10"
width="12"
height="158.771"
id="rect149" /><rect
x="1420.106"
y="386"
fill="#820E0A"
stroke="#000000"
stroke-width="2"
stroke-linejoin="round"
stroke-miterlimit="10"
width="12"
height="319.635"
id="rect151" /><rect
x="1946.068"
y="612.5"
fill="#820E0A"
stroke="#000000"
stroke-width="2"
stroke-linejoin="round"
stroke-miterlimit="10"
width="12"
height="92.089"
id="rect153" /><g
id="g155"><g
id="g157"><line
fill="none"
stroke="#000000"
stroke-width="2"
stroke-linejoin="round"
x1="1182.5"
y1="169.729"
x2="1394.43"
y2="169.729"
id="line159" /><g
id="g161"><path
d="M1406.5,169.729c-5.68,2.107-12.727,5.703-17.095,9.512l3.44-9.512l-3.44-9.51 C1393.773,164.028,1400.82,167.624,1406.5,169.729z"
id="path163" /></g></g></g><g
id="g165"><g
id="g167"><line
fill="none"
stroke="#000000"
stroke-width="2"
stroke-linejoin="round"
x1="1182.5"
y1="383.729"
x2="1394.43"
y2="383.729"
id="line169" /><g
id="g171"><path
d="M1406.5,383.729c-5.68,2.107-12.727,5.703-17.095,9.512l3.44-9.512l-3.44-9.509 C1393.773,378.027,1400.82,381.623,1406.5,383.729z"
id="path173" /></g></g></g><g
id="g175"><g
id="g177"><line
fill="none"
stroke="#000000"
stroke-width="2"
stroke-linejoin="round"
x1="1706.5"
y1="612.5"
x2="1918.43"
y2="612.5"
id="line179" /><g
id="g181"><path
d="M1930.5,612.5c-5.68,2.107-12.727,5.703-17.095,9.512l3.44-9.512l-3.44-9.51 C1917.773,606.799,1924.82,610.395,1930.5,612.5z"
id="path183" /></g></g></g><rect
x="1686.436"
y="386"
fill="#820E0A"
stroke="#000000"
stroke-width="2"
stroke-linejoin="round"
stroke-miterlimit="10"
width="12"
height="226.5"
id="rect185" /><g
id="g187"><g
id="g189"><line
fill="none"
stroke="#000000"
stroke-width="2"
stroke-linejoin="round"
x1="1450.436"
y1="386"
x2="1662.365"
y2="386"
id="line191" /><g
id="g193"><path
d="M1674.436,386c-5.68,2.107-12.727,5.703-17.095,9.512l3.44-9.512l-3.44-9.51 C1661.709,380.299,1668.756,383.895,1674.436,386z"
id="path195" /></g></g></g><g
id="g197"><g
id="g199"><line
fill="none"
stroke="#000000"
stroke-width="2"
stroke-linejoin="round"
x1="1460.506"
y1="704.589"
x2="1930.5"
y2="704.589"
id="line201" /><g
id="g203"><path
d="M1448.436,704.589c5.68,2.107,12.727,5.703,17.095,9.512l-3.44-9.512l3.44-9.51 C1461.162,698.888,1454.115,702.483,1448.436,704.589z"
id="path205" /></g></g></g><rect
x="1180.068"
y="134.706"
fill="none"
width="228.863"
height="33.317"
id="rect207" /><text
transform="matrix(1 0 0 1 1180.0684 145.3457)"
id="text209"><tspan
x="0"
y="0"
font-family="'OpenSans'"
font-size="14"
id="tspan211">Register nodes’</tspan><tspan
x="0"
y="16.8"
font-family="'OpenSans'"
font-size="14"
id="tspan213">power management details</tspan></text>
<rect
x="1182.5"
y="348.047"
fill="none"
width="228.863"
height="33.316"
id="rect215" /><text
transform="matrix(1 0 0 1 1182.5 375.4868)"
font-family="'OpenSans'"
font-size="14"
id="text217">Send nodes for introspection</text>
<rect
x="1448.004"
y="350.047"
fill="none"
width="228.863"
height="33.316"
id="rect219" /><text
id="text221"
x="1442.0039"
y="360.68701"><tspan
x="1442.0039"
y="360.68701"
font-size="14"
id="tspan223"
style="font-size:14px;font-family:OpenSans"> Reboot nodes -&gt; PXE boot generic</tspan></text>
<text
id="text4413"
x="1448.0039"
y="374.68701"><tspan
x="1448.0039"
y="374.68701"
font-size="14"
style="font-size:14px;font-family:OpenSans"
id="tspan4415">introspection ramdisk image</tspan><tspan
x="1448.0039"
y="391.48599"
font-size="14"
id="tspan225"
style="font-size:14px;font-family:OpenSans" /></text>
<rect
x="1584.004"
y="669.545"
fill="none"
width="346.496"
height="33.316"
id="rect227" /><text
font-size="14"
id="text229"
x="1585.0186"
y="696.98438"
style="font-size:14px;font-family:OpenSans">Facts checking and registration of hardware details</text>
<rect
x="1705.068"
y="579.184"
fill="none"
width="228.863"
height="33.316"
id="rect231" /><text
transform="matrix(1 0 0 1 1705.0684 606.623)"
font-family="'OpenSans'"
font-size="14"
id="text233">Post hardware metrics</text>
<g
id="g235"><g
id="g237"><line
fill="none"
stroke="#000000"
stroke-width="2"
stroke-linejoin="round"
x1="1192.139"
y1="321.729"
x2="1404.068"
y2="321.729"
id="line239" /><g
id="g241"><path
d="M1180.068,321.729c5.68,2.107,12.727,5.703,17.095,9.512l-3.44-9.512l3.44-9.51 C1192.795,316.027,1185.748,319.623,1180.068,321.729z"
id="path243" /></g></g></g><rect
x="1179.068"
y="286.047"
fill="none"
width="228.863"
height="33.316"
id="rect245" /><text
transform="matrix(1 0 0 1 1295.7676 313.4868)"
font-family="'OpenSans'"
font-size="14"
id="text247">Nodes registered</text>
<rect
x="1258.858"
y="748.158"
fill="none"
width="346.496"
height="33.316"
id="rect249" /><text
transform="matrix(1 0 0 1 1341.6709 758.7988)"
id="text251"><tspan
x="0"
y="0"
font-family="'OpenSans-Bold'"
font-size="14"
id="tspan253">Nodes are fully registered</tspan><tspan
x="-38.877"
y="16.799"
font-family="'OpenSans-Bold'"
font-size="14"
id="tspan255">wth full stack of hardware attributes</tspan></text>
</svg>
Side by Side

After

Width:  |  Height:  |  Size: 20 KiB

8
doc/source/advanced_deployment/automated_health_check.rst
View File

@ -4,10 +4,10 @@ Automated Health Check (AHC)
Start with matching the nodes to profiles as described in
:doc:`profile_matching`.
Enable running benchmarks during discovery
------------------------------------------
Enable running benchmarks during introspection
----------------------------------------------
By default, the benchmark tests do not run during the discovery process.
By default, the benchmark tests do not run during the introspection process.
You can enable this feature by setting *inspection_runbench = true* in the
**undercloud.conf** file prior to installing the undercloud.
@ -18,7 +18,7 @@ If you want to enable this feature after installing the undercloud, you can set
Analyze the collected benchmark data
------------------------------------
After discovery has completed, we can do analysis on the benchmark data.
After introspection has completed, we can do analysis on the benchmark data.
* Run the ``ahc-report`` script to see a general overview of the hardware

18
doc/source/advanced_deployment/profile_matching.rst
View File

@ -13,12 +13,12 @@ Enable advanced profile matching
* Add the credentials for Ironic and Swift to the
**/etc/ahc-tools/ahc-tools.conf** file.
These will be the same credentials that ironic-discoverd uses,
and can be copied from **/etc/ironic-discoverd/discoverd.conf**::
These will be the same credentials that ironic-inspector uses,
and can be copied from **/etc/ironic-inspector/inspector.conf**::
$ sudo -i
# mkdir -p /etc/ahc-tools
# sed 's/\[discoverd/\[ironic/' /etc/ironic-discoverd/discoverd.conf > /etc/ahc-tools/ahc-tools.conf
# sed 's/\[discoverd/\[ironic/' /etc/ironic-inspector/inspector.conf > /etc/ahc-tools/ahc-tools.conf
# chmod 0600 /etc/ahc-tools/ahc-tools.conf
# exit
@ -43,19 +43,19 @@ Every introspection run (as described in
:doc:`../basic_deployment/basic_deployment_cli`) collects a lot of additional
facts about the hardware and puts them as JSON in Swift. Swift container name
is ``ironic-inspector`` and can be modified in
**/etc/ironic-discoverd/discoverd.conf**. Swift object name is stored under
**/etc/ironic-inspector/inspector.conf**. Swift object name is stored under
``hardware_swift_object`` key in Ironic node extra field.
As an example, to download the swift data for all nodes to a local directory
and use that to collect a list of node mac addresses::
# You will need the discoverd user password
# from /etc/ironic-discoverd/discoverd.conf:
export IRONIC_DISCOVERD_PASSWORD=
# You will need the ironic-inspector user password
# from /etc/ironic-inspector/inspector.conf:
export IRONIC_INSPECTOR_PASSWORD=
# Download the extra introspection data from swift:
for node in $(ironic node-list | grep -v UUID| awk '{print $2}');
do swift -U service:ironic -K $IRONIC_DISCOVERD_PASSWORD download ironic-discoverd extra_hardware-$node;
do swift -U service:ironic -K $IRONIC_INSPECTOR_PASSWORD download ironic-inspector extra_hardware-$node;
done
# Use jq to access the local data - for example gather macs:
@ -107,7 +107,7 @@ There is a set of helper functions to make matching more flexible.
There are also placeholders, *$disk* and *$eth* in the above example.
These will store the value in that place for later use.
* For example if we had a "fact" from discovery::
* For example if we had a "fact" from introspection::
('disk', 'sda', 'size', '40')

27
doc/source/introduction/architecture.rst
View File

@ -206,21 +206,21 @@ fields out and run introspection of the nodes afterwards.
The sequence of events is pictured below:
.. image:: ../_images/discovery_diagram.png
.. image:: ../_images/introspection_diagram.png
* The user, via the command-line tools, or through direct API calls,
registers the power management credentials for a node with Ironic.
* The user then instructs Ironic to reboot the node.
* Because the node is new, and not already fully registered, there are no
specific PXE-boot instructions for it. In that case, the default action is to
boot into a discovery ramdisk
* The discovery ramdisk probes the hardware on the node and gathers facts,
boot into an introspection ramdisk
* The introspection ramdisk probes the hardware on the node and gathers facts,
including the number of CPU cores, the local disk size and the amount of RAM.
* The ramdisk posts the facts to the discoverd API.
* The ramdisk posts the facts to the ironic-inspector API.
* All facts are passed and stored in the Ironic database.
* There can be performed advanced role matching via the ''ahc-match'' tool,
which simply adds an additional role categorization to Ironic based on
discovered node facts and specified conditions.
introspected node facts and specified conditions.
Flavors
@ -234,12 +234,13 @@ hasn't reached their quota limit, the flavor acts as a set of instructions on
exactly what kind of VM to create on the user's behalf.
In the undercloud, where the machines are usually physical rather than virtual
(or, at least, pre-existing, rather than created on demand), flavors have a
slightly different effect. Essentially, they act as a constraint. Of all of the
discovered hardware, only nodes which match a specified flavor are suitable for
a particular role. This can be used to ensure that the large machines with a
great deal of RAM and CPU capacity are used to run Nova in the overcloud, and
the smaller machines run less demanding services, such as Keystone.
(or, at least, pre-existing, rather than created on demand), flavors have
a slightly different effect. Essentially, they act as a constraint. Of all of
the introspected hardware, only nodes which match a specified flavor are
suitable for a particular role. This can be used to ensure that the large
machines with a great deal of RAM and CPU capacity are used to run Nova in the
overcloud, and the smaller machines run less demanding services, such as
Keystone.
The version of TripleO included in |project| is capable of handling flavors in
two different modes.
@ -319,8 +320,8 @@ a stack.
In order to the stack to be deployed, Heat makes successive calls to Nova,
OpenStack's compute service controller. Nova depends upon Ironic, which, as
described above has acquired an inventory of discovered hardware by this stage
in the process.
described above has acquired an inventory of introspected hardware by this
stage in the process.
At this point, Nova flavors may act as a constraint, influencing the range of
machines which may be picked for deployment by the Nova scheduler. For each

14
doc/source/introduction/components.rst
View File

@ -217,9 +217,6 @@ ironic inspector (former ironic-discoverd)
Ironic Inspector project is responsible for inspection of hardware properties
for newly enrolled nodes (see also ironic_).
Ironic Inspector was called ironic-discoverd previously, and the RPM packages
are still based on the old version, so they are using the old name for now.
**How to contribute**
Ironic Inspector uses `tox <https://tox.readthedocs.org/en/latest/>`_ to manage
@ -231,10 +228,6 @@ for details.
* Upstream Project: https://github.com/openstack/ironic-inspector
* PyPI: https://pypi.python.org/pypi/ironic-inspector
Also https://pypi.python.org/pypi/ironic-discoverd for the old version which
|project| currently uses.
* Bugs: https://bugs.launchpad.net/ironic-inspector
* Blueprints: https://blueprints.launchpad.net/ironic-inspector
@ -412,10 +405,9 @@ command with consistent syntax and behaviour.
python-tripleoclient
^^^^^^^^^^^^^^^^^^^^
The python-tripleoclient is a CLI tool embedded into
python-openstackclient. It provides functions related to instack
installation and initial configuration like node discovery, overcloud image
building and uploading, etc.
The python-tripleoclient is a CLI tool embedded into python-openstackclient. It
provides functions related to instack installation and initial configuration
like node introspection, overcloud image building and uploading, etc.
**How to contribute**

65
doc/source/troubleshooting/troubleshooting-nodes.rst
View File

@ -1,27 +1,27 @@
Troubleshooting Node Management Failures
-----------------------------------
----------------------------------------
Where Are the Logs?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^
Some logs are stored in *journald*, but most are stored as text files in
``/var/log``. Ironic and ironic-discoverd logs are stored in journald. Note
``/var/log``. Ironic and ironic-inspector logs are stored in journald. Note
that Ironic has 2 units: ``openstack-ironic-api`` and
``openstack-ironic-conductor``. Similarly, ironic-discoverd has
``openstack-ironic-discoverd`` and ``openstack-ironic-discoverd-dnsmasq``. So
for example to get all ironic-discoverd logs use::
``openstack-ironic-conductor``. Similarly, ironic-inspector has
``openstack-ironic-inspector`` and ``openstack-ironic-inspector-dnsmasq``. So
for example to get all ironic-inspector logs use::
sudo journalctl -u openstack-ironic-discoverd -u openstack-ironic-discoverd-dnsmasq
sudo journalctl -u openstack-ironic-inspector -u openstack-ironic-inspector-dnsmasq
If something fails during the discovery ramdisk run, ironic-discoverd
stores the ramdisk logs in ``/var/log/ironic-discoverd/ramdisk/`` as
If something fails during the introspection ramdisk run, ironic-inspector
stores the ramdisk logs in ``/var/log/ironic-inspector/ramdisk/`` as
gz-compressed tar files. File names contain date, time and IPMI address of the
node if it was detected (only for bare metal).
.. _node_registration_problems:
Node Registration Problems
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^^^^
Any problems with node data registered into Ironic can be fixed using the
Ironic CLI.
@ -46,46 +46,47 @@ A Wrong IPMI address can be fixed with the following command::
.. _introspection_problems:
Hardware Introspection Problems
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Introspection hangs and times out
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Discovery hangs and times out
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
ironic-discoverd times out discovery process after some time (defaulting to 1
hour) if it never gets response from the discovery ramdisk. This can be
a sign of a bug in the discovery ramdisk, but usually it happens due to
ironic-inspector times out introspection process after some time (defaulting to
1 hour) if it never gets response from the introspection ramdisk. This can be
a sign of a bug in the introspection ramdisk, but usually it happens due to
environment misconfiguration, particularly BIOS boot settings. Please refer to
`ironic-discoverd troubleshooting documentation`_ for information on how to
`ironic-inspector troubleshooting documentation`_ for information on how to
detect and fix such problems.
Refusing to introspect node with provision state "available"
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If you're running discovery directly using ironic-discoverd CLI (or in case of
bugs in our scripts), a node can be in the "AVAILABLE" state, which is meant for
deployment, not for discovery. You should advance node to the "MANAGEABLE" state
before discovery and move it back before deployment.
If you're running introspection directly using ironic-inspector CLI (or in case
of bugs in our scripts), a node can be in the "AVAILABLE" state, which is meant
for deployment, not for introspection. You should advance node to the
"MANAGEABLE" state before introspection and move it back before deployment.
Please refer to `upstream node states documentation
<https://github.com/openstack/ironic-inspector#node-states>`_ for information
on how to fix it.
How can discovery be stopped?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
How can introspection be stopped?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Currently ironic-discoverd does not provide means for stopping discovery. The
recommended path is to wait until it times out. Changing ``timeout`` setting
in ``/etc/ironic-discoverd/discoverd.conf`` may be used to reduce this timeout
from 1 hour (which usually too much, especially on virtual environment).
Currently ironic-inspector does not provide means for stopping introspection.
The recommended path is to wait until it times out. Changing ``timeout``
setting in ``/etc/ironic-inspector/inspector.conf`` may be used to reduce this
timeout from 1 hour (which usually too much, especially on virtual
environment).
If you do need to stop discovery **for all nodes** right now, do the
If you do need to stop introspection **for all nodes** right now, do the
following for each node::
ironic node-set-power-state UUID off
then remove ironic-discoverd cache and restart it::
then remove ironic-inspector cache and restart it::
rm /var/lib/ironic-discoverd/discoverd.sqlite
sudo systemctl restart openstack-ironic-discoverd
rm /var/lib/ironic-inspector/inspector.sqlite
sudo systemctl restart openstack-ironic-inspector
.. _ironic-discoverd troubleshooting documentation: https://github.com/openstack/ironic-inspector#troubleshooting
.. _ironic-inspector troubleshooting documentation: https://github.com/openstack/ironic-inspector#troubleshooting