Merge "GettingStarted: remove bundle example and references"

1 files changed, 109 insertions, 189 deletions

diff --git a/doc/book-enea-nfv-access-getting-started/doc/device_configuration_and_provisioning.xml b/doc/book-enea-nfv-access-getting-started/doc/device_configuration_and_provisioning.xml
index 1fb5b1c..6632834 100644
--- a/doc/book-enea-nfv-access-getting-started/doc/device_configuration_and_provisioning.xml
+++ b/doc/book-enea-nfv-access-getting-started/doc/device_configuration_and_provisioning.xml
@@ -9,14 +9,15 @@
     installed on a specific uCPE device, and how to setup the virtual
     infrastructure manually.</para>
 
-    <para><emphasis role="bold">How to add a uCPE device to the management system
-    </emphasis></para>
+    <para><emphasis role="bold">How to add a uCPE device to the management
+    system </emphasis></para>
 
-    <para>Add the uCPE device running NFV Access Run Time Platform to the management system. This is
-    done by using the <literal>Devices -&gt; Manage -&gt; Add</literal> menu.
-    Supply information about the uCPE device, and set the
-    parameters that will be used to connect to the uCPE device. The relevant
-    parameters are described below:</para>
+     <para>Add the uCPE device running the NFV Access Run Time Platform to the
+      management system: <literal>Devices -&gt; Manage -&gt; Add</literal>. Supply
+      information about the uCPE device, and set the parameters that will be used 
+      to connect to it.</para>
+
+      <para>The relevant parameters are:</para>
 
     <itemizedlist>
       <listitem>
@@ -350,8 +351,8 @@
 
     <para>As the acting vnf manager, the uCPE Manager is responsible for
     handling the life-cycles of VNFs that are instantiated and run on the
-    various uCPE devices. The vnf manager module is written so as to be able to
-    manage multiple VNF types. Along with it is provided a generic
+    various uCPE devices. The vnf manager module is written so as to be able
+    to manage multiple VNF types. Along with it is provided a generic
     infrastructure to allow the end-user to introduce new VNF types
     dynamically into the system. This allows for third-party VNFs to be added
     over time to an existing network infrastructure without having to perform
@@ -359,9 +360,9 @@
 
     <para>The process of VNF Onboarding consists of providing the system with
     sufficient information and resources related to the VNF such that it can
-    instantiate a flavor of the VNF on the uCPE device, configure and scale it
-    as appropriate, heal and upgrade it when necessary and tear it down at the
-    right moment.</para>
+    instantiate a flavour of the VNF on the uCPE device, configure and scale
+    it as appropriate, heal and upgrade it when necessary and tear it down at
+    the right moment.</para>
 
     <para>The vnf manager subsystem in the uCPE Manager inserts a menu item in
     the toolbar, called <literal>VNF</literal> as shown in the screen-shot
@@ -409,7 +410,7 @@
       <title>Onboarding a VNF</title>
 
       <para>The VNF descriptor catalog table provides a button that allows you
-      to onboard a new (third-party) VNF bundle into the catalog.</para>
+      to onboard a new (third-party) VNF into the catalog.</para>
 
       <figure>
         <title>Onboard New VNF</title>
@@ -422,82 +423,21 @@
         </mediaobject>
       </figure>
 
