COSNOSCR-576 final corrections made to the install. guide and rel info. ver update.

6 files changed, 179 insertions, 99 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 184a67a..1a74169 100644
--- a/book-enea-nfv-core-installation-guide/doc/about_release.xml
+++ b/book-enea-nfv-core-installation-guide/doc/about_release.xml
@@ -5,9 +5,11 @@
   <title>About This Release</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>
+  <xi:include href="../../s_docsrc_common/pardoc-distro.xml"
+  xmlns:xi="http://www.w3.org/2001/XInclude"
+  xpointer="element(EneaNFV_REL_VER/1)" /> 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,
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 e6dc825..6d27b00 100644
--- a/book-enea-nfv-core-installation-guide/doc/high_availability.xml
+++ b/book-enea-nfv-core-installation-guide/doc/high_availability.xml
@@ -2,18 +2,25 @@
 <chapter id="high_availability">
   <title>High Availability Guide</title>
 
-  <para>Enea NFV Core 1.0 has been designed to provide high availability
-  characteristics that are needed for developing and deploying telco-grade NFV
-  solutions on top of our OPNFV based platform. The High Availability subject
-  in general is very wide and still an important focus in both opensource
-  communities and the independent/proprietary solutions market.</para>
-
-  <para>Enea NFV Core 1.0 aims to initially leverage the efforts in the
-  upstream OPNFV and OpenStack opensource projects, combining solutions from
-  both worlds in an effort to provide flexibility and use-case coverage. Enea
-  has long term expertise and proprietary solutions addressing High
-  Availability for telco applications, which are subject to integration with
-  the NFV based solutions.</para>
+  <para>Enea NFV Core <xi:include
+  href="../../s_docsrc_common/pardoc-distro.xml"
+  xmlns:xi="http://www.w3.org/2001/XInclude"
+  xpointer="element(EneaNFV_REL_VER/1)" /> has been designed to provide high
+  availability characteristics that are needed for developing and deploying
+  telco-grade NFV solutions on top of our OPNFV based platform. The High
+  Availability subject in general is very wide and still an important focus in
+  both opensource communities and the independent/proprietary solutions
+  market.</para>
+
+  <para>Enea NFV Core <xi:include
+  href="../../s_docsrc_common/pardoc-distro.xml"
+  xmlns:xi="http://www.w3.org/2001/XInclude"
+  xpointer="element(EneaNFV_REL_VER/1)" /> aims to initially leverage the
+  efforts in the upstream OPNFV and OpenStack opensource projects, combining
+  solutions from both worlds in an effort to provide flexibility and use-case
+  coverage. Enea has long term expertise and proprietary solutions addressing
+  High Availability for telco applications, which are subject to integration
+  with the NFV based solutions.</para>
 
   <section id="levels">
     <title>High Availability Levels</title>
@@ -94,7 +101,10 @@
         communicate with Controllers in order to update the states of the
         virtual and physical resources.</para>
 
-        <para>For this component Enea NFV Core 1.0 makes use of Vitrage, an
+        <para>For this component Enea NFV Core <xi:include
+        href="../../s_docsrc_common/pardoc-distro.xml"
+        xmlns:xi="http://www.w3.org/2001/XInclude"
+        xpointer="element(EneaNFV_REL_VER/1)" /> makes use of Vitrage, an
         OpenStack related project used for Root Cause Analysis. The
         integration into the platform is done with the help of a Fuel Plugin
         which has been developed internally by Enea.</para>
@@ -130,13 +140,16 @@
         can be accessed from one of the servers that act as OpenStack
         Controller nodes.</para>
 
