GettingStarted: move ch 2 & 3 from VNF Onboarding

- Move ch 2 & ch 3 from VNF Onboarding Guide to the Getting Started
chapter 4.4 VNF Management

- Update the doc version to 2.2.1

Change-Id: I19353d7d70b526652b5867d0e7abe04d0edb3e18
Signed-off-by: Sona Sarmadi <sona.sarmadi@enea.com>

2 files changed, 314 insertions, 7 deletions

diff --git a/doc/book-enea-nfv-access-getting-started/doc/eltf_params_updated.xml b/doc/book-enea-nfv-access-getting-started/doc/eltf_params_updated.xml
index 0386515..7fe09ec 100644
--- a/doc/book-enea-nfv-access-getting-started/doc/eltf_params_updated.xml
+++ b/doc/book-enea-nfv-access-getting-started/doc/eltf_params_updated.xml
@@ -42,7 +42,7 @@ export PATH=~/bin:$PATH</programlisting></para>
     correct also compared to the "previous" REL VER in pardoc-distro.xml
     "prev_baseline".</bridgehead>
 
-    <para id="EneaLinux_REL_VER"><phrase>2.2</phrase></para>
+    <para id="EneaLinux_REL_VER"><phrase>2.2.1</phrase></para>
 
     <para id="Yocto_VER"><phrase>2.4</phrase></para>
 
diff --git a/doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml b/doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml
index 80595e6..afb6ee3 100644
--- a/doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml
+++ b/doc/book-enea-nfv-access-getting-started/doc/getting_started_ucpe_manager.xml
@@ -130,7 +130,7 @@
           <listitem>
             <para>Device Calls Home. This checkbox indicates the direction of
             device communications. In the Manual Configuration, leave this box
-            blank. </para>
+            blank.</para>
           </listitem>
         </itemizedlist>
 
@@ -150,9 +150,9 @@
         <para>The uCPE Manager must be configured to bring the uCPE device
         under management. This is done by selecting the <literal>Device Calls
         Home</literal> checkbox when adding a device. When Device Calls Home
-        is checked, the device will initiate a connection by opening
-        a socket to the uCPE Manager for NETCONF traffic (over SSH), while the
-        uCPE Manager waits for device connection.</para>
+        is checked, the device will initiate a connection by opening a socket
+        to the uCPE Manager for NETCONF traffic (over SSH), while the uCPE
+        Manager waits for device connection.</para>
       </section>
     </section>
 
@@ -468,7 +468,7 @@
     </itemizedlist>
 
     <section id="onboarding_a_vnf">
-      <title>Onboarding a VNF</title>
+      <title>Onboarding a VNF (old)</title>
 
       <para>The VNF descriptor catalog table provides a button that allows you
       to onboard a new (third-party) VNF into the catalog.</para>
@@ -724,8 +724,184 @@
       </section>
     </section>
 
