From 94954c13104b7f7e3bd04a7b5fdbae84a93457ac Mon Sep 17 00:00:00 2001 From: Charalampos Kominos Date: Thu, 7 Dec 2017 11:19:04 +0100 Subject: Add tutorial for reclass-doc tool in documentation JIRA: FUEL-293 Change-Id: I2612e8d63875dca4d05f8c30db24a5ae84cc8dea Signed-off-by: Charalampos Kominos Signed-off-by: Cristina Pauna --- docs/release/userguide/img/reclass_doc.png | Bin 0 -> 78645 bytes docs/release/userguide/userguide.rst | 57 +++++++++++++++++++++++++++++ 2 files changed, 57 insertions(+) create mode 100644 docs/release/userguide/img/reclass_doc.png (limited to 'docs') diff --git a/docs/release/userguide/img/reclass_doc.png b/docs/release/userguide/img/reclass_doc.png new file mode 100644 index 000000000..374f92a6a Binary files /dev/null and b/docs/release/userguide/img/reclass_doc.png differ 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 +`_ 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 /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: ========== -- cgit 1.2.3-korg