Made minor updates to the AFTH programlistings etc.

Added two limitations to the Known Limitations xml in Rel Notes.

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

3 files changed, 115 insertions, 121 deletions

diff --git a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml
index f32e5b7..888db4a 100644
--- a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml
+++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/automation_framework_test_harness.xml
@@ -95,8 +95,7 @@ Options:
         Fortigate <emphasis role="bold">deployment</emphasis> scenario
         <filename>fortigateDeploy.json</filename>:</para>
 
-        <para><programlisting>
-[
+        <para><programlisting>[
    {
       "config": "config/waitDeviceUp.json",
       "module": "../device/waitDeviceUp.py"
@@ -121,15 +120,13 @@ Options:
       "config": "config/controlVNFI.json",
       "module": "../vnf/controlVNFI.py"
    }
-]
-</programlisting></para>
+]</programlisting></para>
 
         <para>Below is a sample unit-test configuration file, describing the
         Fortigate <emphasis role="bold">cleanup</emphasis> scenario
         <filename>fortigateCleanup.json</filename>:</para>
 
-        <programlisting>
-[
+        <programlisting>[
    {
       "config": "config/destroyVNFI.json",
       "module": "../vnf/destroyVNFI.py"
@@ -146,8 +143,7 @@ Options:
       "config": "config/offboardVNF.json",
       "module": "../vnf/offboardVNF.py"
    }
-]
-</programlisting>
+]</programlisting>
 
         <para>The <literal>config</literal> key contains the path to the test
         case's configuration file.</para>
@@ -162,9 +158,8 @@ Options:
         <para>Unit-test behavior can be tweaked through setting any of the
         following options. This is done through the
         <filename>eneaUcpeMgr.py</filename> file:</para>
-                
-                <programlisting>
-# Defaults for the framework
+
+        <programlisting># Defaults for the framework
 username = "admin"
 password = "admin"
 host = None
@@ -189,105 +184,105 @@ consoleLoggingLevel = logging.INFO
 </programlisting>
 
         <table>
-            <title>eneaUcpeMgr.py Options</title>
+          <title>eneaUcpeMgr.py Options</title>
 
-            <tgroup cols="2">
-              <colspec align="left" />
+          <tgroup cols="2">
+            <colspec align="left" />
 
-              <colspec colwidth="2*" />
+            <colspec colwidth="2*" />
 
-              <colspec colwidth="5*" />
+            <colspec colwidth="5*" />
 
-              <thead>
-                <row>
-                  <entry align="center">Option</entry>
+            <thead>
+              <row>
+                <entry align="center">Option</entry>
 
-                  <entry align="center">Description</entry>
-                </row>
-              </thead>
+                <entry align="center">Description</entry>
+              </row>
+            </thead>
 
-              <tbody>
-                <row>
-                  <entry><literal>username</literal></entry>
+            <tbody>
+              <row>
+                <entry><literal>username</literal></entry>
 
-                  <entry>The user authentication used to log into the uCPE
-                  Manager. This can be overwritten by setting the Python
-                  unit-test suite command line option
-                  <literal>-u</literal>.</entry>
-                </row>
+                <entry>The user authentication used to log into the uCPE
+                Manager. This can be overwritten by setting the Python
+                unit-test suite command line option
+                <literal>-u</literal>.</entry>
+              </row>
 
-                <row>
-                  <entry><literal>password</literal></entry>
+              <row>
+                <entry><literal>password</literal></entry>
 
-                  <entry>The password used to log into the uCPE Manager. This
-                  can be overwritten by setting the Python unit-test suite
-                  command line option <literal>-p</literal>.</entry>
-                </row>
+                <entry>The password used to log into the uCPE Manager. This
+                can be overwritten by setting the Python unit-test suite
+                command line option <literal>-p</literal>.</entry>
+              </row>
 
-                <row>
-                  <entry><literal>host</literal></entry>
+              <row>
+                <entry><literal>host</literal></entry>
 
