update of READMEs

3 files changed, 25 insertions, 6 deletions

diff --git a/node-maintainer/README.md b/node-maintainer/README.md
index a76fccc8de9..06b20689aaf 100644
--- a/node-maintainer/README.md
+++ b/node-maintainer/README.md
@@ -6,3 +6,15 @@ Node admin maintenance runs as a separate JVM from node-admin to make it possibl
 ## Node Verification
 Node verification for both hardware and spec. Hardware is verified by performing different benchmarking tasks, 
 while spec is verified by comparing information reported by the OS with the spec from node repository.
+
+### Execute examples
+Spec verification and hardware benchmarks can both be executed with and without config server host name as parameter 
+(if called without parameters it will use yinst to retrieve the host name):
+
+SpecVerifier:
+- java -cp node-maintainer-jar-with-dependencies.jar com.yahoo.vespa.hosted.node.verification.spec.SpecVerifier
+- java -cp node-maintainer-jar-with-dependencies.jar com.yahoo.vespa.hosted.node.verification.spec.SpecVerifier cfg.1.hostname,cfg.2.hostname,...
+
+HardwareBenchmarker:
+- java -cp node-maintainer-jar-with-dependencies.jar com.yahoo.vespa.hosted.node.verification.hardware.HardwareBenchmarker
+- java -cp node-maintainer-jar-with-dependencies.jar com.yahoo.vespa.hosted.node.verification.hardware.HardwareBenchmarker cfg.1.hostname,cfg.2.hostname,...
\ No newline at end of file
diff --git a/node-maintainer/src/main/java/com/yahoo/vespa/hosted/node/verification/hardware/README.md b/node-maintainer/src/main/java/com/yahoo/vespa/hosted/node/verification/hardware/README.md
index c995739d255..e9fa4901814 100644
--- a/node-maintainer/src/main/java/com/yahoo/vespa/hosted/node/verification/hardware/README.md
+++ b/node-maintainer/src/main/java/com/yahoo/vespa/hosted/node/verification/hardware/README.md
@@ -4,5 +4,5 @@ A report is sent to the node repository if any of the results are below an accep
 
 ## Code Walkthrough
 The main class, HardwareBenchmarker, calls every benchmark in the benchmark package. The results of these benchmarks are passed through
-the BenchmarkResultInstructor, which creates a report containing the values below the accepted threshold. If the report is non-empty,
-the node repository is updated with the poor benchmark result.
\ No newline at end of file
+the BenchmarkResultInspector, which creates a BenchmarkReport containing the values below the accepted threshold. ReportSender is then called such that
+the node repository is updated with the new benchmark results.
\ No newline at end of file
diff --git a/node-maintainer/src/main/java/com/yahoo/vespa/hosted/node/verification/spec/README.md b/node-maintainer/src/main/java/com/yahoo/vespa/hosted/node/verification/spec/README.md
index caddf3adf9e..d335c0310a0 100644
--- a/node-maintainer/src/main/java/com/yahoo/vespa/hosted/node/verification/spec/README.md
+++ b/node-maintainer/src/main/java/com/yahoo/vespa/hosted/node/verification/spec/README.md
@@ -2,7 +2,14 @@
 Verifies that the spec information in node repo coincides with what found on the node and reports back to node repo. 
 
 ## Code "walkthrough"
-The main class SpecVerifier uses the "noderepo" package to retrieve node spec from node repo. 
-It can be called with one parameter, the config server hostname, or with none (it will then use yinst to retrieve config server host name). It finds hostname using "HostURLGenerator" in the "commons" package.
-It then retrieves all the hardware information at the node with the "retrievers" package and stores the values as a "HardwareInfo" object. 
-SpecVerifier then uses HardwareNodeComparator to compare spec from node repo and the node itself and uses the "report" package to generate a report and to report back to node repo. 
\ No newline at end of file
+The main class SpecVerifier uses the "noderepo" package in "commons" to retrieve node spec from node repo. 
+
+It can be called with one parameter, the config server hostname, or with none (it will in this case use yinst to 
+retrieve config server host name). It finds hostname using "HostURLGenerator" in the "commons" package.
+
+It then retrieves all the hardware information at the node with the "retrievers" package and stores the values as a 
+"HardwareInfo" object. 
+
+SpecVerifier then uses HardwareNodeComparator to compare spec from node repo and the node itself. It generates a 
+SpecVerificationReport and uses ReportSender in "commons" to generate a full json report that can update node repo
+with the new results.