-        <para>In Enea NFV Core 1.0 the Administrator can also access the
-        Zabbix dashboard to perform supplementary configurations. The same
-        applies for the Vitrage tool, which comes with its own Horizon
-        dashboard, enabling the user to visually inspect the faults reported
-        by the monitoring tools through visual representations of the virtual
-        and physical resources, the relationships between them and the fault
-        correlation.</para>
+        <para>In Enea NFV Core <xi:include
+        href="../../s_docsrc_common/pardoc-distro.xml"
+        xmlns:xi="http://www.w3.org/2001/XInclude"
+        xpointer="element(EneaNFV_REL_VER/1)" /> the Administrator can also
+        access the Zabbix dashboard to perform supplementary configurations.
+        The same applies for the Vitrage tool, which comes with its own
+        Horizon dashboard, enabling the user to visually inspect the faults
+        reported by the monitoring tools through visual representations of the
+        virtual and physical resources, the relationships between them and the
+        fault correlation.</para>
 
         <para>For Vitrage, users will usually want to configure additional
         use-cases and describe relationships between components via template
@@ -152,10 +165,13 @@
         the VNFs. The role of the Consumer thus falls to that of a VNF Manager
         and Orchestrator.</para>
 
-        <para>Enea NFV Core 1.0 provides VNF management capabilities using
-        Tacker, which is an OpenStack project that implements a generic VNF
-        Manager and Orchestrator, according to the ETSI MANO Architectural
-        Framework.</para>
+        <para>Enea NFV Core <xi:include
+        href="../../s_docsrc_common/pardoc-distro.xml"
+        xmlns:xi="http://www.w3.org/2001/XInclude"
+        xpointer="element(EneaNFV_REL_VER/1)" /> provides VNF management
+        capabilities using Tacker, which is an OpenStack project that
+        implements a generic VNF Manager and Orchestrator, according to the
+        ETSI MANO Architectural Framework.</para>
       </listitem>
     </itemizedlist>
 
@@ -196,7 +212,11 @@
         </imageobject>
       </mediaobject>
 
-      <para>Enea NFV Core 1.0 uses the same approach described above:</para>
+      <para>Enea NFV Core <xi:include
+      href="../../s_docsrc_common/pardoc-distro.xml"
+      xmlns:xi="http://www.w3.org/2001/XInclude"
+      xpointer="element(EneaNFV_REL_VER/1)" /> uses the same approach
+      described above:</para>
 
       <orderedlist>
         <listitem>
@@ -287,8 +307,11 @@
       </orderedlist>
 
       <note condition="hidden">
-        <para>The ENEA NFV Core 1.0 Pre-Release fully covers the required
-        Doctor functionality only for the Vitrage and Zabbix
+        <para>The ENEA NFV Core <xi:include
+        href="../../s_docsrc_common/pardoc-distro.xml"
+        xmlns:xi="http://www.w3.org/2001/XInclude"
+        xpointer="element(EneaNFV_REL_VER/1)" /> Pre-Release fully covers the
+        required Doctor functionality only for the Vitrage and Zabbix
         components.</para>
       </note>
     </section>
@@ -309,7 +332,9 @@
 
       <para>The Zabbix configuration dashboard is available at the same IP
       address where OpenStack can be reached, e.g.
-      <literal>http://10.0.101.42/zabbix</literal>.</para>
+      <literal>http://10.0.101.42/zabbix</literal>. Default username and
+      password are <literal>admin</literal> and <literal>zabbix</literal>
+      respectively.</para>
 
       <mediaobject>
         <imageobject>
@@ -422,7 +447,10 @@
         </listitem>
 
         <listitem>
-          <para>Next, select the <literal>Media</literal> tab and click
+          <para>Reselect the <literal>admin</literal> alias to enter the
+          <literal>Configuration of Users</literal> screen once again.</para>
+
+          <para>Select the <literal>Media</literal> tab and click
           <literal>Add</literal> to create and modify a new media type. A
           popup menu will appear for <literal>New Media</literal>. Fill each
           field with the values below:</para>
@@ -436,10 +464,10 @@
               <para>Send to: <literal>e.g.
               rabbit://nova:Q1Vt9iocA8OpXKOPoUYOLKie@192.168.0.4:5673/</literal></para>
 