+    <section id="onboarding_a_vnf2">
+      <title>Onboarding a VNF (copied from VNF Onboarding Guide)</title>
+
+      <para>The onboarding of a VNF means adding it to the Enea uCPE Manager
+      VNF Catalog and preparing it for instantiation (deployment on connected
+      uCPE devices). This is accomplished using the Enea uCPE Manager
+      Onboarding Wizard, a graphical user interface specifically designed to
+      make VNF onboarding simple and fast.</para>
+
+      <para>Typically, the VNF's Getting Started Guide contains all necessary
+      information needed to onboard a VNF using the Onboarding Wizard. This
+      present guide however, provides a number of examples of how to onboard
+      specific commercial VNFs.</para>
+
+      <para>The following sections detail the basic steps needed to
+      successfully onboard a VNF in the Enea uCPE Manager.</para>
+
+      <section id="retrieve_art">
+        <title>Retrieving Artifacts</title>
+
+        <para>The user must first retrieve the necessary artifacts from the
+        VNF vendor:</para>
+
+        <orderedlist>
+          <listitem>
+            <para>Download the VNF from the commercial vendor.</para>
+          </listitem>
+
+          <listitem>
+            <para>Get any VNF specific license from the VNF vendor.</para>
+
+            <note>
+              <para>There are no standard ways of managing VNF licenses,
+              therefore no general guidelines can be provided. One example of
+              license handling that can be employed in the uCPE Manager is the
+              adding of a license during the Cloud-Init setup. The ConfigDrive
+              value is provided in the Fortios specific guidelines.</para>
+            </note>
+          </listitem>
+
+          <listitem>
+            <para>Get access to the VNF specific VNF Manager for day 1 and 2
+            configuration (in cloud or for local deployment).</para>
+          </listitem>
+
+          <listitem>
+            <para>Procure the Getting Started Guide from the VNF vendor,
+            preferably for KVM deployment for VNF specific configuration
+            information.</para>
+          </listitem>
+        </orderedlist>
+      </section>
+
+      <section id="onboard_prep">
+        <title>Preparation</title>
+
+        <para>Once all needed downloadables, documentation and more have been
+        attained, preparation for onboarding must be completed:</para>
+
+        <orderedlist>
+          <listitem>
+            <para>Determine the use-case and performance requirements of the
+            VNF you wish to deploy.</para>
+
+            <itemizedlist>
+              <listitem>
+                <para>This decides what resources the VNF is configured for,
+                along with networking and day zero configurations.</para>
+
+                <para>Generally, the Getting Started Guide for the VNF
+                provides guidelines for resource allocation, but since
+                performance is dependent on hardware capacity, the right
+                resource allocation for deployment is typically determined
+                through benchmarking.</para>
+              </listitem>
+
+              <listitem>
+                <para>Determine the amount of hardware resources needed for
+                the VNF (RAM, CPUs and Disk size).</para>
+              </listitem>
+
+              <listitem>
+                <para>Determine how many Network Interfaces the VNF shall
+                use.</para>
+              </listitem>
+            </itemizedlist>
+          </listitem>
+
+          <listitem>
+            <para>Determine the day zero configuration method from the VNF
+            Getting Started guidelines.</para>
+
+            <note>
+              <para>For many VNFs, day zero configuration can be skipped in
+              early onboarding efforts when automation is not of
+              importance.</para>
+            </note>
+          </listitem>
+
+          <listitem>
+            <para>Determine any requirements needed by the Cloud-Init file
+            structure and the content needed for the VNF when Cloud-Init is
+            used.</para>
+          </listitem>
+        </orderedlist>
+      </section>
+
+      <section id="onboarding2">
+        <title>Onboarding the VNF</title>
+
+        <orderedlist>
+          <listitem>
+            <para>Enter the Enea uCPE Manager and choose VNF-&gt;Descriptors
+            in the GUI.</para>
+          </listitem>
+
+          <listitem>
+            <para>Click <literal>Onboard</literal> to start the onboarding
+            procedure.</para>
+          </listitem>
+
+          <listitem>
+            <para>Fill in all mandatory fields in the popup menu: Name, Image,
+            RAM, CPUs, Disk.</para>
+          </listitem>
+
+          <listitem>
+            <para>Define the VNF's Network Interfaces and give them
+            descriptive names.</para>
+          </listitem>
+
+          <listitem>
+            <para>Configure the Cloud-Init settings, starting with the
+            Datasource:</para>
+
+            <itemizedlist spacing="compact">
+              <listitem>
+                <para>Choose <literal>None</literal> if Cloud-Init is not
+                used.</para>
+              </listitem>
+
+              <listitem>
+                <para>Choose <literal>ConfigDrive</literal>,
+                <literal>NoCloud</literal> or <literal>ISO</literal> depending
+                on the VNF specific Cloud-Init implementation.</para>
+              </listitem>
+
+              <listitem>
+                <para>Choose the Cloud-Init mount method based on the VNF
+                specific Cloud-Init implementation.</para>
+              </listitem>
+
+              <listitem>
+                <para>Configure any VNF specific Cloud-Init files according to
+                VNF specific documentation.</para>
+              </listitem>
+            </itemizedlist>
+          </listitem>
+
+          <listitem>
+            <para>Additional Properties (in the Properties Tab) are typically
+            not needed and can be ignored.</para>
+          </listitem>
+
+          <listitem>
+            <para>Click <literal>Onboard</literal> to add the VNF to the Enea
+            uCPE Manager VNF Catalog.</para>
+          </listitem>
+        </orderedlist>
+
+        <para>When the onboarding is complete, the VNF will appear in the VNF
+        Catalog and can be used for deploying services on the uCPE
+        devices.</para>
+      </section>
+    </section>
+
     <section id="instantiating_a_vnf">
-      <title>Instantiating a VNF</title>
+      <title>Instantiating a VNF (old)</title>
 
       <para>Once the VNF has been onboarded, you can instantiate a VNF on a
       specific uCPE device.</para>
