Updated the Automation User Guide and Getting Started Manuals

with the edits needed and uniformization of installerdir terms.

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

8 files changed, 174 insertions, 154 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 bdc3343..0d25bd7 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
@@ -76,10 +76,10 @@
         </listitem>
       </itemizedlist>
 
-      <para>Where the <filename>environment_variables.sh</filename> script
-      sets the environment variables. The
-      <filename>setup_env_requirements.txt</filename> contains the mapping
-      between the package name and its version, and the
+      <para>The <filename>environment_variables.sh</filename> script sets the
+      environment variables, the
+      <filename>setup_env_requirements.txt</filename> file contains the
+      mapping between the package name and its version, and the
       <filename>setup_env.sh</filename> script creates a testing virtual
       environment.</para>
 
@@ -317,7 +317,7 @@
         </listitem>
 
         <listitem>
-          <para>Update the username, password and IP address</para>
+          <para>Update the username, password and IP address or FQDN.</para>
 
           <note>
             <para>The
@@ -751,7 +751,7 @@ Check 'test' directory for JSON configuration files</programlisting>
 
     <para>The Automation Framework scripts described in the following section
     are located in the
-    <literal>&lt;Automation-installdir&gt;/automation_framework</literal>
+    <literal>&lt;Automation-installerdir&gt;/automation_framework</literal>
     directory.</para>
 
     <section id="httpclient_class">
@@ -1302,7 +1302,7 @@ Parameters(not needed): --
     <title>Test Harness</title>
 
     <para>The Test Harness sources are in the
-    <literal>&lt;Automation-installdir&gt;/test_harness</literal>
+    <literal>&lt;Automation-installerdir&gt;/test_harness</literal>
     directory.</para>
 
     <section id="indiv_ansible_playbooks">
diff --git a/doc/book-enea-edge-automation-user-guide/doc/components.xml b/doc/book-enea-edge-automation-user-guide/doc/components.xml
index cb6c783..2323fdf 100644
--- a/doc/book-enea-edge-automation-user-guide/doc/components.xml
+++ b/doc/book-enea-edge-automation-user-guide/doc/components.xml
@@ -1,8 +1,9 @@
-<?xml version="1.0" encoding="ISO-8859-1"?>
+<?xml version="1.0" encoding="UTF-8"?>
 <chapter id="components">
   <title>Components</title>
 
-  <para>This chapter presents an overview of the Enea Edge components: Enea Edge Runtime, Enea Edge Management and Enea Edge Automation.</para>
+  <para>This chapter presents an overview of the Enea Edge components: Enea
+  Edge Runtime, Enea Edge Management and Enea Edge Automation.</para>
 
   <figure>
     <title>Component Overview</title>
@@ -15,97 +16,101 @@
     </mediaobject>
   </figure>
 
