Added a new item to the modules enea Dir,feature_CPDX-3263

Added a new section Automated Deployment Reporting.

Change-Id: I64f2437118526457b2925e397430594c21ee23c9
Signed-off-by: mrpa <miruna.paun@enea.com>

1 files changed, 113 insertions, 0 deletions

diff --git a/doc/book-enea-edge-automation-user-guide/doc/automation_framework_test_harness.xml b/doc/book-enea-edge-automation-user-guide/doc/automation_framework_test_harness.xml
index 6111f20..5cc879d 100644
--- a/doc/book-enea-edge-automation-user-guide/doc/automation_framework_test_harness.xml
+++ b/doc/book-enea-edge-automation-user-guide/doc/automation_framework_test_harness.xml
@@ -150,6 +150,12 @@
           <para><literal>VNF_images</literal> - contains the VNF images that
           are used in test scenarios.</para>
         </listitem>
+
+        <listitem>
+          <para><literal>utils</literal> - contains configurable solutions for
+          different features. For example, the solution for automated
+          deployment reporting can be found under this directory.</para>
+        </listitem>
       </itemizedlist>
     </section>
 
@@ -1587,4 +1593,111 @@ vnfi_name: "fortigateFWInstance"</programlisting>
     Management application are provided in the <literal>README</literal> file
     from scenario in use.</para>
   </section>
+
+  <section id="auto_deploy_reporting">
+    <title>Automated Deployment Reporting</title>
+
+    <para>The Deployment Reporting functionality will generate a CSV file
+    containing information about all uCPE Devices deployed with Enea Edge and
+    enrolled into the Enea Edge Management application.</para>
+
+    <para>The Python script for this solution is available in
+    <filename>modules/enea/utils/reporting/generate_deployment_report.py</filename>.</para>
+
+    <para>The information about uCPE Devices that will be found in the CSV
+    file is following:</para>
+
+    <itemizedlist>
+      <listitem>
+        <para>Device Name</para>
+      </listitem>
+
+      <listitem>
+        <para>Device ID</para>
+      </listitem>
+
+      <listitem>
+        <para>Enea Edge Runtime version</para>
+      </listitem>
+
+      <listitem>
+        <para>Number of CPU cores - If the device is disconnected, a warning
+        message appears in this field.</para>
+      </listitem>
+
+      <listitem>
+        <para>Timestamp when the device was added in the Enea Edge Management
+        application - If the device was never connected, a warning message
+        appears in this file.</para>
+      </listitem>
+
+      <listitem>
+        <para>The Enea Edge Management application IP or FQDN.</para>
+      </listitem>
+    </itemizedlist>
+
+    <para>Prerequisities:</para>
+
+    <orderedlist>
+      <listitem>
+        <para>Modify the Enea Edge Management configuration file, see "4.2.1
+        Configuration Files for the Enea Edge Management application" from
+        "Enea® Edge Automation User Guide" for more details.<remark>Add Olink
+        here</remark></para>
+      </listitem>
+
+      <listitem>
+        <para>For reporting devices connected to one Enea Edge Management
+        application instance, update the
+        <filename>modules/enea/config/Management/management01.json</filename>
+        file.</para>
+      </listitem>
+
+      <listitem>
+        <para>For reporting devices connected to multiple Enea Edge Management
+        application instances, a new JSON file will be created for
+        each.</para>
+
+        <para>The JSON file must have the following structure:</para>
+
+        <programlisting>{
+  "ucpe_usr":"&lt;Management Username&gt;",
+  "ucpe_pass":"&lt;Management Password&gt;",
+  "ucpe_host":"&lt;Management IP or FQDN&gt;"
+}</programlisting>
+
+        <para>All JSON files should be saved in the same directory and the
+        path to the directory will be a parameter of the script
+        (<literal>-m/--managements_directory</literal>).</para>
+      </listitem>
+
+      <listitem>
+        <para>Run the Python script to generate the CSV reporting:</para>
+
+        <programlisting>&gt; python modules/enea/utils/reporting/generate_deployment_report.py --help
+Usage: generate_deployment_report.py [OPTIONS]
+
+Options:
+  -r, --report_directory TEXT     The directory where the report will be
+                                  saved. Default: the current directory
+
+  -f, --filename TEXT             The name of the CSV report. Default:
+                                  Devices.csv
+
+  -t, --timestamp                 Append the timestamp to the filename.
+                                  Default: False
+
+  -m, --managements_directory TEXT
+                                  The directory where the JSON config files
+                                  for the Edge Management applications are
+                                  saved. Default:
+                                  ./modules/enea/config/Management/
+
+  -v, --version                   Display the version of the Edge Automation
+                                  and exit
+
+  --help                          Show this message and exit.</programlisting>
+      </listitem>
+    </orderedlist>
+  </section>
 </chapter>
\ No newline at end of file