17678: implement review feedback.

Arvados-DCO-1.1-Signed-off-by: Ward Vandewege <ward@curii.com>

diff --git a/doc/user/cwl/costanalyzer.html.textile.liquid b/doc/user/cwl/costanalyzer.html.textile.liquid
index 70a1be5dacdc667dcad8447b11f4d11a1c900eeb..fc39ada523a314605af92f97b9fdb8bff91b465e 100644 (file)
--- a/doc/user/cwl/costanalyzer.html.textile.liquid
+++ b/doc/user/cwl/costanalyzer.html.textile.liquid
@@ -24,7 +24,7 @@ The @arvados-client costanalyzer@ tool has a number of command line arguments:
 <notextile>
 <pre><code>~$ <span class="userinput">arvados-client costanalyzer -h</span>
 Usage:
-  arvados-client costanalyzer [options ...] <uuid> ...
+  arvados-client costanalyzer [options ...] uuid [uuid ...]
 
   This program analyzes the cost of Arvados container requests. For each uuid
   supplied, it creates a CSV report that lists all the containers used to
@@ -59,6 +59,13 @@ Usage:
   a column that indicates the preemptible state of the instance that ran the
   container.
 
+  - This program does not take into account overhead costs like the time spent
+  starting and stopping compute nodes that run containers, the cost of the
+  permanent cloud nodes that provide the Arvados services, the cost of data
+  stored in Arvados, etc.
+
+  - When provided with a project uuid, subprojects will not be considered.
+
   In order to get the data for the uuids supplied, the ARVADOS_API_HOST and
   ARVADOS_API_TOKEN environment variables must be set.
 

diff --git a/lib/costanalyzer/costanalyzer.go b/lib/costanalyzer/costanalyzer.go
index df8fd496051143292219822bf0fb933fd08d17bf..402e0ec81a160e677a1aefb8df82d589f01c3e20 100644 (file)
--- a/lib/costanalyzer/costanalyzer.go
+++ b/lib/costanalyzer/costanalyzer.go
@@ -57,7 +57,7 @@ func parseFlags(prog string, args []string, loader *config.Loader, logger *logru
        flags.Usage = func() {
                fmt.Fprintf(flags.Output(), `
 Usage:
-  %s [options ...] <uuid> ...
+  %s [options ...] uuid [uuid ...]
 
        This program analyzes the cost of Arvados container requests. For each uuid
        supplied, it creates a CSV report that lists all the containers used to
@@ -92,6 +92,13 @@ Usage:
        a column that indicates the preemptible state of the instance that ran the
        container.
 
+       - This program does not take into account overhead costs like the time spent
+       starting and stopping compute nodes that run containers, the cost of the
+       permanent cloud nodes that provide the Arvados services, the cost of data
+       stored in Arvados, etc.
+
+       - When provided with a project uuid, subprojects will not be considered.
+
        In order to get the data for the uuids supplied, the ARVADOS_API_HOST and
        ARVADOS_API_TOKEN environment variables must be set.