-    <section id="eucpe_manager">
-      <title>Enea Edge Management</title>
-
-      <para>The Enea Edge Management application is installed on a supported
-      platform. It manages Enea Edge <literal>devices</literal>, that
-      are virtualized CPE devices.</para>
-
-      <para>For more details about Enea Edge Management installation, see <olink
-      targetdoc="book_enea_edge_getting_started"
-      targetptr="install_ucpe_mg">Installing the Enea Edge Management application in the
-      <xi:include href="../../s_docbuild/olinkdb/pardoc-names.xml"
-      xmlns:xi="http://www.w3.org/2001/XInclude"
-      xpointer="element(book_enea_edge_getting_started/1)" /></olink>
-      Manual.</para>
-    </section>
-
-    <section id="ena_plat">
-      <title>Enea Edge Runtime</title>
-
-      <para>One or more uCPE devices running the Enea Edge Runtime
-      are required as hosts, to run the VNFs. The uCPE device is
-      known to the Enea Edge Management application as the <literal>VcpeAgent</literal> device
-      module.</para>
-
-      <para>Before running any use case with the Enea Edge Automation, the uCPE devices have to be added to the Enea Edge Management application.</para>
-
-      <para>Adding a <literal>VcpeAgent</literal> device can be done:</para>
-
-      <itemizedlist>
-        <listitem>
-          <para>using the Enea Edge Management GUI</para>
-        </listitem>
-
-        <listitem>
-          <para>using REST API</para>
-        </listitem>
-      </itemizedlist>
-
-      <para>For more details about Enea Edge installation, see <olink
-      targetdoc="book_enea_edge_getting_started"
-      targetptr="prep_usb_ena">Preparing the USB stick for installation of the
-      Edge Runtime in the <xi:include
-      href="../../s_docbuild/olinkdb/pardoc-names.xml"
-      xmlns:xi="http://www.w3.org/2001/XInclude"
-      xpointer="element(book_enea_edge_getting_started/1)" /></olink>
-      Manual.</para>
-    </section>
-        
-    <section id="automation">
-      <title>Enea Edge Automation</title>
-          
-      <para>Enea Edge Automation has two components: Automation Framework and Test Harness.
-      It provides Python scripts using Enea Edge Management REST API and Ansible Playbooks.</para>
-          
-      <para>The Automation Framework component provides a Python unit-test suite that runs automatically the
-      test-cases defined for each Python script.</para>
-
-      <para>It is recommended to use a different host for running the tests, in
-      order to allow external users to access and use the Enea Edge Management application
-      effectively.</para>
-  
-      <para>The Test Harness component provides a way for driving configuration with
-      Ansible Playbooks, by running the Python modules from the Automation Framework component
-      and by direct connection over SSH to the boards that run Enea
-      Edge.</para>
-
-      <para>The Test Harness includes an automated test suite that
-      contains:</para>
-
-      <itemizedlist>
-        <listitem>
-          <para>VNF, Device and Network Smoke Test Cases. A sample test suite
-          that acts as basic smoke tests for Enea Edge and also as a
-          sanity-check test suite for the Enea Edge Automation.</para>
-        </listitem>
-
-        <listitem>
-          <para>VNF Deployment and Lifecycle. A sample test suite that verifies
-          the instantiation, lifecycle control and destruction of a VNF for Enea
-          Edge.</para>
-        </listitem>
-
-        <listitem>
-          <para>Service Creation and Lifecycle. A sample test suite that
-          contains complex test cases showcasing service creation and lifecycle
-          management.</para>
-        </listitem>
-      </itemizedlist>
-
-      <para>For more details about the test suites or test cases, see the README
-      file included in the test scenario folders from the Enea Edge Automation
-      archive.</para>
-    </section>
+  <section id="eucpe_manager">
+    <title>Enea Edge Management</title>
+
+    <para>The Enea Edge Management application is installed on a supported
+    platform. It manages Enea Edge <literal>devices</literal>, that are
+    virtualized CPE devices.</para>
+
+    <para>For more details about Enea Edge Management installation, see <olink
+    targetdoc="book_enea_edge_getting_started"
+    targetptr="install_ucpe_mg">Installing the Enea Edge Management
+    application in the <xi:include
+    href="../../s_docbuild/olinkdb/pardoc-names.xml"
+    xmlns:xi="http://www.w3.org/2001/XInclude"
+    xpointer="element(book_enea_edge_getting_started/1)" /></olink>
+    Manual.</para>
+  </section>
+
+  <section id="ena_plat">
+    <title>Enea Edge Runtime</title>
+
+    <para>One or more uCPE devices running the Enea Edge Runtime are required
+    as hosts, to run the VNFs. The uCPE device is known to the Enea Edge
+    Management application as the <literal>VcpeAgent</literal> device
+    module.</para>
+
+    <para>Before running any use case with the Enea Edge Automation, the uCPE
+    devices have to be added to the Enea Edge Management application.</para>
+
+    <para>Adding a <literal>VcpeAgent</literal> device can be done:</para>
+
+    <itemizedlist>
+      <listitem>
+        <para>using the Enea Edge Management GUI</para>
+      </listitem>
+
+      <listitem>
+        <para>using REST API</para>
+      </listitem>
+    </itemizedlist>
+
+    <para>For more details about the Enea Edge Runtime installation, see
+    <olink targetdoc="book_enea_edge_getting_started"
+    targetptr="prep_usb_ena">Preparing the USB stick for installation of the
+    Edge Runtime in the <xi:include
+    href="../../s_docbuild/olinkdb/pardoc-names.xml"
+    xmlns:xi="http://www.w3.org/2001/XInclude"
+    xpointer="element(book_enea_edge_getting_started/1)" /></olink>
+    Manual.</para>
+  </section>
+
+  <section id="automation">
+    <title>Enea Edge Automation</title>
+
+    <para>Enea Edge Automation has two components: Automation Framework and
+    Test Harness. It provides Python scripts using Enea Edge Management REST
+    API and Ansible Playbooks.</para>
+
+    <para>The Automation Framework component provides a Python unit-test suite
+    that runs automatically the test-cases defined for each Python
+    script.</para>
+
+    <para>It is recommended to use a different host for running the tests, in
+    order to allow external users to access and use the Enea Edge Management
+    application effectively.</para>
+
+    <para>The Test Harness component provides a way for driving configuration
+    with Ansible Playbooks, by running the Python modules from the Automation
+    Framework component and by direct connection over SSH to the boards that
+    run Enea Edge.</para>
+
+    <para>The Test Harness includes an automated test suite that
+    contains:</para>
+
+    <itemizedlist>
+      <listitem>
+        <para>VNF, Device and Network Smoke Test Cases. A sample test suite
+        that acts as basic smoke tests for Enea Edge and also as a
+        sanity-check test suite for the Enea Edge Automation.</para>
+      </listitem>
+
+      <listitem>
+        <para>VNF Deployment and Lifecycle. A sample test suite that verifies
+        the instantiation, lifecycle control and destruction of a VNF for Enea
+        Edge.</para>
+      </listitem>
+
+      <listitem>
+        <para>Service Creation and Lifecycle. A sample test suite that
+        contains complex test cases showcasing service creation and lifecycle
+        management.</para>
+      </listitem>
+    </itemizedlist>
+
+    <para>For more details about the test suites or test cases, see the README
+    file included in the test scenario folders from the Enea Edge Automation
+    archive.</para>
+  </section>
 </chapter>
