Renamed all relevant instances of the product

USERDOCAP-207 from ENFV to ENFV Core.

Signed-off-by: Miruna Paun <Miruna.Paun@enea.com>

7 files changed, 416 insertions, 0 deletions

diff --git a/book-enea-nfv-core-release-info/doc/about_release.xml b/book-enea-nfv-core-release-info/doc/about_release.xml
new file mode 100644
index 0000000..0acde2e
--- /dev/null
+++ b/book-enea-nfv-core-release-info/doc/about_release.xml
@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+<chapter id="relinfo-about-release">
+  <title>About This Release</title>
+
+  <section id="relinfo-abstract">
+    <title>Abstract</title>
+
+    <para>This document compiles the release notes for the 1.0 release of Enea
+    NFV Core when using Fuel as a deployment tool.</para>
+  </section>
+
+  <section id="relinfo-importantnotes">
+    <title>Important Notes</title>
+
+    <para>These notes provides release information for the use of Fuel as
+    deployment tool for the 1.0 release of ENFV Core. This Fuel-based
+    deployment process is to establish a lab ready platform accelerating
+    further development of the ENFV infrastructure. Carefully follow the
+    installation instructions detailed in Installation Guide provided with
+    this release.</para>
+  </section>
+</chapter>
\ No newline at end of file
diff --git a/book-enea-nfv-core-release-info/doc/book.xml b/book-enea-nfv-core-release-info/doc/book.xml
new file mode 100644
index 0000000..d8ad5de
--- /dev/null
+++ b/book-enea-nfv-core-release-info/doc/book.xml
@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+<book id="book_enea_nfv_core_release_info">
+  <title><trademark class="registered">Enea</trademark> NFV Core Release Information</title>
+
+  <subtitle>Release Version <xi:include href="../../s_docsrc_common/pardoc-distro.xml" xmlns:xi="http://www.w3.org/2001/XInclude" xpointer="element(EneaNFV_REL_VER/1)" /></subtitle>
+
+  <xi:include href="../../s_docbuild/template/docsrc_common/bookinfo_userdoc.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+  <xi:include href="about_release.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+  <xi:include href="summary.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+<!--  <xi:include href="prerequisites_and_included_packages.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+  <ns:include href="added_features.xml" xmlns:xi="http://www.w3.org/2001/XInclude "/>
+  <xi:include href="getting_enea_nfv.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+  <xi:include href="build_boot_generated.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+  <xi:include href="main_changes.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+  <xi:include href="known_bugs_and_limitations.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> -->
+  <xi:include href="../../s_docbuild/template/docsrc_common/contacting_enea_enea_linux.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+</book>
\ No newline at end of file
diff --git a/book-enea-nfv-core-release-info/doc/jiraissues_override.xml b/book-enea-nfv-core-release-info/doc/jiraissues_override.xml
new file mode 100644
index 0000000..ee3e55d
--- /dev/null
+++ b/book-enea-nfv-core-release-info/doc/jiraissues_override.xml
@@ -0,0 +1,72 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+<section id="relinfo-extracted-from-jira">
+  <title>Release-Specific Problems</title>
+
+  <informaltable>
+    <tgroup cols="2">
+      <colspec colwidth="6*" colname="c1"/>
+
+      <colspec align="center" colwidth="1*" colname="c2"/>
+
+      <thead>
+        <row>
+          <entry align="center">Summary</entry>
+
+          <entry>Enea Ref</entry>
+        </row>
+      </thead>
+
+      <tbody>
+        <row>
+          <entry>Eclipse Plug-Ins for Perf and Latencytop are not functioning properly on P2041RDB target.</entry>
+
+          <entry>LXCR-6936</entry>
+        </row>
+
+        <row>
+          <entry>QEMU cannot be launched from Eclipse environment.</entry>
+
+          <entry>LXCR-6997</entry>
+        </row>
+
+        <row>
+          <entry>Crosstap is not supported on LS1021a-IoT and QEMU targets.</entry>
+
+          <entry>LXCR-7110</entry>
+        </row>
+
+        <row>
+          <entry><para>LTTng kernel tracing from Eclipse does not work due to RSE connectivity problems.</para><para>As a workaround, traces can be collected on target and visualized on Eclipse, after copying the files on the host system.</para></entry>
+
+          <entry>LXCR-7166</entry>
+        </row>
+
+        <row>
+          <entry>Latencytop is not supported on LS1021a-IoT target.</entry>
+
+          <entry>LXCR-7168</entry>
+        </row>
+
+        <row>
+          <entry>A limitation currently makes Powertop calibration not function properly on LS1021a-IoT target.</entry>
+
+          <entry>LXCR-7170</entry>
+        </row>
+
+        <row>
+          <entry>Due to optimization done by GCC when compiling the LS1021a-IoT kernel, some context variables may not have accurate debugging data and may not be accessible to Systemtap probes.</entry>
+
+          <entry>LXCR-7184</entry>
+        </row>
+
+        <row>
+          <entry><para>KGDB is not functioning properly on LS1021a-IoT target.</para><para>The kernel sources are not present in the eSDK sysroot path and gdb will not be able to find the sources when debugging the kernel.</para></entry>
+
+          <entry>LXCR-7185</entry>
+        </row>
+      </tbody>
+    </tgroup>
+  </informaltable>
+</section>
diff --git a/book-enea-nfv-core-release-info/doc/known_bugs_and_limitations.xml-FIX b/book-enea-nfv-core-release-info/doc/known_bugs_and_limitations.xml-FIX
new file mode 100644
index 0000000..fad85a5
--- /dev/null
+++ b/book-enea-nfv-core-release-info/doc/known_bugs_and_limitations.xml-FIX
@@ -0,0 +1,59 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+<chapter id="bugs-limitations">
+  <title>Known Problems in This Release</title>
+
+  <para>Problems and limitations relevant to the current release are detailed
+  in this chapter. Corrections to bugs detected by Enea are submitted
+  upstream, and remaining issues are listed below.<remark>INFO: The <emphasis
+  role="bold">Release-Specific Problems</emphasis> section further down is
+  generated from JIRA with gen_known_issues.py, but that script is HARDCODED
+  with affectedversion "Enea NFV 1.0" and needs to be adapted when a release
+  info for another ENFV version changes.</remark></para>
+
+  <section condition="hidden" id="bugs-limitations-gen">
+    <title>Release Specific Issues</title>
+
+    <itemizedlist spacing="compact">
+      <listitem>
+        <para><emphasis role="bold">Issue</emphasis>: <remark>Insert all
+        issues specific to this release, along with their relevant
+        CRs</remark></para>
+      </listitem>
+    </itemizedlist>
+  </section>
+
+  <section condition="hidden" id="bugs-limitations-doc">
+    <title>Documentation</title>
+
+    <itemizedlist spacing="compact">
+      <listitem>
+        <para><emphasis role="bold">PDF navigation</emphasis>: When using
+        links to open other PDFs, or jump to another place in the same PDF,
+        jumping back sometimes fails. This has been observed when opening a
+        PDF in Adobe Reader, inside a browser with PDF add-on, as well as when
+        the browser is configured to open PDF files in an external PDF reader.
+        As a workaround, open the HTML version of the
+        document.<remark>LXCR-3283</remark></para>
+      </listitem>
+    </itemizedlist>
+  </section>
+
+  <section condition="hidden" id="bugs-limitations-other">
+    <title>Miscellaneous</title>
+
+    <itemizedlist spacing="compact">
+      <listitem>
+        <para />
+
+        <remark>list all misc problems here.</remark>
+      </listitem>
+    </itemizedlist>
+  </section>
+
+  <!-- The file with a section below is autocreated by make init  -->
+
+  <xi:include href="jiraissues_generated.xml"
+              xmlns:xi="http://www.w3.org/2001/XInclude" />
+</chapter>
\ No newline at end of file
diff --git a/book-enea-nfv-core-release-info/doc/reference_index.xml-NOTES b/book-enea-nfv-core-release-info/doc/reference_index.xml-NOTES
new file mode 100644
index 0000000..079a566
--- /dev/null
+++ b/book-enea-nfv-core-release-info/doc/reference_index.xml-NOTES
@@ -0,0 +1,120 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+<chapter id="ref-index">
+  <title>Reference Index</title>
+
+  <para>For more information on the ENFV 1.0 release, please see:</para>
+
+  <section id="opnfv">
+    <title>OPNFV</title>
+
+    <remark>Should these external remain as they are now, leading to opnfv, or
+    be changed to something referencing our own products if possible, or
+    omitted partially/entirely?</remark>
+
+    <orderedlist>
+      <listitem id="reference-one">
+        <para>OPNFV Home Page: <ulink
+        url="http://www.opnfv.org">http://www.opnfv.org</ulink></para>
+      </listitem>
+
+      <listitem id="reference-two">
+        <para>OPNFV documentation and software downloads: <ulink
+        url="https://www.opnfv.org/software/download">https://www.opnfv.org/software/download</ulink></para>
+      </listitem>
+    </orderedlist>
+  </section>
+
+  <section id="openstack">
+    <title>OpenStack</title>
+
+    <orderedlist>
+      <listitem id="reference-three">
+        <para>OpenStack Mitaka Release artifacts: <ulink
+        url="http://www.openstack.org/software/mitaka">http://www.openstack.org/software/mitaka</ulink></para>
+      </listitem>
+
+      <listitem id="reference-four">
+        <para>OpenStack documentation: <ulink
+        url="http://docs.openstack.org">http://docs.openstack.org</ulink></para>
+      </listitem>
+    </orderedlist>
+  </section>
+
+  <section id="opendaylight">
+    <title>OpenDaylight</title>
+
+    <orderedlist>
+      <listitem id="reference-five">
+        <para>OpenDaylight artifacts: <ulink
+        url="http://www.opendaylight.org/software/downloads">http://www.opendaylight.org/software/downloads</ulink></para>
+      </listitem>
+    </orderedlist>
+  </section>
+
+  <section id="fuel">
+    <title>Fuel</title>
+
+    <orderedlist>
+      <listitem id="reference-six">
+        <para>The Fuel OpenStack project: <ulink
+        url="https://wiki.openstack.org/wiki/Fuel">https://wiki.openstack.org/wiki/Fuel</ulink></para>
+      </listitem>
+
+      <listitem id="reference-seven">
+        <para>Fuel documentation overview: <ulink
+        url="http://docs.openstack.org/developer/fuel-docs">http://docs.openstack.org/developer/fuel-docs</ulink></para>
+      </listitem>
+
+      <listitem id="reference-eight">
+        <para>Fuel Installation Guide: <ulink
+        url="http://docs.openstack.org/developer/fueldocs/userdocs/fuel-install-guide.html">http://docs.openstack.org/developer/fueldocs/userdocs/fuel-install-guide.html</ulink></para>
+      </listitem>
+
+      <listitem id="reference-nine">
+        <para>Fuel User Guide: <ulink
+        url="http://docs.openstack.org/developer/fuel-docs/userdocs/fueluser-guide.html">http://docs.openstack.org/developer/fuel-docs/userdocs/fueluser-guide.html</ulink></para>
+      </listitem>
+
+      <listitem id="reference-ten">
+        <para>Fuel Developer Guide: <ulink
+        url="http://docs.openstack.org/developer/fueldocs/devdocs/develop.html">http://docs.openstack.org/developer/fueldocs/devdocs/develop.html</ulink></para>
+      </listitem>
+
+      <listitem id="reference-eleven">
+        <para>Fuel Plugin Developers Guide: <ulink
+        url="http://docs.openstack.org/developer/fueldocs/plugindocs/fuel-plugin-sdk-guide.html">http://docs.openstack.org/developer/fueldocs/plugindocs/fuel-plugin-sdk-guide.html</ulink></para>
+      </listitem>
+
+      <listitem id="reference-twelve">
+        <para>Fuel OpenStack Hardware Compatibility List: <ulink
+        url="https://www.mirantis.com/products/openstack-drivers-and-plugins/hardwarecompatibility-list">https://www.mirantis.com/products/openstack-drivers-and-plugins/hardwarecompatibility-list</ulink></para>
+      </listitem>
+    </orderedlist>
+  </section>
+
+  <section id="fuel-enfv">
+    <title>Fuel in ENFV</title>
+
+    <orderedlist>
+      <listitem id="reference-thirteen">
+        <para>ENFV Installation instruction for the 1.0 release of ENFV when
+        using Fuel as a deployment tool: <ulink
+        url="http://artifacts.opnfv.org/fuel/colorado/3.0/docs/installationprocedure/index.html {change}">http://artifacts.opnfv.org/fuel/colorado/3.0/docs/installationprocedure/index.html</ulink></para>
+      </listitem>
+
+      <listitem id="reference-fourteen">
+        <para>ENFV Build instruction for the 1.0 release of ENFV when using
+        Fuel as a deployment tool: <ulink
+        url="http://artifacts.opnfv.org/fuel/colorado/3.0/docs/buildprocedure/index.html {change}">http://artifacts.opnfv.org/fuel/colorado/3.0/docs/buildprocedure/index.html</ulink></para>
+      </listitem>
+
+      <listitem id="reference-fifteen">
+        <para>ENFV Release Notes for the 1.0 release of ENFV when using Fuel
+        as a deployment tool: <ulink
+        url="http://artifacts.opnfv.org/fuel/colorado/3.0/docs/releasenotes/index.html {change}">http://artifacts.opnfv.org/fuel/colorado/3.0/docs/releasenotes/index.html</ulink></para>
+      </listitem>
+    </orderedlist>
+  </section>
+</chapter>
\ No newline at end of file
diff --git a/book-enea-nfv-core-release-info/doc/summary.xml b/book-enea-nfv-core-release-info/doc/summary.xml
new file mode 100644
index 0000000..3059386
--- /dev/null
+++ b/book-enea-nfv-core-release-info/doc/summary.xml
@@ -0,0 +1,112 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+<chapter id="relinfo-summary">
+  <title>Summary</title>
+
+  <section id="relinfo-overview">
+    <title>Brief Overview</title>
+
+    <para>For the 1.0 release, the typical use of Fuel as an OpenStack
+    installer is supplemented with ENFV Core unique components, such
+    as:</para>
+
+    <para><itemizedlist>
+        <listitem>
+          <para><ulink url="http://www.opendaylight.org/software">OpenDaylight
+          version: Boron</ulink></para>
+        </listitem>
+
+        <listitem>
+          <para><ulink url="http://onosproject.org/">ONOS version:
+          Drake</ulink></para>
+        </listitem>
+
+        <listitem>
+          <para><ulink
+          url="https://wiki.opnfv.org/service_function_chaining">Service
+          function chaining</ulink></para>
+        </listitem>
+
+        <listitem>
+          <para><ulink url="https://wiki.opnfv.org/sdnvpn">SDN distributed
+          routing and VPN</ulink></para>
+        </listitem>
+
+        <listitem>
+          <para><ulink url="https://wiki.opnfv.org/nfv-kvm">NFV
+          Hypervisors-KVM</ulink></para>
+        </listitem>
+
+        <listitem>
+          <para><ulink url="https://wiki.opnfv.org/ovsnfv">Open vSwitch for
+          NFV</ulink></para>
+        </listitem>
+
+        <listitem>
+          <para><ulink
+          url="https://wiki.opnfv.org/characterize_vswitch_performance_for_telco_nfv_use_cases">VSPERF</ulink></para>
+        </listitem>
+
+        <listitem>
+          <para><ulink
+          url="https://wiki.opnfv.org/display/promise">Promise</ulink></para>
+        </listitem>
+
+        <listitem>
+          <para><ulink
+          url="https://wiki.opnfv.org/display/parser">Parser</ulink></para>
+        </listitem>
+
+        <listitem>
+          <para><ulink
+          url="https://wiki.opnfv.org/display/doctor">Doctor</ulink></para>
+
+          <remark>Change these links and titles accordingly to the appropriate
+          ones for our product.</remark>
+        </listitem>
+      </itemizedlist>This release also includes ENFV-unique configurations of
+    the Hardware and Software stack, provides Fuel as the deployment stage
+    tool in the ENFV CI pipeline, and includes the following:</para>
+
+    <itemizedlist>
+      <listitem>
+        <para>Documentation built by Jenkins</para>
+
+        <itemizedlist>
+          <listitem>
+            <para>Overall ENFV Core documentation</para>
+          </listitem>
+
+          <listitem>
+            <para>This document (release notes)</para>
+          </listitem>
+
+          <listitem>
+            <para>Installation instructions</para>
+          </listitem>
+
+          <listitem>
+            <para>Build-instructions</para>
+          </listitem>
+        </itemizedlist>
+      </listitem>
+
+      <listitem>
+        <para>The Fuel installer image (.iso) built by Jenkins</para>
+      </listitem>
+
+      <listitem>
+        <para>Automated deployment of Fuel with running on bare metal or a
+        nested hypervisor environment (KVM)</para>
+
+        <remark>Is this applicable to us? If not remove this bullet point or
+        change the text to a relevant option</remark>
+      </listitem>
+
+      <listitem>
+        <para>Automated validation of current release deployment</para>
+      </listitem>
+    </itemizedlist>
+  </section>
+</chapter>
\ No newline at end of file
diff --git a/book-enea-nfv-core-release-info/swcomp.mk b/book-enea-nfv-core-release-info/swcomp.mk
new file mode 100644
index 0000000..8a5adb4
--- /dev/null
+++ b/book-enea-nfv-core-release-info/swcomp.mk
@@ -0,0 +1,10 @@
+# Component build specification
+
+# Version of THIS book
+BOOK_VER ?= $(REL_VER)-dev
+
+DOCBOOK_SRC := $(COMP)/swcomp.mk $(COMP)/doc/book.xml $(shell find $(COMP)/doc -type f \( -name "*.xml" -o -name "*.svg" -o -name "*.png" \) ! -name "book.xml" -print)
+
+BOOKPACKAGES := book-enea-nfv-core-release-info
+BOOKDESC_$(BOOKPACKAGES) := "Enea NFV Core $(PROD_VER) Release Information"
+BOOKDEFAULTCONDITION := $(DEFAULTCONDITIONS)