-              <para>You need to search for this in
-              <literal>/etc/vitrage/vitrage.conf or in /etc/nova/nova.conf
-              transport_url</literal>. It is vital that the url contains the
-              ending " / ".</para>
+              <para>This url can be found in either
+              <literal>/etc/vitrage/vitrage.conf or in
+              /etc/nova/nova.conf</literal>. Only one url is needed and it is
+              vital that the url contains the ending " / ".</para>
             </listitem>
 
             <listitem>
@@ -473,7 +501,7 @@
           <literal>Configuration</literal> tab select
           <literal>Actions</literal>. Then, under the
           <literal>Action</literal> tab, fill in the parameter fields with the
-          values below and click <literal>Add</literal></para>
+          values below:</para>
 
           <itemizedlist>
             <listitem>
@@ -538,7 +566,7 @@ lastchange={EVENT.DATE} {EVENT.TIME}</programlisting>
                 </listitem>
 
                 <listitem>
-                  <para>Send to Users: add <literal>Admin</literal></para>
+                  <para>Send to Users: add <literal>admin</literal></para>
                 </listitem>
 
                 <listitem>
@@ -578,7 +606,7 @@ lastchange={EVENT.DATE} {EVENT.TIME}</programlisting>
 
       <para>In order to make use of these features, Vitrage supports
       additional configurations via <literal>yaml</literal> templates that
-      must be placed in <literal>/etc/vitrage/templates</literal> on the nodes
+      must be placed in <literal>/etc/vitrage/templates</literal> on the node
       that have the Vitrage role.</para>
 
       <mediaobject>
@@ -667,8 +695,11 @@ root@node-6:~# systemctl restart vitrage-graph</programlisting>
     <section id="vitrage_custom">
       <title>Vitrage Customizations</title>
 
-      <para>Enea NFV Core 1.0 has added custom features for Vitrage which
-      allow two kinds of actions:</para>
+      <para>Enea NFV Core <xi:include
+      href="../../s_docsrc_common/pardoc-distro.xml"
+      xmlns:xi="http://www.w3.org/2001/XInclude"
+      xpointer="element(EneaNFV_REL_VER/1)" /> has added custom features for
+      Vitrage which allow two kinds of actions:</para>
 
       <orderedlist>
         <listitem>
@@ -866,12 +897,15 @@ RemoteOnline: [ node-4.domain.tld node-5.domain.tld ]</programlisting>
     <section id="pm_fencing">
       <title>Pacemaker Fencing</title>
 
-      <para>ENEA NFV Core 1.0 makes use of the fencing capabilities of
-      Pacemaker to isolate faulty nodes and trigger recovery actions by means
-      of power cycling the failed nodes. Fencing is configured by creating
-      <literal>STONITH</literal> type resources for each of the servers in the
-      cluster, both Controller nodes and Compute nodes. The
-      <literal>STONITH</literal> adapter for fencing the nodes is
+      <para>ENEA NFV Core <xi:include
+      href="../../s_docsrc_common/pardoc-distro.xml"
+      xmlns:xi="http://www.w3.org/2001/XInclude"
+      xpointer="element(EneaNFV_REL_VER/1)" /> makes use of the fencing
+      capabilities of Pacemaker to isolate faulty nodes and trigger recovery
+      actions by means of power cycling the failed nodes. Fencing is
+      configured by creating <literal>STONITH</literal> type resources for
+      each of the servers in the cluster, both Controller nodes and Compute
+      nodes. The <literal>STONITH</literal> adapter for fencing the nodes is
       <literal>fence_ipmilan</literal>, which makes use of the IPMI
       capabilities of the ThunderX servers.</para>
 