\ No newline at end of file
diff --git a/doc/book-enea-edge-automation-user-guide/doc/getting_started.xml b/doc/book-enea-edge-automation-user-guide/doc/getting_started.xml
index c5b9568..536cea6 100644
--- a/doc/book-enea-edge-automation-user-guide/doc/getting_started.xml
+++ b/doc/book-enea-edge-automation-user-guide/doc/getting_started.xml
@@ -189,7 +189,7 @@
       </listitem>
 
       <listitem>
-        <para><programlisting>cd &lt;Automation-installdir&gt;</programlisting></para>
+        <para><programlisting>cd &lt;Automation-installerdir&gt;</programlisting></para>
       </listitem>
 
       <listitem>
@@ -222,13 +222,13 @@
       <listitem>
         <para>Activate the Python virtual environment</para>
 
-        <programlisting>source &lt;Automation-installdir&gt;/testHarness-venv/bin/activate</programlisting>
+        <programlisting>source &lt;Automation-installerdir&gt;/testHarness-venv/bin/activate</programlisting>
       </listitem>
 
       <listitem>
         <para>Optionally, check the History Information</para>
 
-        <programlisting>vi &lt;Automation-installdir&gt;/CHANGELOG</programlisting>
+        <programlisting>vi &lt;Automation-installerdir&gt;/CHANGELOG</programlisting>
       </listitem>
 
       <listitem>
@@ -251,7 +251,7 @@
       </listitem>
 
       <listitem>
-        <para><programlisting>cd &lt;Automation-installdir&gt;</programlisting></para>
+        <para><programlisting>cd &lt;Automation-installerdir&gt;</programlisting></para>
       </listitem>
 
       <listitem>
