Added AF TH User Guide Outline + ch1&2 proofed.

Change-Id: Ie6ae43e02f30dd6bba6532b84d41c8d4a5e0bbf9

1 files changed, 223 insertions, 0 deletions

diff --git a/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/getting_started.xml b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/getting_started.xml
new file mode 100644
index 0000000..b7ff8f4
--- /dev/null
+++ b/doc/book-enea-nfv-access-auto-fw-th-user-guide/doc/getting_started.xml
@@ -0,0 +1,223 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<chapter id="getting_started">
+  <title>Getting Started with the Automation Framework and Test
+  Harness</title>
+
+  <section id="prerequisites">
+    <title>Prerequisites</title>
+
+    <para>For installation of the Automation Framework and Test Harness a
+    CentOS 7 host machine is needed with support for:</para>
+
+    <itemizedlist>
+      <listitem>
+        <para>Python 2.7</para>
+      </listitem>
+
+      <listitem>
+        <para>EPEL Repository installed:<programlisting>sudo yum install epel-release</programlisting></para>
+      </listitem>
+
+      <listitem>
+        <para>PIP package manager installed: <programlisting>sudo yum -y install python-pip</programlisting></para>
+      </listitem>
+
+      <listitem>
+        <para>Virtualenv tool installed: <programlisting>sudo pip install virtualenv</programlisting></para>
+      </listitem>
+    </itemizedlist>
+
+    <note>
+      <para>The Automation Framework and Test Harness installation may be done
+      on the same machine used for uCPE Manager installation, although this is
+      not encouraged. For more details see <link linkend="automation">chapter
+      3.2</link>.</para>
+    </note>
+  </section>
+
+  <section id="envrion">
+    <title>Environment</title>
+
+    <para><figure>
+        <title>Lab setup overview for Basic Setup</title>
+
+        <mediaobject>
+          <imageobject>
+            <imagedata align="center"
+                       fileref="images/environment_basicsetup.png" scale="35" />
+          </imageobject>
+        </mediaobject>
+      </figure>The following enviroment setup is needed for running all the
+    tests defined in the Enea NFV Access System Test Specification
+    document:</para>
+
+    <para><emphasis role="bold">Lab Network</emphasis><itemizedlist>
+        <listitem>
+          <para>DHCP enabled.</para>
+        </listitem>
+
+        <listitem>
+          <para>Internet Connectivity.</para>
+        </listitem>
+      </itemizedlist></para>
+
+    <para><emphasis role="bold">uCPE Manager host</emphasis></para>
+
+    <itemizedlist>
+      <listitem>
+        <para>Running CentOS 7.</para>
+      </listitem>
+
+      <listitem>
+        <para>Connected to Lab Network.</para>
+      </listitem>
+
+      <listitem>
+        <para>uCPE Manager installed.</para>
+
+        <note>
+          <para>For details on how to install the uCPE Manager, see "Getting
+          Started with Enea uCPE Manager" from the Enea NFV Access Getting
+          Started manual.</para>
+        </note>
+      </listitem>
+    </itemizedlist>
+
+    <para><emphasis role="bold">1<superscript>st</superscript> Intel Whitebox
+    target device</emphasis><itemizedlist>
+        <listitem>
+          <para>Minimum 4 Physical Network Devices.</para>
+        </listitem>
+
+        <listitem>
+          <para>4GB RAM and 4 cores (Intel C3000 or Xeon D).</para>
+        </listitem>
+
+        <listitem>
+          <para>2 Physical connections to Lab Network.</para>
+        </listitem>
+
+        <listitem>
+          <para>Enea NFV Access installed.</para>
+
+          <note>
+            <para>For information on how to install Enea NFV Access<remark>the
+            solution or the platform?</remark>, refer to "Getting Started with
+            Enea NFV Access" from the Enea NFV Access Getting Started
+            manual.</para>
+          </note>
+        </listitem>
+      </itemizedlist><figure>
+        <title>Lab setup overview for ChainedVNFsService Setup</title>
+
+        <mediaobject>
+          <imageobject>
+            <imagedata align="center"
+                       fileref="images/ChainedVNFsService_setup.png"
+                       scale="40" />
+          </imageobject>
+        </mediaobject>
+      </figure></para>
+
+    <para><emphasis role="bold">Changes to 1st Intel Whitebox target
+    device</emphasis></para>
+
+    <itemizedlist>
+      <listitem>
+        <para>16GB RAM and 8 cores (Intel C3000 or Xeon D).</para>
+      </listitem>
+
+      <listitem>
+        <para>1 Physical connection back to back with the 2nd Intel Whitebox
+        target device.</para>
+      </listitem>
+    </itemizedlist>
+
+    <para><emphasis role="bold">2<superscript>nd</superscript> Intel Whitebox
+    target device</emphasis><itemizedlist>
+        <listitem>
+          <para>Minimum 4 Physical Network Devices.</para>
+        </listitem>
+
+        <listitem>
+          <para>16GB RAM and 8 cores (Intel C3000 or Xeon D).</para>
+        </listitem>
+
+        <listitem>
+          <para>2 Physical connections to Lab Network.</para>
+        </listitem>
+
+        <listitem>
+          <para>1 Physical connection back to back with the
+          1<superscript>st</superscript> Intel Whitebox target device.</para>
+        </listitem>
+
+        <listitem>
+          <para>Enea NFV Access installed.</para>
+
+          <note>
+            <para>For information on how to install Enea NFV Access<remark>the
+            solution or the platform?</remark>, refer to "Getting Started with
+            Enea NFV Access" from the Enea NFV Access Getting Started
+            manual.</para>
+          </note>
+        </listitem>
+      </itemizedlist></para>
+  </section>
+
+  <section id="initial_setup">
+    <title>Installation and Initial Setup</title>
+
+    <para>Download <filename>nfvaccess22_af-th.zip</filename> from the Enea
+    Portal and unzip it on the a supported host machine. Henceforth, the
+    directory in which the ZIP archive has been unpacked will be denoted as
+    <literal>&lt;AF-TH-installdir&gt;</literal>.</para>
+
+    <para>Enter the <literal>&lt;AF-TH-install-dir&gt;</literal> directory and
+    run the <filename>setup_env.sh</filename> script to do the initial setup
+    of the Test Harness environment: <filename>source
+    setup_env.sh</filename>.</para>
+
+    <para>Setup the uCPE Manager which will be used by the TH:</para>
+
+    <orderedlist>
+      <listitem>
+        <para>Create the uCPE Manager JSON config file in the
+        <literal>&lt;AF-TH-install-dir&gt;/uCPEM_config/</literal>
+        directory:<programlisting>{
+"ucpe_usr":"uCPE Manager Username",
+"ucpe_pass":"uCPE Manager Password",
+"ucpe_host":"uCPE Manager IP/Hostname",
+"ftp_usr":"FTP Username",
+"ftp_pass":"FTP Password",
+"ftp_port":"FTP Port"
+}</programlisting>See the
+        <filename>&lt;AF-TH-install-dir&gt;/uCPEM_config/ucpem01.json</filename>
+        file as an example.</para>
+      </listitem>
+
+      <listitem>
+        <para>Run the <filename>setupuCPEManager.yml</filename> Ansible
+        Playbook with the JSON config path as parameter: <programlisting>ansible-playbook playbooks/setupuCPEManager.yml -e\ 
+"@uCPEM_config/&lt;config_name&gt;.json"</programlisting></para>
+
+        <para><emphasis role="bold">Example</emphasis> <programlisting>ansible-playbook playbooks/setupuCPEManager.yml -e\ 
+"@uCPEM_config/ucpem01.json"</programlisting></para>
+      </listitem>
+    </orderedlist>
+
+    <para>Note that the steps presented in this sub-chapter are to be executed
+    only once, for the initial setup of the TH environment. Afterwards, each
+    session ends by closing the Python virtual environment (<literal>source
+    &lt;AF-THinstall-dir&gt;/testHarness/bin/deactivate</literal>) and
+    subsequent use of the installation requires activating the Python virtual
+    enviroment before using the Automation Framework and Test Harness
+    (<literal>source
+    &lt;AF-THinstall-dir&gt;/testHarness/bin/activate</literal>).</para>
+
+    <para>Furthermore, if a user wants to use a new uCPE Manager instance for
+    a new session, the user also has to re-run the
+    <filename>setupuCPEManager.yml</filename> playbook with the corresponding
+    JSON config for the new uCPE Manager instance.</para>
+  </section>
+</chapter>
\ No newline at end of file