@@ -965,9 +999,12 @@ ipaddr=10.0.100.155 login=ADMIN passwd=ADMIN op monitor interval="60s"</programl
     resources capable of identifying failures in compute nodes and can perform
     automatic evacuation of the instances affected by these failures.</para>
 
-    <para>ENEA NFV Core 1.0 aims to validate and integrate this work and to
-    make this feature available in the platform aimed as an alternative to the
-    Doctor framework, where simple, autonomous recovery of running instances
-    is desired.</para>
+    <para>ENEA NFV Core <xi:include
+    href="../../s_docsrc_common/pardoc-distro.xml"
+    xmlns:xi="http://www.w3.org/2001/XInclude"
+    xpointer="element(EneaNFV_REL_VER/1)" /> aims to validate and integrate
+    this work and to make this feature available in the platform aimed as an
+    alternative to the Doctor framework, where simple, autonomous recovery of
+    running instances is desired.</para>
   </section>
 </chapter>
\ No newline at end of file
diff --git a/book-enea-nfv-core-installation-guide/doc/hw_features.xml b/book-enea-nfv-core-installation-guide/doc/hw_features.xml
index 6b4ac39..cdba908 100644
--- a/book-enea-nfv-core-installation-guide/doc/hw_features.xml
+++ b/book-enea-nfv-core-installation-guide/doc/hw_features.xml
@@ -2,8 +2,11 @@
 <chapter id="hw_features">
   <title>Hardware Features</title>
 
-  <para>Enea NFV Core 1.0 leverages certain Hardware features within the
-  ThunderX SoCs, the most important being DPDK and SR-IOV.</para>
+  <para>Enea NFV Core <xi:include
+  href="../../s_docsrc_common/pardoc-distro.xml"
+  xmlns:xi="http://www.w3.org/2001/XInclude"
+  xpointer="element(EneaNFV_REL_VER/1)" /> leverages certain Hardware features
+  within the ThunderX SoCs, the most important being DPDK and SR-IOV.</para>
 
   <para>Enea's mission, through the OPNFV Armband project, is to extend the
   OPNFV capabilities on aarch64 commercial servers, including the Cavium
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 6a67b74..0bbcdc3 100644
--- a/book-enea-nfv-core-installation-guide/doc/installation_instructions.xml
+++ b/book-enea-nfv-core-installation-guide/doc/installation_instructions.xml
@@ -4,17 +4,24 @@
 <chapter id="install_instructions">
   <title>Installation Instructions</title>
 
-  <para>Enea NFV Core 1.0 leverages the work in the OPNFV Project, delivering
-  selected Installer DVD images together with instructions on how to setup the
-  Installers and deploy OPNFV releases on a Pharos compliant test lab.</para>
+  <para>Enea NFV Core <xi:include
+  href="../../s_docsrc_common/pardoc-distro.xml"
+  xmlns:xi="http://www.w3.org/2001/XInclude"
+  xpointer="element(EneaNFV_REL_VER/1)" /> leverages the work in the OPNFV
+  Project, delivering selected Installer DVD images together with instructions
+  on how to setup the Installers and deploy OPNFV releases on a Pharos
+  compliant test lab.</para>
 
   <para>Enea NFV Core uses the Fuel@OPNFV Installer as a deployment facility,
   hereafter referred to as <emphasis role="bold">Fuel</emphasis>. Fuel is an
   automated deployment tool capable of automatically provisioning and
   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. The <ulink
+  <para>Enea NFV Core <xi:include
+  href="../../s_docsrc_common/pardoc-distro.xml"
+  xmlns:xi="http://www.w3.org/2001/XInclude"
+  xpointer="element(EneaNFV_REL_VER/1)" /> is based on the OPNFV <emphasis
+  role="bold">Danube </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
@@ -131,9 +138,16 @@
   <section id="hw_req">
     <title>Hardware Requirements</title>
 