diff --git a/doc/book-enea-edge-automation-user-guide/doc/overview.xml b/doc/book-enea-edge-automation-user-guide/doc/overview.xml
index 30cc91f..78e5e82 100644
--- a/doc/book-enea-edge-automation-user-guide/doc/overview.xml
+++ b/doc/book-enea-edge-automation-user-guide/doc/overview.xml
@@ -1,24 +1,26 @@
-<?xml version="1.0" encoding="ISO-8859-1"?>
+<?xml version="1.0" encoding="UTF-8"?>
 <chapter id="overview">
   <title>Overview</title>
 
-  <para>This document describes the Enea Edge Automation for Enea Edge,
-  along with instructions regarding the necessary steps to run these software
+  <para>This document describes the Enea Edge Automation for Enea Edge, along
+  with instructions regarding the necessary steps to run these software
   tools.</para>
 
   <section id="descrip">
     <title>Description</title>
 
-     <para>The Enea Edge Automation complements the Enea Edge Management
-    GUI and uses the northbound REST APIs, given to provide full usability of
-    the Enea Edge Management features.</para>
-        
-     <para>The Enea Edge Automation includes an Automation Framework (AF) component, providing a way for driving
-    configuration with Python scripting, and a Test Harness (TH) component, based on Ansible Playbooks to complete different test
-    cases.</para>
-        
-     <para>The Test Harness makes use of the Automation Framework Python modules and/or
-    direct commands on the uCPE devices running the Enea Edge Runtime.</para>
+    <para>The Enea Edge Automation complements the Enea Edge Management GUI
+    and uses the northbound REST APIs, given to provide full usability of the
+    Enea Edge Management features.</para>
+
+    <para>The Enea Edge Automation includes an Automation Framework (AF)
+    component, providing a way for driving configuration with Python
+    scripting, and a Test Harness (TH) component, based on Ansible Playbooks
+    to complete different test cases.</para>
+
+    <para>The Test Harness makes use of the Automation Framework Python
+    modules and/or direct commands on the uCPE devices running the Enea Edge
+    Runtime.</para>
   </section>
 
   <section id="def_acro">
@@ -41,21 +43,29 @@
         <tbody>
           <row>
             <entry>Enea Edge</entry>
+
             <entry>Enea NFVI software platform.</entry>
           </row>
+
           <row>
             <entry>Enea Edge Runtime</entry>
-            <entry>A lightweight, multi-architecture virtualization platform, supporting Virtual Machines.</entry>
+
+            <entry>A lightweight, multi-architecture virtualization platform,
+            supporting Virtual Machines.</entry>
           </row>
+
           <row>
             <entry>Enea Edge Management</entry>
+
             <entry>Enea Universal Customer Premises Equipment Manager.</entry>
           </row>
+
           <row>
             <entry>Enea Edge Automation</entry>
-            <entry>Enea Edge framework for automated deployment and testing.</entry>
-          </row>
 
+            <entry>Enea Edge framework for automated deployment and
+            testing.</entry>
+          </row>
         </tbody>
       </tgroup>
     </table>
@@ -100,6 +110,12 @@
           </row>
 
           <row>
+            <entry>FQDN </entry>
+
+            <entry>Fully Qualified Domain Name.</entry>
+          </row>
+
+          <row>
             <entry>FTP</entry>
 
             <entry>File Transfer Protocol.</entry>
@@ -186,4 +202,4 @@
       </tgroup>
     </table>
   </section>
-</chapter>
+</chapter>
\ No newline at end of file
diff --git a/doc/book-enea-edge-getting-started/doc/installation_guide.xml b/doc/book-enea-edge-getting-started/doc/installation_guide.xml
index b68a6c4..a61e385 100644
--- a/doc/book-enea-edge-getting-started/doc/installation_guide.xml
+++ b/doc/book-enea-edge-getting-started/doc/installation_guide.xml
@@ -495,8 +495,8 @@ userdel postgres</programlisting>
             installation folder.</para>
 
             <para>The application files will be installed in