-                  <entry>The IP address of the uCPE Manager host. This can be
-                  overwritten by setting the Python unit-test suite command
-                  line option <literal>-H</literal>.</entry>
-                </row>
+                <entry>The IP address of the uCPE Manager host. This can be
+                overwritten by setting the Python unit-test suite command line
+                option <literal>-H</literal>.</entry>
+              </row>
 
-                <row>
-                  <entry><literal>devicename</literal></entry>
+              <row>
+                <entry><literal>devicename</literal></entry>
 
-                  <entry>The name of the vCPE agent against which tests will
-                  be performed. This can be overwritten by setting the Python
-                  unit-test suite command line option
-                  <literal>-n</literal>.</entry>
-                </row>
+                <entry>The name of the vCPE agent against which tests will be
+                performed. This can be overwritten by setting the Python
+                unit-test suite command line option
+                <literal>-n</literal>.</entry>
+              </row>
 
-                <row>
-                  <entry><literal>ftpUsername</literal></entry>
+              <row>
+                <entry><literal>ftpUsername</literal></entry>
 
-                  <entry>The user authentication used for the FTP connection
-                  when onboarding a VNF image. This can be overwritten by
-                  setting the Python script command line option
-                  <literal>-f</literal>.</entry>
-                </row>
+                <entry>The user authentication used for the FTP connection
+                when onboarding a VNF image. This can be overwritten by
+                setting the Python script command line option
+                <literal>-f</literal>.</entry>
+              </row>
 
-                <row>
-                  <entry><literal>ftpPassword</literal></entry>
+              <row>
+                <entry><literal>ftpPassword</literal></entry>
 
-                  <entry>The password used for the FTP connection when
-                  onboarding a VNF image. This can be overwritten by setting
-                  the Python script command line option
-                  <literal><literal>-w</literal></literal>.</entry>
-                </row>
+                <entry>The password used for the FTP connection when
+                onboarding a VNF image. This can be overwritten by setting the
+                Python script command line option
+                <literal><literal>-w</literal></literal>.</entry>
+              </row>
 
-                <row>
-                  <entry><literal>ftpPort</literal></entry>
+              <row>
+                <entry><literal>ftpPort</literal></entry>
 
-                  <entry>The port used for the FTP connection when onboarding
-                  a VNF image. This can be overwritten by setting the Python
-                  script command line option <literal>-P</literal>.</entry>
-                </row>
+                <entry>The port used for the FTP connection when onboarding a
+                VNF image. This can be overwritten by setting the Python
+                script command line option <literal>-P</literal>.</entry>
+              </row>
 
-                <row>
-                  <entry><literal>failfast</literal></entry>
+              <row>
+                <entry><literal>failfast</literal></entry>
 
-                  <entry>Describes the unit-test execution behavior on the
-                  first error or failure encountered.</entry>
-                </row>
+                <entry>Describes the unit-test execution behavior on the first
+                error or failure encountered.</entry>
+              </row>
 
-                <row>
-                  <entry><literal>fileLoggingLevel</literal></entry>
+              <row>
+                <entry><literal>fileLoggingLevel</literal></entry>
 
-                  <entry>Sets the file logging level.</entry>
-                </row>
+                <entry>Sets the file logging level.</entry>
+              </row>
 
-                <row>
-                  <entry><literal>consoleLoggingLevel</literal></entry>
+              <row>
+                <entry><literal>consoleLoggingLevel</literal></entry>
 
-                  <entry>Sets the console logging level.</entry>
-                </row>
-              </tbody>
-            </tgroup>
-          </table>
+                <entry>Sets the console logging level.</entry>
+              </row>
+            </tbody>
+          </tgroup>
+        </table>
       </section>
 
       <section id="ut_suite_log">
@@ -323,18 +318,14 @@ NOTSET 0</programlisting></para>
         running the Fortigate <emphasis role="bold">deployment</emphasis>
         scenario:</para>
 
