USERDOCAPAP-240 included tacker.xml and minor edits, ommissions

6 files changed, 116 insertions, 68 deletions

diff --git a/book-enea-nfv-core-installation-guide/doc/about_release.xml b/book-enea-nfv-core-installation-guide/doc/about_release.xml
index 82d1ced..184a67a 100644
--- a/book-enea-nfv-core-installation-guide/doc/about_release.xml
+++ b/book-enea-nfv-core-installation-guide/doc/about_release.xml
@@ -4,22 +4,18 @@
 <chapter id="relinfo-about-release">
   <title>About This Release</title>
 
-  <section id="relinfo-introduction">
-    <title>Introduction</title>
+  <para>This document provides guidelines on how to install and configure the
+  1.0 release of Enea NFV Core when using Fuel as a deployment tool, including
+  the required software and hardware configurations, resulting in an Enea NFV
+  compliant deployment.</para>
 
-    <para>This document provides guidelines on how to install and configure
-    the 1.0 release of Enea NFV Core when using Fuel as a deployment tool,
-    including the required software and hardware configurations, resulting in
-    an Enea NFV compliant deployment.</para>
+  <para>The available installation options give a high degree of freedom in
+  how the system is set-up, including architecture, services and features,
+  etc., however, the noted permutations may not provide an Enea NFV compliant
+  reference architecture.</para>
 
-    <para>The available installation options give a high degree of freedom in
-    how the system is set-up, including architecture, services and features,
-    etc., however, the noted permutations may not provide an Enea NFV
-    compliant reference architecture.</para>
-
-    <para>The audience of this document is assumed to have good grasp of
-    networking and Unix/Linux/OpenStack administration knowledge.</para>
-  </section>
+  <para>The audience of this document is assumed to have good grasp of
+  networking and Unix/Linux/OpenStack administration knowledge.</para>
 
   <section condition="hidden" id="defi_acro">
     <title>Definitions and Acronyms</title>
diff --git a/book-enea-nfv-core-installation-guide/doc/book.xml b/book-enea-nfv-core-installation-guide/doc/book.xml
index fcba092..18673e6 100644
--- a/book-enea-nfv-core-installation-guide/doc/book.xml
+++ b/book-enea-nfv-core-installation-guide/doc/book.xml
@@ -12,6 +12,7 @@
   <xi:include href="installation_instructions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
 <!--  <xi:include href="post_deploy_config.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> -->
   <xi:include href="hw_features.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+  <xi:include href="tacker.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
   <xi:include href="high_availability.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-  <xi:include href="use_cases_per_target_node.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+<!--  <xi:include href="use_cases_per_target_node.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> -->
 </book>
diff --git a/book-enea-nfv-core-installation-guide/doc/high_availability.xml b/book-enea-nfv-core-installation-guide/doc/high_availability.xml
index 655654b..4047dd6 100644
--- a/book-enea-nfv-core-installation-guide/doc/high_availability.xml
+++ b/book-enea-nfv-core-installation-guide/doc/high_availability.xml
@@ -546,7 +546,7 @@ root@node-6:~# systemctl restart vitrage-graph</programlisting>
     </section>
   </section>
 
-  <section id="pm_high_avail">
+  <section condition="hidden" id="pm_high_avail">
     <title>Pacemaker High Availability</title>
 
     <para>Many of the OpenStack solutions which offer High Availability
diff --git a/book-enea-nfv-core-installation-guide/doc/installation_instructions.xml b/book-enea-nfv-core-installation-guide/doc/installation_instructions.xml
index caf7b58..2de6353 100644
--- a/book-enea-nfv-core-installation-guide/doc/installation_instructions.xml
+++ b/book-enea-nfv-core-installation-guide/doc/installation_instructions.xml
@@ -14,15 +14,11 @@
   deploying OpenStack on a cluster of servers.</para>
 
   <para>Enea NFV Core 1.0 is based on the OPNFV <emphasis role="bold">Danube
-  </emphasis>release, available for aarch64 servers through the OPNFV Armband
-  project that is driven by Enea, which also uses the Fuel Installer. The
-  Armband project is out of the scope of this document but information is
-  available online on the OPNFV wiki.</para>
-
-  <para>The <ulink url="https://www.opnfv.org/software/downloads">OPNFV
-  download page</ulink> provides general instructions for building and
-  installing the Fuel Installer ISO and also on how to deploy OPNFV Danube
-  using Fuel on a Pharos compliant test lab.</para>
+  </emphasis>release. The <ulink
+  url="https://www.opnfv.org/software/downloads">OPNFV download page</ulink>
+  provides general instructions for building and installing the Fuel Installer
+  ISO and also on how to deploy OPNFV Danube using Fuel on a Pharos compliant
+  test lab.</para>
 
   <note>
     <para>Covering chapters 1-6 of the Fuel Installation Guide is useful for
@@ -137,20 +133,15 @@
 
     <para>Enea NFV Core 1.0 has been validated with the requirements shown
     below, which represent the recommended configuration that must be met for