-            <literal>/opt/ems/ucpemanager/application</literal>. The
-            database will be installed in
+            <literal>/opt/ems/ucpemanager/application</literal>. The database
+            will be installed in
             <literal>/opt/ems/ucpemanager/database</literal>.</para>
           </listitem>
 
@@ -636,13 +636,11 @@ Enea_Edge_Management_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</programli
 
               <listitem>
                 <para>Install the Enea Edge Management application as a
-                service with the name
-                <literal>ucpemanager</literal>.</para>
+                service with the name <literal>ucpemanager</literal>.</para>
               </listitem>
 
               <listitem>
-                <para>Start the <literal>ucpemanager</literal>
-                service.</para>
+                <para>Start the <literal>ucpemanager</literal> service.</para>
               </listitem>
             </itemizedlist>
           </listitem>
@@ -679,8 +677,8 @@ Enea_Edge_Management_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</programli
         role="bold">System</emphasis> menu, and clicking <emphasis
         role="bold">System Backup</emphasis>, from the Enea Edge Management
         GUI. The resulting zip archive will be located in the
-        <filename>/opt/ems/ucpemanager/application/backup</filename>
-        folder and will be named
+        <filename>/opt/ems/ucpemanager/application/backup</filename> folder
+        and will be named
         <literal>SystemBackup_MMMDD_YYYY_HHMM_SS.zip</literal> (e.g
         System-Backup_Feb19_2013_2257_42.zip). Save the archive to another
         location outside the Enea Edge Management installation folder for
@@ -691,9 +689,9 @@ Enea_Edge_Management_&lt;version&gt;-build&lt;build_number&gt;.tar.gz</programli
           GUI (<filename>SystemBackup_MMMDD_YYYY_HHMM_SS.zip</filename>) is
           different from the snapshot obtained during an Enea Edge Management
           Upgrade or Uninstall operation
-          (<filename>EneaEdgeManagement-Backup-YYYYddMMHHmm.tar.gz</filename>) needed
-          for recovery of the Enea Edge Management application. For more
-          details, see <olink targetdoc="book_enea_edge_getting_started"
+          (<filename>EneaEdgeManagement-Backup-YYYYddMMHHmm.tar.gz</filename>)
+          needed for recovery of the Enea Edge Management application. For
+          more details, see <olink targetdoc="book_enea_edge_getting_started"
           targetptr="restore_prev_ucpe_install">Restoring a previous Enea Edge
           Management installation in the <xi:include
           href="../../s_docbuild/olinkdb/pardoc-names.xml"
@@ -767,7 +765,7 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
     <section id="prep_phys_deploy">
       <title>Preparing Physical Deployment for Installation</title>
 
-      <figure>
+      <figure id="prep_hw_installation">
         <title>Preparing for Hardware Installation</title>
 
         <mediaobject>
@@ -917,9 +915,10 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
         </listitem>
 
         <listitem>
-          <para>Connect the WAN cable to the uCPE device (see Figure 2). This
-          will be used as the uCPE management network interface, as described
-          below.</para>
+          <para>Connect the WAN cable to the uCPE device (see <link
+          linkend="prep_hw_installation">Figure 2.1 Preparing for Hardware
+          Installation</link>). This will be used as the uCPE management
+          network interface, as described below.</para>
         </listitem>
 
         <listitem>
@@ -963,7 +962,7 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
     <section id="prep_phys_exec">
       <title>Preparing Physical Deployment for Execution</title>
 
-      <figure>
+      <figure id="prep_deploy_execution">
         <title>Preparing for Deployment Execution</title>
 
         <mediaobject>
@@ -1253,4 +1252,4 @@ of=/dev/sdb bs=4M conv=fsync</programlisting>
       </note>
     </section>
   </section>