-<programlisting>
-$ python unittestSuite.py -u admin -p admin -H localhost -n intelc3850-2 -s
+        <programlisting>$ python unittestSuite.py -u admin -p admin -H localhost -n intelc3850-2 -s
 fortigateDeploy.json -d "Fortigate deployment scenario"
 </programlisting>
 
-<para>Setting the console logging level to DEBUG:</para>
+        <para>Setting the console logging level to DEBUG:</para>
 
-<para><programlisting>consoleLoggingLevel = logging.DEBUG</programlisting>
-<emphasis role="bold">Expected Output:</emphasis>
-
-<programlisting>
-2019-03-07 18:03:20,791 - DEBUG: Started logging
+        <para><programlisting>consoleLoggingLevel = logging.DEBUG</programlisting>
+        <emphasis role="bold">Expected Output:</emphasis> <programlisting>2019-03-07 18:03:20,791 - DEBUG: Started logging
 
 Running Fortigate deployment scenario...
 
@@ -468,9 +459,8 @@ OK</programlisting></para>
         <para>Below you'll find sample unit-test command line options for
         running the Fortigate <emphasis role="bold">cleanup</emphasis>
         scenario:</para>
-                
-<programlisting>
-$ python unittestSuite.py -u admin -p admin -H localhost -n intelc3850-2 -s
+
+        <programlisting>$ python unittestSuite.py -u admin -p admin -H localhost -n intelc3850-2 -s
 fortigateCleanup.json -d "Fortigate cleanup scenario"
 </programlisting>
 
@@ -802,8 +792,7 @@ Mandatory options:
         <para>The <literal>getEventsForUcpe</literal> Python module can be
         executed individually by running the following command:</para>
 
-        <programlisting>
-$ python getEventsForUcpe.py -H localhost -f \
+        <programlisting>$ python getEventsForUcpe.py -H localhost -f \
 ../../lab_config/intelc3850-2/intelc3850-2.json
 
 2019-07-04 13:48:31,289 - DEBUG: Started logging
@@ -818,8 +807,7 @@ Events on device: intelc3850-2 and severity: 1000
     2019-07-04 09:57:40.042
 2019-07-04 13:48:31,469 - DEBUG:  Dumping 0 events
 2019-07-04 13:48:31,469 - INFO: Done
-2019-07-04 13:48:31,488 - DEBUG: Logging out and exiting...
-              </programlisting>
+2019-07-04 13:48:31,488 - DEBUG: Logging out and exiting... </programlisting>
       </section>
     </section>
 
@@ -1826,8 +1814,8 @@ fortigateFWInstance
     <section id="upload_vnf_image">
       <title>Uploading a NFV Access image onto the Enea uCPE Manager</title>
 
-      <para>Steps and options on how to Upload a NFV Access image onto the Enea uCPE
-      Manager are described below.</para>
+      <para>Steps and options on how to Upload a NFV Access image onto the
+      Enea uCPE Manager are described below.</para>
 
       <section id="script_opts_upload">
         <title>Script Options</title>
@@ -1861,9 +1849,9 @@ Options:
       <section id="json_upload">
         <title>Configuring the JSON File</title>
 
-        <para>The JSON configuration file needed to upload a NFV Access image should
-        contain a list of dictionaries. Each dictionary indicates the test
-        case name and the test case arguments passed to the
+        <para>The JSON configuration file needed to upload a NFV Access image
+        should contain a list of dictionaries. Each dictionary indicates the
+        test case name and the test case arguments passed to the
         <filename>uploadImage</filename> Python module.</para>
 
         <para><emphasis role="bold">Sample unit-test JSON file
@@ -1897,10 +1885,11 @@ Options:
     </section>
 
     <section id="delete_vnf_image">
-      <title>Deleting a NFV Access image file from the Enea uCPE Manager</title>
+      <title>Deleting a NFV Access image file from the Enea uCPE
+      Manager</title>
 
-      <para>Steps and options on how to Delete a NFV Access image from the Enea uCPE
-      Manager are described below.</para>
+      <para>Steps and options on how to Delete a NFV Access image from the
+      Enea uCPE Manager are described below.</para>
 
       <section id="script_opts_deleteupload">
         <title>Script Options</title>