@@ -823,5 +999,136 @@
         </mediaobject>
       </figure>
     </section>
+
+    <section id="instantiating_a_vnf2">
+      <title>Instantiating a VNF (copied from VNF Onboarding Guide)</title>
+
+      <para>When a VNF is onboarded and available in the VNF catalog, it can
+      be instantiated (deployed) on connected uCPE devices. The instantiation
+      wizard uses the configurations provided when the VNF is onboarded, as a
+      template for instantiation. Before the instantiation, however, the uCPE
+      device needs to be prepared:</para>
+
+      <orderedlist>
+        <listitem>
+          <para>Physical NICs used with the VNF directly (through SR-IOV or
+          PCI Passthrough) or indirectly (through bridges) need to be
+          configured (Device-&gt;Configuration-&gt;OpenVSwitch-&gt;Host
+          Interfaces).</para>
+
+          <note>
+            <para>Before configuring any physical NICs determine which is used
+            for managing the uCPE device. Altering the configuration of a NIC
+            may cause connectivity issues.</para>
+          </note>
+        </listitem>
+
+        <listitem>
+          <para>Add any needed bridges, connecting them to the physical NICs
+          previously configured or making them integration bridges (without
+          physical NIC) for service chaining.</para>
+        </listitem>
+      </orderedlist>
+
+      <para>Once the physical NICs and bridges are configured, the VNF can be
+      instantiated using the Instantiation Wizard.</para>
+
+      <section id="using_wiz2">
+        <title>Using the Instantiation Wizard</title>
+
+        <orderedlist>
+          <listitem>
+            <para>Enter the Instantiation Wizard by accessing
+            VNF-&gt;Instances and hitting <literal>Add</literal>.</para>
+          </listitem>
+
+          <listitem>
+            <para>Fill out the following mandatory fields:</para>
+
+            <itemizedlist spacing="compact">
+              <listitem>
+                <para>Name (a descriptive name).</para>
+              </listitem>
+
+              <listitem>
+                <para>Device (the uCPE device to instantiate the VNF
+                on).</para>
+              </listitem>
+
+              <listitem>
+                <para>Networking Configuration:</para>
+
+                <itemizedlist spacing="compact">
+                  <listitem>
+                    <para>Connect each configured NIC with a bridge, SR-IOV or
+                    PCI Passthrough.</para>
+                  </listitem>
+
+                  <listitem>
+                    <para>Set up each NIC with a driver method (DPDK or
+                    e1000).</para>
+                  </listitem>
+                </itemizedlist>
+
+                <note>
+                  <para>All configured NICs must be set up before
+                  instantiating a VNF. Failure to do so will end in a failed
+                  instantiation.</para>
+                </note>
+              </listitem>
+            </itemizedlist>
+          </listitem>
+
+          <listitem>
+            <para>Add VNF specific configuration by uploading a Cloud-Init
+            file (when the Cloud-Init is used).</para>
+          </listitem>
+
+          <listitem>
+            <para>Add any VNF specific files (e.g license files).</para>
+          </listitem>
+
+          <listitem>
+            <para>Hit the <literal>Create</literal> button to deploy the
+            VNF.</para>
+          </listitem>
+        </orderedlist>
+      </section>
+
+      <section id="enter_console">
+        <title>Entering the VNF Console</title>
+
+        <para>Once the VNF is deployed, the VNF console can be entered using
+        SSH and virsh commands. The VNF Console is a typical starting point
+        for determining a successful deployment and configuring a VNF beyond
+        Day Zero.</para>
+
+        <orderedlist spacing="compact">
+          <listitem>
+            <para>SSH to the uCPE device from the Enea uCPE Manager
+            (Device-&gt;SSH) with default user and password:
+            <literal>root</literal>.</para>
+          </listitem>
+
+          <listitem>
+            <para>In SSH:</para>
+
+            <orderedlist>
+              <listitem>
+                <para>Use the <command>virsh list</command> command to list
+                all running VNFs and to determine the VNF's instance
+                number.</para>
+              </listitem>
+
+              <listitem>
+                <para>Use the <command>virsh console &lt;instance
+                number&gt;</command> command to enter the VNF specific
+                console.</para>
+              </listitem>
+            </orderedlist>
+          </listitem>
+        </orderedlist>
+      </section>
+    </section>
   </section>
 </chapter>