-      <para>You can onboard using one of the following methods:</para>
-
-      <itemizedlist>
-        <listitem>
-          <para>Onboard a VNF Package.</para>
-        </listitem>
-
-        <listitem>
-          <para>Directly onboard a VNF VM Image (such as a QCOW) using the
-          onboarding wizard.</para>
-        </listitem>
-      </itemizedlist>
-
-      <section id="onboarding_a_bundled_vnf">
-        <title>Onboarding a bundled VNF package</title>
-
-        <para><emphasis role="bold">How to onboard a VNF onto the uCPE
-        Manager</emphasis></para>
-
-        <orderedlist>
-          <listitem>
-            <para>Click the <literal>On-board</literal> button.</para>
-          </listitem>
-
-          <listitem>
-            <para>When prompted by the following UI, make sure the
-            <literal>VNF Package</literal> radio button is selected.</para>
-          </listitem>
-
-          <listitem>
-            <para>Click <literal>Choose File</literal> and choose the VNF
-            Package ZIP archive, e.g <literal>VProbe.zip</literal>, which
-            represents the VNF bundle.</para>
-          </listitem>
-
-          <listitem>
-            <para>Click <literal>Send</literal>.</para>
-          </listitem>
-        </orderedlist>
-
-        <figure>
-          <title>Onboarding a bundled VNF package</title>
-
-          <mediaobject>
-            <imageobject>
-              <imagedata align="center"
-                         fileref="images/onboard_a_vnf_send.png" scale="70" />
-            </imageobject>
-          </mediaobject>
-        </figure>
-
-        <para>This will cause the vnf manager to do the following: Upload the
-        ZIP file and stage it in a temporary location. Unzip it and verify its
-        contents. Extract the various components and stash them in the
-        appropriate location(s) for use by the uCPE Manager, so that the VNF
-        can be treated by the uCPE Manager as a device. Then to add the VNF
-        descriptor to the VNF Descriptor Catalog.</para>
-
-        <para>Once these operations are complete, you will be provided with a
-        success message.</para>
-      </section>
-
-      <section id="onboarding_a_bundled_vnf_wizard">
+      <section id="onboarding_a_vnf_wizard">
         <title>Onboarding a VNF VM Image using the Onboarding Wizard</title>
 
-        <para><emphasis role="bold">How to onboard a VNF onto the uCPE Manager
+        <para><emphasis role="bold">How to onboard a VNF into the uCPE Manager
         using the Onboarding Wizard</emphasis></para>
 
         <orderedlist>
           <listitem>
-            <para>Select the uCPE Device.</para>
+            <para>Make sure the uCPE device is added and placed on the map in
+            the uCPE Manager.</para>
           </listitem>
 
           <listitem>
             <para>Select from the top toolbar <literal>VNF</literal> -&gt;
-            <literal>Descriptors</literal></para>
+            <literal>Descriptors.</literal></para>
           </listitem>
 
           <listitem>
@@ -581,7 +521,7 @@
           </listitem>
         </itemizedlist>
 
-        <para><emphasis role="bold">Interfaces Table</emphasis></para>
+        <para><emphasis role="bold">Interfaces Tab</emphasis></para>
 
         <figure>
           <title>Interfaces Table</title>
@@ -620,47 +560,66 @@
         </figure>
 
         <para>As shown in the picture above, there are three fields that need
-        to be populated: Cloud-Init Datasource, Cloud-Init Disk Type and the
-        Content Files Table.</para>
-
-        <para>To onboard the VNF you must specify the Cloud-Init datasource
-        that the VNF uses. You can get this information from the VNF Vendor.
-        Choose one of the following methods to specify the datasource:</para>
+        to be populated:</para>
 
-        <itemizedlist>
+        <orderedlist>
           <listitem>
-            <para><emphasis role="bold">ConfigDrive</emphasis>. This method
-            allows you to provide any number of content-data files containing
-            Cloud-Init data.</para>
+            <para><emphasis role="bold">Cloud-Init
+            Datasource</emphasis></para>
+
+            <para>To onboard the VNF you must specify the<literal> Cloud-Init
+            Datasource</literal> that the VNF uses. You can get this
+            information from the VNF Vendor. Choose one of the following
+            methods to specify the datasource:</para>
+
+            <itemizedlist>
+              <listitem>
+                <para><emphasis role="bold">None</emphasis>. If there is no
+                datasource.</para>
+              </listitem>
+
+              <listitem>
+                <para><emphasis role="bold">ConfigDrive</emphasis>. This
+                method allows you to provide any number of content-data files
+                containing Cloud-Init data.</para>
+              </listitem>
+
+              <listitem>
+                <para><emphasis role="bold">NoCloud</emphasis>. This is a
+                simpler method that uses only one cloud init file
+                (User-Data).</para>
+              </listitem>
+
+              <listitem>
+                <para><emphasis role="bold">ISO</emphasis>. Pre-cooked
+                cloud-init image. This image must be created by the user
+                according to VNF requirements.</para>
+              </listitem>
+            </itemizedlist>
           </listitem>
 
           <listitem>
