aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorCristina Pauna <cristina.pauna@enea.com>2017-12-14 17:54:01 +0200
committerAlexandru Avadanii <Alexandru.Avadanii@enea.com>2017-12-14 16:24:03 +0000
commit17c7c9bd078265f8cd02854a2014ccea4c2e41ba (patch)
tree379bd8297b87f8f2e37c8d9281e962659d8af7be
parent5f6e4fa1284c71d998d9435459cb97bd67b57f71 (diff)
Update documentation
This documentation is a copy of Fuel@OPNFV documentation Change-Id: I03b289043b3a48ef6d423f958846295e3d26121a Signed-off-by: Cristina Pauna <cristina.pauna@enea.com> (cherry picked from commit 394df04bdd747004416bd6fc8d48a73bb47813cd)
-rw-r--r--docs/release/release-notes/release-notes.rst29
-rw-r--r--docs/release/userguide/img/reclass_doc.pngbin0 -> 78645 bytes
-rw-r--r--docs/release/userguide/userguide.rst57
3 files changed, 74 insertions, 12 deletions
diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst
index 6e1b5342..0052ab63 100644
--- a/docs/release/release-notes/release-notes.rst
+++ b/docs/release/release-notes/release-notes.rst
@@ -61,13 +61,13 @@ Release Data
| **Project** | fuel/armband |
| | |
+--------------------------------------+--------------------------------------+
-| **Repo/tag** | opnfv-5.0.2 |
+| **Repo/tag** | opnfv-5.1.0 |
| | |
+--------------------------------------+--------------------------------------+
-| **Release designation** | Euphrates 5.0 |
+| **Release designation** | Euphrates 5.1 |
| | |
+--------------------------------------+--------------------------------------+
-| **Release date** | October 20 2017 |
+| **Release date** | December 15 2017 |
| | |
+--------------------------------------+--------------------------------------+
| **Purpose of the delivery** | Euphrates alignment to Released |
@@ -84,7 +84,7 @@ Version Change
Module Version Changes
----------------------
-This is the Euphrates 5.0 release.
+This is the Euphrates 5.1 release.
It is based on following upstream versions:
- MCP 1.0 Base Release
@@ -95,13 +95,15 @@ It is based on following upstream versions:
Document Changes
----------------
-This is the Euphrates 5.0 release.
+This is the Euphrates 5.1 release.
It comes with the following documentation:
-- Installation instructions
+- `Installation instructions <http://docs.opnfv.org/en/stable-euphrates/submodules/armband/docs/release/installation/installation.instruction.html>`_
- Release notes (This document)
+- `User guide <http://docs.opnfv.org/en/stable-euphrates/submodules/fuel/docs/release/userguide/userguide.html>`_
+
Reason for Version
==================
@@ -109,14 +111,14 @@ Feature Additions
-----------------
**JIRA TICKETS:**
-`Euphrates 5.0 new features <https://jira.opnfv.org/issues/?filter=12029>`_
+`Euphrates 5.1 new features <https://jira.opnfv.org/issues/?filter=12114>`_
Bug Corrections
---------------
**JIRA TICKETS:**
-`Euphrates 5.0 bug fixes <https://jira.opnfv.org/issues/?filter=12027>`_
+`Euphrates 5.1 bug fixes <https://jira.opnfv.org/issues/?filter=12115>`_
(Also See respective Integrated feature project's bug tracking)
@@ -133,10 +135,13 @@ Software Deliverables
Documentation Deliverables
--------------------------
-- Installation instructions
+- `Installation instructions <http://docs.opnfv.org/en/stable-euphrates/submodules/armband/docs/release/installation/installation.instruction.html>`_
- Release notes (This document)
+- `User guide <http://docs.opnfv.org/en/stable-euphrates/submodules/fuel/docs/release/userguide/userguide.html>`_
+
+
=========================================
Known Limitations, Issues and Workarounds
=========================================
@@ -158,7 +163,7 @@ Known Issues
**JIRA TICKETS:**
-`Known issues <https://jira.opnfv.org/issues/?filter=12028>`_
+`Known issues <https://jira.opnfv.org/issues/?filter=12116>`_
(Also See respective Integrated feature project's bug tracking)
@@ -174,13 +179,13 @@ Workarounds
============
Test Results
============
-The Euphrates 5.0 release with the Fuel deployment tool has undergone QA test
+The Euphrates 5.1 release with the Fuel deployment tool has undergone QA test
runs, see separate test results.
==========
References
==========
-For more information on the OPNFV Euphrates 5.0 release, please see:
+For more information on the OPNFV Euphrates 5.1 release, please see:
OPNFV
=====
diff --git a/docs/release/userguide/img/reclass_doc.png b/docs/release/userguide/img/reclass_doc.png
new file mode 100644
index 00000000..374f92a6
--- /dev/null
+++ b/docs/release/userguide/img/reclass_doc.png
Binary files differ
diff --git a/docs/release/userguide/userguide.rst b/docs/release/userguide/userguide.rst
index f00e6635..2b46a84a 100644
--- a/docs/release/userguide/userguide.rst
+++ b/docs/release/userguide/userguide.rst
@@ -254,6 +254,63 @@ For Virtual deploys, the most commonly used IPs are in the table below.
+-----------+--------------+---------------+
+=============================
+Reclass model viewer tutorial
+=============================
+
+
+In order to get a better understanding on the reclass model Fuel uses, the `reclass-doc
+<https://github.com/jirihybek/reclass-doc>`_ can be used to visualise the reclass model.
+A simplified installation can be done with the use of a docker ubuntu container. This
+approach will avoid installing packages on the host, which might collide with other packages.
+After the installation is done, a webbrowser on the host can be used to view the results.
+
+**NOTE**: The host can be any device with Docker package already installed.
+ The user which runs the docker needs to have root priviledges.
+
+
+**Instructions**
+
+
+#. Create a new directory at any location
+
+ .. code-block:: bash
+
+ $ mkdir -p modeler
+
+
+#. Place fuel repo in the above directory
+
+ .. code-block:: bash
+
+ $ cd modeler
+ $ git clone https://gerrit.opnfv.org/gerrit/fuel && cd fuel
+
+
+#. Create a container and mount the above host directory
+
+ .. code-block:: bash
+
+ $ docker run --privileged -it -v <absolute_path>/modeler:/host ubuntu bash
+
+
+#. Install all the required packages inside the container.
+
+ .. code-block:: bash
+
+ $ apt-get update
+ $ apt-get install -y npm nodejs
+ $ npm install -g reclass-doc
+ $ cd /host/fuel/mcp/reclass
+ $ ln -s /usr/bin/nodejs /usr/bin/node
+ $ reclass-doc --output /host /host/fuel/mcp/reclass
+
+
+#. View the results from the host by using a browser. The file to open should be now at modeler/index.html
+
+ .. figure:: img/reclass_doc.png
+
+
.. _references:
==========