-    <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>
+    <para>Enea NFV Core <xi:include
+    href="../../s_docsrc_common/pardoc-distro.xml"
+    xmlns:xi="http://www.w3.org/2001/XInclude"
+    xpointer="element(EneaNFV_REL_VER/1)" /> has been validated with the
+    requirements shown below, which represent the recommended configuration
+    that must be met for the installation of Enea NFV Core <xi:include
+    href="../../s_docsrc_common/pardoc-distro.xml"
+    xmlns:xi="http://www.w3.org/2001/XInclude"
+    xpointer="element(EneaNFV_REL_VER/1)" /> using Fuel, to be
+    successful.</para>
 
     <para><emphasis role="bold">Hardware Requirements for
     Aarch64:</emphasis></para>
@@ -310,8 +324,11 @@
 
     <orderedlist>
       <listitem>
-        <para>Mount the Enea NFV Core 1.0 ISO file/media as a boot device to
-        the Fuel Master VM.</para>
+        <para>Mount the Enea NFV Core <xi:include
+        href="../../s_docsrc_common/pardoc-distro.xml"
+        xmlns:xi="http://www.w3.org/2001/XInclude"
+        xpointer="element(EneaNFV_REL_VER/1)" /> ISO file/media as a boot
+        device to the Fuel Master VM.</para>
       </listitem>
 
       <listitem>
@@ -1140,10 +1157,13 @@ $ fuel plugins --install /opt/opnfv/fuel-plugin-kvm-1.0-1.0.0-1.noarch.rpm</prog
   <section id="config_wl_accel">
     <title>Configure Workload Acceleration</title>
 
-    <para>Enea NFV Core 1.0 supports NFV workload acceleration features such
-    as Huge Pages, Single-Root I/O Virtualization (SR-IOV), Data Plane
-    Developer Kit (DPDK), Non-Uniform Memory Access (NUMA) and CPU pinning.
-    Please refer to the <ulink
+    <para>Enea NFV Core <xi:include
+    href="../../s_docsrc_common/pardoc-distro.xml"
+    xmlns:xi="http://www.w3.org/2001/XInclude"
+    xpointer="element(EneaNFV_REL_VER/1)" /> supports NFV workload
+    acceleration features such as Huge Pages, Single-Root I/O Virtualization
+    (SR-IOV), Data Plane Developer Kit (DPDK), Non-Uniform Memory Access
+    (NUMA) and CPU pinning. Please refer to the <ulink
     url="https://docs.openstack.org/fuel-docs/latest/userdocs/fuel-user-guide/configure-environment/nfv.html">Fuel
     User Guide</ulink> for more information.</para>
 
@@ -1216,7 +1236,7 @@ $ fuel plugins --install /opt/opnfv/fuel-plugin-kvm-1.0-1.0.0-1.noarch.rpm</prog
         "Offloading Modes".</para>
 
         <para>Please check the Release Notes for the <phrase>1.0.1</phrase>
-        release of ENFV Core when using Fuel as a deployment tool,
+        release of Enea NFV Core when using Fuel as a deployment tool,
         <remark>Change this to an Olink to the Release notes once the ID has
         been created for that book. Add the ID to pardoc-names.xml and
         pardoc-common if needed, then updated the OlinkDB</remark>for an
diff --git a/book-enea-nfv-core-installation-guide/doc/tacker.xml b/book-enea-nfv-core-installation-guide/doc/tacker.xml
index e1791db..55cf18c 100644
--- a/book-enea-nfv-core-installation-guide/doc/tacker.xml
+++ b/book-enea-nfv-core-installation-guide/doc/tacker.xml
@@ -57,7 +57,7 @@ computes
     </orderedlist>
   </section>
 
-  <section id="install_tacker">
+  <section id="using_tacker">
     <title>Using Tacker</title>
 
     <para>After Tacker has been installed and configured, perform the