-    the installation of Enea NFV Core 1.0 using Fuel, to be successful:</para>
+    the installation of Enea NFV Core 1.0 using Fuel, to be successful.</para>
+
+    <para><emphasis role="bold">Hardware Requirements for
+    Aarch64:</emphasis></para>
 
     <informaltable>
       <tgroup cols="2">
         <tbody>
           <row>
-            <entry align="center" colname="HW Aspect"><emphasis
-            role="bold">Hardware Aspect for ThunderX</emphasis></entry>
-
-            <entry align="center" colname="Requirement"><emphasis
-            role="bold">Requirement</emphasis></entry>
-          </row>
-
-          <row>
             <entry align="left">Nr. of nodes</entry>
 
             <entry>6 physical nodes:<itemizedlist>
@@ -199,21 +190,13 @@
       </tgroup>
     </informaltable>
 
-    <para>Below are detailed the requirements for validated x86
-    configurations:</para>
+    <para><emphasis role="bold">Hardware Requirements for
+    x86</emphasis>:</para>
 
     <informaltable>
       <tgroup cols="2">
         <tbody>
           <row>
-            <entry align="center" colname="HW Aspect"><emphasis
-            role="bold">Hardware Aspect</emphasis></entry>
-
-            <entry align="center" colname="Requirement"><emphasis
-            role="bold">Requirement</emphasis></entry>
-          </row>
-
-          <row>
             <entry align="left">Nr. of nodes</entry>
 
             <entry>Controllers (3x):<itemizedlist>
@@ -268,14 +251,6 @@
       <tgroup cols="2">
         <tbody>
           <row>
-            <entry align="center" colname="HW Aspect"><emphasis
-            role="bold">Hardware Aspect</emphasis></entry>
-
-            <entry align="center" colname="Requirement"><emphasis
-            role="bold">Requirement</emphasis></entry>
-          </row>
-
-          <row>
             <entry align="left">Nr. of nodes</entry>
 
             <entry>Compute (2x):<itemizedlist>
@@ -515,7 +490,7 @@
 
       <listitem>
         <para>Connect to the FUEL UI via the URL provided in the Console
