Skip to content

Commit 4addb44

Browse files
committed
Add more instruction for ADVise tool
1 parent c4a16ec commit 4addb44

File tree

1 file changed

+26
-4
lines changed

1 file changed

+26
-4
lines changed

doc/source/operations/hardware-inventory-management.rst

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -228,6 +228,8 @@ The playbook has the following optional parameters:
228228
- output_dir: path to where results should be saved. Default: ``"{{ lookup('env', 'PWD') }}/review"``
229229
- advise-pattern: regular expression to specify what introspection data should be analysed. Default: ``".*.eval"``
230230

231+
You can override them by provide new values with ``-e <variable>=<value>``
232+
231233
Example command to run the tool on data about the compute nodes in a system, where compute nodes are named cpt01, cpt02, cpt03…:
232234

233235
.. code-block:: console
@@ -244,10 +246,30 @@ Using the results
244246
The ADVise tool will output a selection of results found under output_dir/results these include:
245247

246248
- ``.html`` files to display network visualisations of any hardware differences.
247-
- The folder ``Paired_Comparisons`` which contains information on the shared and differing fields found between the systems. This is a reflection of the network visualisation webpage, with more detail as to what the differences are.
249+
- The folder ``Paired_Comparisons`` which contains information on the shared and differing fields found between the systems.
250+
This is a reflection of the network visualisation webpage, with more detail as to what the differences are.
248251
- ``_summary``, a listing of how the systems can be grouped into sets of identical hardware.
249252
- ``_performance``, the results of analysing the benchmarking data gathered.
250-
- ``_perf_summary``, a subset of the performance metrics, just showing any potentially anomalous data such as where variance is too high, or individual nodes have been found to over/underperform.
253+
- ``_perf_summary``, a subset of the performance metrics, just showing any potentially anomalous data such as where variance
254+
is too high, or individual nodes have been found to over/underperform.
255+
256+
The ADVise tool will also launch an interactive Dash webpage, which displays the network visualisations,
257+
tables with information on the differing hardware attributes, the performance metrics as a range of box-plots,
258+
and specifies which individual nodes may be anomalous via box-plot outliers. This can be accessed at ``localhost:8050``.
259+
To close this service, simply ``Ctrl+C`` in the terminal where you ran the playbook.
260+
261+
To get visuallised result, It is recommanded to copy instrospection data to your local machine then run ADVise playbook locally.
262+
263+
Recommanded Workflow
264+
--------------------
251265

252-
To get visuallised result, It is recommanded to copy instrospection data and review directories to your
253-
local machine then run ADVise playbook locally with the data.
266+
1. Run the playbook as outlined above.
267+
2. Open the Dash webpage at ``localhost:8050``.
268+
3. Review the hardware differences. Note that hovering over a group will display the nodes it contains.
269+
4. Identify any unexpected differences in the systems. If multiple differing fields exist they will be graphed separately.
270+
As an example, here we expected all compute nodes to be identical.
271+
5. Use the dropdown menu beneath each graph to show a table of the differences found between two sets of groups.
272+
If required, information on shared fields can be found under ``output_dir/results/Paired_Comparisons``.
273+
6. Scroll down the webpage to the performance review. Identify if any of the discovered performance results could be
274+
indicative of a larger issue.
275+
7. Examine the ``_performance`` and ``_perf_summary`` files if you require any more information.

0 commit comments

Comments
 (0)