@@ -1931,9 +1920,9 @@ Options:
       <section id="json_delete_upload">
         <title>Configuring the JSON File</title>
 
-        <para>The JSON configuration file needed to delete a NFV Access image should
-        contain a list of dictionaries. Each dictionary indicates the test
-        case name and the test case arguments passed to the
+        <para>The JSON configuration file needed to delete a NFV Access image
+        should contain a list of dictionaries. Each dictionary indicates the
+        test case name and the test case arguments passed to the
         <filename>deleteUpgradeFile</filename> Python module.</para>
 
         <para><emphasis role="bold">Sample unit-test JSON file
@@ -1970,11 +1959,12 @@ image was successfully removed
     </section>
 
     <section id="install_activate_vnf_image">
-      <title>Installing and activating a NFV Access image on an uCPE device from the
-      Enea uCPE Manager</title>
+      <title>Installing and activating a NFV Access image on an uCPE device
+      from the Enea uCPE Manager</title>
 
-      <para>Steps and options on how to Install and Activate a NFV Access image on an
-      uCPE device from the Enea uCPE Manager are described below.</para>
+      <para>Steps and options on how to Install and Activate a NFV Access
+      image on an uCPE device from the Enea uCPE Manager are described
+      below.</para>
 
       <section id="script_opts_install_activate">
         <title>Script Options</title>
@@ -2010,10 +2000,10 @@ Options:
       <section id="json_install_activate">
         <title>Configuring the JSON File</title>
 
-        <para>The JSON configuration file needed to install and activate a NFV Access
-        image on a uCPE device from the Enea uCPE Manager should contain a
-        list of dictionaries. Each dictionary indicates the test case name and
-        the test case arguments passed to the
+        <para>The JSON configuration file needed to install and activate a NFV
+        Access image on a uCPE device from the Enea uCPE Manager should
+        contain a list of dictionaries. Each dictionary indicates the test
+        case name and the test case arguments passed to the
         <filename>installAndActivate</filename> Python module.</para>
 
         <para><emphasis role="bold">Sample unit-test JSON file
@@ -2193,4 +2183,4 @@ Options:
     <filename>ansible.log</filename> and <filename>debug.log</filename> files,
     respectively.</para>
   </section>
-</chapter>
+</chapter>
\ No newline at end of file
diff --git a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/components.xml b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/components.xml
index 1de8454..2917b1a 100644
--- a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/components.xml
+++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/components.xml
@@ -49,7 +49,7 @@
       
       <note><para>Before running any use case with the Automation Framework or 
         the Test Harness, make sure the uCPE device(s) have been added to 
-        the uCPE Manager, as needed.</para></note>
+        the uCPE Manager.</para></note>
 
       <para>Adding a VcpeAgent device can be done via two methods:</para>
 
diff --git a/doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml b/doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml
index 9c1828d..961a281 100644
--- a/doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml
+++ b/doc/book-enea-nfv-access-release-info/doc/known_bugs_and_limitations.xml
@@ -43,6 +43,8 @@
       fail and some resources will not be removed from the machine. Reverting
       resources in the case of a failed uninstall is not implemented.</para>
     </listitem>
+        
+        <listitem><remark>ELCCR-454</remark>Only the default database is supported, any requests for alternative databases are custom adaptations.</listitem>
 
     <listitem>
       <para><remark>ELCCR-371</remark>A software image for NFV Access runs
@@ -64,6 +66,8 @@
         one of the OVS bridges it is connected to, the VNF instance cannot be 
         deleted before removing the appropriate flows.</para>
     </listitem>
+        
+        <listitem><remark>ELCCR-527</remark>When uploading a file, if the user cancels the upload, the upload window must be closed and reopened in order for the next upload to work.</listitem>
 
     <listitem>
       <para><remark>LXCR-9088</remark>Automation Framework and Test Harness