-            <para><emphasis role="bold">NoCloud</emphasis>. This is a simpler
-            method that uses only one cloud init file (User-Data).</para>
+            <para><emphasis role="bold">Cloud-Init Disk Type</emphasis></para>
+
+            <para>The <literal>Cloud-Init Disk Type </literal>field must be
+            set to either <literal>Disk</literal>, or
+            <literal>CD-ROM</literal>, depending on what the VNF requires. You
+            can get this information from the VNF Vendor.</para>
           </listitem>
 
           <listitem>
-            <para><emphasis role="bold">ISO</emphasis>. Pre-cooked cloud-init
-            image. This image must be created by user according to VNF
-            requirements.</para>
+            <para><emphasis role="bold">Content Files Table</emphasis></para>
+
+            <para>The <literal>Content Files Table </literal>is ONLY used if
+            you choose <literal>ConfigDrive</literal> as the Cloud-Init
+            Datasource. For each content file added, you must provide a
+            <literal>Path</literal>. When a user uses the uCPE Manager to
+            create an instance of one of these VNFs, they will be prompted to
+            provide a data file for each entry in this table. Each type of VNF
+            will require different cloud-init files, e.g.: a license
+            file.</para>
           </listitem>
-        </itemizedlist>
-
-        <para>The Cloud-Init Disk Type field must be set to either
-        <literal>Disk</literal>, or <literal>CD-ROM</literal>, depending on
-        what the VNF requires. You can get this information from the VNF
-        Vendor.</para>
-
-        <para>The Content Files Table is used ONLY if you chose
-        <literal>ConfigDrive</literal> as the Cloud-Init Datasource. For each
-        content file added, you must provide a <literal>Path</literal>. When a
-        user uses the uCPE Manager to create an instance of one of these VNFs,
-        they will be prompted to provide a data file for each entry in this
-        table. Each type of VNF will require different cloud-init files, e.g.:
-        a license file.</para>
-
-        <para>Consult with the VNF vendor to determine what is required for
-        the VNF you are onboarding.</para>
+        </orderedlist>
 
         <figure>
           <title>Content Files Table example</title>
@@ -673,6 +632,9 @@
           </mediaobject>
         </figure>
 
+        <para>Consult with the VNF vendor to determine what is required for
+        the VNF you are onboarding.</para>
+
         <para><emphasis role="bold">Properties Tab</emphasis></para>
 
         <para>In this table, you can enter values for properties that will be
@@ -704,14 +666,37 @@
     <section id="instantiating_a_vnf">
       <title>Instantiating a VNF</title>
 
-      <para>Once the VNF bundle has been onboarded, you can instantiate a VNF
-      on a specific uCPE device.</para>
+      <para>Once the VNF has been onboarded, you can instantiate a VNF on a
+      specific uCPE device.</para>
+
+      <para><emphasis role="bold">How to instantiate a VNF using the
+      Wizard</emphasis></para>
 
-      <para>Launch the <literal>VNF instance</literal> table by choosing the
-      <literal>Instances</literal> option from the <literal>VNF</literal>
-      menu. This will display the table of VNF instances controlled by the VNF
-      Manager. Hit the <literal>Add</literal> button to create a new
-      instance:</para>
+      <orderedlist>
+        <listitem>
+          <para>Make sure the uCPE device is added and placed on the map in
+          the uCPE Manager.</para>
+        </listitem>
+
+        <listitem>
+          <para>Make sure the VNF has been onboarded into the uCPE
+          Manager.</para>
+        </listitem>
+
+        <listitem>
+          <para>Select from the top toolbar <literal>VNF</literal> -&gt;
+          <literal>Instances</literal></para>
+        </listitem>
+
+        <listitem>
+          <para>Click the <literal>Add</literal> button.</para>
+        </listitem>
+
+        <listitem>
+          <para>When prompted by the following UI, fill the required
+          fields.</para>
+        </listitem>
+      </orderedlist>
 
       <figure>
         <title>Instantiating a VNF</title>