diff --git a/book-enea-nfv-core-release-info/doc/known_bugs_and_limitations.xml b/book-enea-nfv-core-release-info/doc/known_bugs_and_limitations.xml
index c24d2a9..55e9be7 100644
--- a/book-enea-nfv-core-release-info/doc/known_bugs_and_limitations.xml
+++ b/book-enea-nfv-core-release-info/doc/known_bugs_and_limitations.xml
@@ -276,9 +276,32 @@
             <para>Workaround:</para>
 
             <para>Starting the <literal>systemd</literal> service manually
-            makes it run successfully. Enea NFV Core 1.0.1 will be shipped
-            without Openstack Resource Agents, therefore this issue should not
-            affect the user.</para>
+            makes it run successfully. Enea NFV Core 1.0.1 is shipped without
+            Openstack Resource Agents, therefore this issue should not affect
+            the user.</para>
+          </listitem>
+        </itemizedlist>
+      </listitem>
+
+      <listitem>
+        <para>Issue #2 with Openstack Resource Agents and Compute Fencing
+        functionality</para>
+
+        <itemizedlist>
+          <listitem>
+            <para>Description and Impact:</para>
+
+            <para>In an OPNFV deployment that uses Openstack Resource Agents,
+            when we configure the <literal>fence_compute</literal> as a
+            Pacemaker resource, the Controller nodes start to reboot each
+            other endlessly.</para>
+          </listitem>
+
+          <listitem>
+            <para>Workaround:</para>
+
+            <para>Enea NFV Core 1.0.1 is shipped without Openstack Resource
+            Agents, therefore this issue should not affect the user.</para>
           </listitem>
         </itemizedlist>
       </listitem>
@@ -319,30 +342,6 @@
       </listitem>
 
       <listitem>
-        <para>Issue #2 with Openstack Resource Agents and Compute Fencing
-        functionality</para>
-
-        <itemizedlist>
-          <listitem>
-            <para>Description and Impact:</para>
-
-            <para>In an OPNFV deployment that uses Openstack Resource Agents,
-            when we configure the <literal>fence_compute</literal> as a
-            Pacemaker resource, the Controller nodes start to reboot each
-            other endlessly.</para>
-          </listitem>
-
-          <listitem>
-            <para>Workaround:</para>
-
-            <para>Enea NFV Core 1.0.1 will be shipped without Openstack
-            Resource Agents, therefore this issue should not affect the
-            user.</para>
-          </listitem>
-        </itemizedlist>
-      </listitem>
-
-      <listitem>
         <para>Offline Deploy with Fuel fails at times</para>
 
         <itemizedlist>
@@ -373,7 +372,7 @@
 
         <itemizedlist>
           <listitem>
-            <para>Description and Impact</para>
+            <para>Description and Impact:</para>
 
             <para>There is a short period of a few seconds after a VM stated
             the boot procedure when attaching an external volume will result
@@ -381,11 +380,11 @@
             kernel.</para>
 
             <para>Disks attached in the first few seconds of the booting
-            procedure of a VM, will fail to register in the guest VM..</para>
+            procedure of a VM, will fail to register in the guest VM.</para>
           </listitem>
 
           <listitem>
-            <para>Workaround</para>
+            <para>Workaround:</para>
 
             <para>Attach volumes to a VM only before the VM is booting or
             after the period of a few seconds has passed since the booting
@@ -393,6 +392,25 @@
           </listitem>
         </itemizedlist>
       </listitem>
+
+      <listitem>
+        <para>Fuel Healthcheck Stack creation with wait condition test,
+        fails</para>
+
+        <itemizedlist>
+          <listitem>
+            <para>Description and Impact:</para>
+
+            <para>The platform test case (create stack with wait condition)
+            from the Fuel Healthcheck, fails. This has no impact on overall
+            cluster functionality.</para>
+          </listitem>
+
+          <listitem>
+            <para>Workaround: N/A.</para>
+          </listitem>
+        </itemizedlist>
+      </listitem>
     </orderedlist>
   </section>