-</chapter>
+</chapter>
\ No newline at end of file
diff --git a/doc/book-enea-edge-getting-started/doc/log_collector.xml b/doc/book-enea-edge-getting-started/doc/log_collector.xml
index d7d99dd..ea99c9b 100644
--- a/doc/book-enea-edge-getting-started/doc/log_collector.xml
+++ b/doc/book-enea-edge-getting-started/doc/log_collector.xml
@@ -341,7 +341,7 @@
       collected uCPE device logs to the support team provides important
       information for troubleshooting (especially in cases of connectivity
       issues with the uCPE device and error popups).</para>
-          
+
       <para>Enea Edge Management log files are located in
       <filename>application/logs/</filename> in the Enea Edge Management
       application's installation folder
@@ -394,7 +394,7 @@
     <para>Log collection from uCPE Devices can also be done when there is no
     Enea Edge Management connection. A SSH connection to the uCPE Device is
     needed for use of the log collector script, which can be found in the uCPE
-    Device file system in <literal>/usr/local/enea/</literal>.</para>
+    Device file system in <literal>/usr/enea/</literal>.</para>
 
     <para>The Log collector script takes relevant information about the system
     and collects it in an archive:</para>
diff --git a/doc/book-enea-edge-getting-started/doc/troubleshooting.xml b/doc/book-enea-edge-getting-started/doc/troubleshooting.xml
index 299e183..0e6322f 100644
--- a/doc/book-enea-edge-getting-started/doc/troubleshooting.xml
+++ b/doc/book-enea-edge-getting-started/doc/troubleshooting.xml
@@ -54,7 +54,7 @@
         </row>
 
         <row>
-          <entry>The uCPE Device cannot boot after an upgrade.</entry>
+          <entry>The uCPE device cannot boot after an upgrade.</entry>
 
           <entry><orderedlist>
               <listitem>
diff --git a/doc/book-enea-edge-getting-started/doc/vnf_mg.xml b/doc/book-enea-edge-getting-started/doc/vnf_mg.xml
index c820f2a..4586a96 100644
--- a/doc/book-enea-edge-getting-started/doc/vnf_mg.xml
+++ b/doc/book-enea-edge-getting-started/doc/vnf_mg.xml
@@ -210,9 +210,8 @@
       Management application.</para>
 
       <note>
-        <para>CAUTION: The user MUST save and use the same order for the
-        virtual interfaces during both the onboarding and instantiation
-        phases.</para>
+        <para>The user MUST save and use the same order for the virtual
+        interfaces during both the onboarding and instantiation phases.</para>
       </note>
 
       <para><emphasis role="bold">Cloud Init Tab</emphasis></para>
@@ -534,9 +533,8 @@
     (snapshotting) and restoring a VNF context on the uCPE device using the
     Enea Edge Management application.</para>
 
-    <para>It is assumed the uCPE device referenced already contains at least
-    one instantiated VNF, added into the Edge Management application and is
-    connected.</para>
+    <para>The uCPE devices should be connected to the Enea Edge Management
+    application and should have at least one VNF instantiated.</para>
 
     <section id="vnf_live_snapshot">
       <title>VNF Live Snapshot</title>
@@ -591,7 +589,7 @@
 
         <listitem>
           <para>Select a virtual machine and press the <emphasis
-          role="bold">Snapshots..</emphasis> button. The <emphasis
+          role="bold">Snapshots</emphasis> button. The <emphasis
           role="bold">VM Snapshot Table on &lt;device-name&gt; (IP)</emphasis>
           window will open.</para>
         </listitem>
@@ -640,11 +638,13 @@
       </orderedlist>
 
       <para>A success message will be shown in the same window:
-      <literal>Snapshot deleted</literal>. The snapshot file will be deleted 
-        from the uCPE device and the table will be updated.</para>
+      <literal>Snapshot deleted</literal>. The snapshot file will be deleted
+      from the uCPE device and the table will be updated.</para>
 
-      <note><para>Deleting a VNF instance automatically deletes all snapshots
-        associated with it.</para></note>
+      <note>
+        <para>Deleting a VNF instance automatically deletes all snapshots
+        associated with it.</para>
+      </note>
     </section>
   </section>
 </chapter>
\ No newline at end of file