-        (default: https://10.20.0.2:8443)</para>
+        (default: http://10.0.6.10)</para>
       </listitem>
 
       <listitem>
@@ -575,8 +550,8 @@
     additional plugins in <literal>/opt/opnfv</literal>:</para>
 
     <programlisting>$ fuel plugins --install /opt/opnfv/vitrage-1.0-1.0.4-1.noarch.rpm
-$ fuel plugins --install zabbix_monitoring-2.5-2.5.3-1.noarch.rpm
-$ fuel plugins --install tacker-1.0-1.0.0-1.noarch.rpm
+$ fuel plugins --install /opt/opnfv/zabbix_monitoring-2.5-2.5.3-1.noarch.rpm
+$ fuel plugins --install /opt/opnfv/tacker-1.0-1.0.0-1.noarch.rpm
 $ fuel plugins --install /opt/opnfv/fuel-plugin-kvm-1.0-1.0.0-1.noarch.rpm</programlisting>
 
     <para>Expected output: <programlisting>Plugin ....... was successfully installed.</programlisting></para>
@@ -745,6 +720,10 @@ $ fuel plugins --install /opt/opnfv/fuel-plugin-kvm-1.0-1.0.0-1.noarch.rpm</prog
           <listitem>
             <para>Set VLAN tagging as needed</para>
           </listitem>
+
+          <listitem>
+            <para>Set an appropriate VLAN ID (default 102)</para>
+          </listitem>
         </itemizedlist>
       </listitem>
 
@@ -910,22 +889,33 @@ $ fuel plugins --install /opt/opnfv/fuel-plugin-kvm-1.0-1.0.0-1.noarch.rpm</prog
     </itemizedlist>
   </section>
 
-  <section id="plugins">
-    <title>Enabling Plugins</title>
+  <section id="storage_plugins_addicomps">
+    <title>Storage, Plugins and Additional Components</title>
 
     <para>In the FUEL UI of your Environment, click the
-    <literal>Settings</literal> tab and select <literal>OpenStack
-    Services</literal> on the left side pane, make sure Tacker is NOT enabled
-    and save your settings. Tacker functionality will be enabled after
-    deployment is performed.</para>
+    <literal>Settings</literal> tab and select <literal>Storage</literal>.
+    Make sure the components shown below in <literal>Common</literal> and
+    <literal>Storage Backends</literal> are enabled:</para>
+
+    <mediaobject>
+      <imageobject>
+        <imagedata contentwidth="600" fileref="images/Ceph_replication.svg" />
+      </imageobject>
+    </mediaobject>
+
+    <para>Save your settings and select <literal>OpenStack Services</literal>
+    on the left side pane. <literal>Install Ceilometer and Aodh</literal>
+    should be enabled, while <literal>Tacker VNF manager</literal> should not.
+    Tacker functionality will be enabled after deployment is performed.</para>
 
     <mediaobject>
       <imageobject>
-        <imagedata contentwidth="600" fileref="images/openstack_services.svg" />
+        <imagedata contentwidth="600"
+                   fileref="images/Ceilometer_Aodhchecked_Tackerunchecked.svg" />
       </imageobject>
     </mediaobject>
 
-    <para>Click on <literal>Other</literal> on the left pane and do the
+    <para>Select <literal>Other</literal> on the left pane and do the
     following:</para>
 
     <itemizedlist>
@@ -949,8 +939,13 @@ $ fuel plugins --install /opt/opnfv/fuel-plugin-kvm-1.0-1.0.0-1.noarch.rpm</prog
       </listitem>
 
       <listitem>
-        <para>Enable and configure the KVM For NFV Plugin. <remark>insert
-        screenshot here of Tacker not checked and KVM checked.</remark></para>
+        <para>Enable and configure the KVM For NFV Plugin.</para>
+
+        <mediaobject>
+          <imageobject>
+            <imagedata contentwidth="600" fileref="images/KVM_checked.svg" />
+          </imageobject>
+        </mediaobject>
       </listitem>
     </itemizedlist>
 
diff --git a/book-enea-nfv-core-installation-guide/doc/tacker.xml b/book-enea-nfv-core-installation-guide/doc/tacker.xml
new file mode 100644
index 0000000..b1f44d4
--- /dev/null
+++ b/book-enea-nfv-core-installation-guide/doc/tacker.xml
@@ -0,0 +1,56 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<chapter id="tacker">
+  <title>Installing Tacker</title>
+
+  <para><emphasis role="bold">Tacker</emphasis> is an OpenStack project,
+  building a generic VNF Manager and a NFV Orchestrator in order to deploy and
+  operate Network Services and Virtual Network Functions on an NFV
+  infrastructure platform. It is based on ETSI MANO Architectural Framework
+  and provides a functional stack to Orchestrate Network Services end-to-end
+  using VNFs.</para>
+
+  <para>Follow these steps to install the plugin:</para>
+
+  <orderedlist>
+    <listitem>
+      <para><command>ssh</command> into the
+      <literal>fuel-master</literal>:<programlisting>ssh ${FUEL_IP}</programlisting></para>
+    </listitem>
+
+    <listitem>
+      <para>Go to the tacker plugin directory:<programlisting>cd /var/www/nailgun/plugins/tacker-1.0/repositories/tacker</programlisting></para>
+    </listitem>
+
+    <listitem>
+      <para>Run the initialization script:<programlisting>./files/init.sh</programlisting>This
+      will create a hosts file for ansible
+      <literal>/etc/ansible/hosts</literal> of the form:<programlisting>**********
+[controllers]
+node-3 mac_addr+68:05:ca:46:8b:64 ipmi_ip=0.0.0.0 ipmi_user=****** ipmi_pass=******
+node-2 mac_addr+68:05:ca:46:8c:d4 ipmi_ip=0.0.0.0 ipmi_user=****** ipmi_pass=******
+node-1 mac_addr+68:05:ca:46:8c:45 ipmi_ip=0.0.0.0 ipmi_user=****** ipmi_pass=******
+[main_cont]
+node-3
+[computes]
+node-5 mac_addr+68:05:ca:46:8c:c9 ipmi_ip=0.0.0.0 ipmi_user=****** ipmi_pass=******
+node-4 mac_addr+68:05:ca:46:8c:c2 ipmi_ip=0.0.0.0 ipmi_user=****** ipmi_pass=******
+[nodes:children]
+controllers
+computes
+**********</programlisting></para>
+    </listitem>
+
+    <listitem>
+      <para>Use your favorite text editor to manually edit
+      <literal>ipmi_ip</literal> with the ip address of the ipmi interface,
+      <literal>ipmi_user</literal> with the user for accessing the ipmi
+      interface, and <literal>ipmi_psss</literal> with the password used by
+      the user to access the ipmi interface for all the nodes.</para>
+    </listitem>
+
+    <listitem>
+      <para>Run the ansible playbook responsible with the installation and
+      configuration of tacker plugin.<programlisting>ansible-playbook tacker_deploy.yaml</programlisting></para>
+    </listitem>
+  </orderedlist>
+</chapter>
\ No newline at end of file
diff --git a/book-enea-nfv-core-installation-guide/doc/use_cases_per_target_node.xml b/book-enea-nfv-core-installation-guide/doc/use_cases_per_target_node.xml
index 3d2582c..34d46eb 100644
--- a/book-enea-nfv-core-installation-guide/doc/use_cases_per_target_node.xml
+++ b/book-enea-nfv-core-installation-guide/doc/use_cases_per_target_node.xml
@@ -2,11 +2,11 @@
 <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
 <chapter id="use-cases">
-  <title>Use Cases</title>
+  <title condition="hidden">Use Cases</title>
 
   <para>This chapter contains use-case examples for each target node pool(s)
   used/compatible with the Fuel Deployment Tool.</para>
 
-  <remark>FIXME Team COSNOS/Enea NFV Core will need to fill this chapter with any
-  and all appropriate use cases.</remark>
+  <remark>FIXME Team COSNOS/Enea NFV Core will need to fill this chapter with
+  any and all appropriate use cases.</remark>
 </chapter>
\ No newline at end of file