@@ -735,13 +720,13 @@
 
         <listitem>
           <para><emphasis role="bold">VNF Type</emphasis>. The name of the
-          on-boarded VNF bundle. In this case <literal>VProbe</literal>
-          VNF.</para>
+          onboarded VNF. In this case <literal>VProbe</literal> VNF.</para>
         </listitem>
 
         <listitem>
-          <para><emphasis role="bold">Flavor</emphasis>. The flavor of VNF (as
-          specified in the descriptor) you would like to instantiate.</para>
+          <para><emphasis role="bold">Flavour</emphasis>. The flavour of VNF
+          (as specified in the descriptor) you would like to
+          instantiate.</para>
         </listitem>
 
         <listitem>
@@ -751,15 +736,6 @@
         </listitem>
 
         <listitem>
-          <para><emphasis role="bold">Instantiation Parameters</emphasis>.
-          This section contains all the parameters a user needs to supply when
-          instantiating a VNF of this type. The <literal>VProbe</literal> VNF
-          needs to specify network information (network name and IP address)
-          for two separate interfaces. Every VNF type will have a different UI
-          section here.</para>
-        </listitem>
-
-        <listitem>
           <para><emphasis role="bold">Auto-start</emphasis>. If checked, the
           VNF will be stopped and started when unreachable. When the VIM
           reports that it has lost connection to the VNF, the uCPE Manager
@@ -770,63 +746,7 @@
       </itemizedlist>
 
       <para>Hitting the <literal>Create</literal> button will cause the VNF to
-      be instantiated and run on the uCPE device specified above. The
-      following operations will now take place:</para>
-
-      <orderedlist>
-        <listitem>
-          <para>Check if the uCPE device already has the VNF Flavor definition in its
-          flavor store; if not create a new Flavor definition on the
-          uCPE device.</para>
-        </listitem>
-
-        <listitem>
-          <para>Check if the uCPE device already has the VNF image in its image
-          store; if not, upload the image and create a new Image definition on
-          the uCPE device.</para>
-        </listitem>
-
-        <listitem>
-          <para>Take in the user parameters and create the following:</para>
-
-          <itemizedlist>
-            <listitem>
-              <para><emphasis role="bold">Networking information.</emphasis>
-              Use the <literal>VnfGuiProcessorIf</literal> class<literal>
-              getConnectionInfo()</literal> method to convert user parameters
-              into networking information objects (refer to Section 6.1 for
-              the <literal>VProbe</literal> VNF).</para>
-            </listitem>
-          </itemizedlist>
-
-          <itemizedlist>
-            <listitem>
-              <para><emphasis role="bold">Cloud-init.</emphasis> Use generic
-              VNF instance information in conjunction with the networking
-              information objects from above and invoke the
-              <literal>getCloudInitData()</literal> method on the
-              <literal>VnfProcessorIf</literal> class (refer to Section 6.2
-              for how this is done for the <literal>VProbe</literal> VNF). The
-              cloud-init data is the script that will be executed by the VNF
-              when it starts up for the first time only. It is responsible for
-              setting up the initial system configuration to what is required
-              by the VNF to run correctly, setting up the network interfaces,
-              static IP addresses, etc.</para>
-            </listitem>
-          </itemizedlist>
-        </listitem>
-
-        <listitem>
-          <para>Make the uCPE create the VNF with the specified image, flavor
-          and cloud-init data via a NETCONF request and wait for the VNF to be
-          created and booted up.</para>
-        </listitem>
-
-        <listitem>
-          <para>If successful, optionally add the newly created VNF as a
-          device in the uCPE Manager.</para>
-        </listitem>
-      </orderedlist>
+      be instantiated and run on the specified uCPE device.</para>
 
       <para>Selecting the<literal> VNF -&gt; Events</literal> menu will show
       that the VNF was created and a connection was established:</para>