aboutsummaryrefslogtreecommitdiffstats
path: root/docs/release/userguide/userguide.rst
diff options
context:
space:
mode:
authorAlexandru Avadanii <Alexandru.Avadanii@enea.com>2017-12-14 16:51:48 +0000
committerGerrit Code Review <gerrit@opnfv.org>2017-12-14 16:51:48 +0000
commitd994440a4299e338f4651030f2d41d7e86f9c06b (patch)
treefd936c1425b1f765e38840f1a3e5e8d3549df8d9 /docs/release/userguide/userguide.rst
parentef1c1131020e45bd280f2ef158f5416552f190e0 (diff)
parent94954c13104b7f7e3bd04a7b5fdbae84a93457ac (diff)
Merge "Add tutorial for reclass-doc tool in documentation"
Diffstat (limited to 'docs/release/userguide/userguide.rst')
-rw-r--r--docs/release/userguide/userguide.rst57
1 files changed, 57 insertions, 0 deletions
diff --git a/docs/release/userguide/userguide.rst b/docs/release/userguide/userguide.rst
index f00e66357..2b46a84ac 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:
==========