Installation doc and userguide for policy2tosca and yang2tosca

Change-Id: I10e5745b75e4cdeafae28767ad8233decabf3482
Signed-off-by: shiva-charan <shiva-charan.m-s@hpe.com>

4 files changed, 203 insertions, 0 deletions

diff --git a/docs/installationprocedure/policy2tosca.rst b/docs/installationprocedure/policy2tosca.rst
new file mode 100644
index 0000000..d6e2348
--- /dev/null
+++ b/docs/installationprocedure/policy2tosca.rst
@@ -0,0 +1,44 @@
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+Prerequisites
+=============
+
+Parser - POLICY2TOSCA requires the following to be installed.
+
+1. cliff
+--------
+
+Install cliff with the following links.
+::
+- `install <http://docs.openstack.org/developer/cliff/install.html>`
+or
+- `demoapp <http://docs.openstack.org/developer/cliff/demoapp.html>`
+
+Installation
+============================
+
+Please follow the below installation steps to install parser - POLICY2TOSCA.
+
+Step 1: Clone the parser project.
+
+.. code-block:: bash
+
+    git clone https://gerrit.opnfv.org/gerrit/parser
+
+Step 2: Install the policy2tosca module.
+
+.. code-block:: bash
+
+    cd parser/policy2tosca
+    python setup.py install
diff --git a/docs/installationprocedure/yang2tosca.rst b/docs/installationprocedure/yang2tosca.rst
new file mode 100644
index 0000000..8f4ef91
--- /dev/null
+++ b/docs/installationprocedure/yang2tosca.rst
@@ -0,0 +1,58 @@
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+Prerequisites
+=============
+
+Parser requires the following to be installed.
+
+1. PYANG
+--------
+
+Please follow the below installation steps.
+
+Step 1: Clone pyang tool or download the zip file from the following link.
+
+.. code-block:: bash
+
+    git clone https://github.com/mbj4668/pyang.git
+
+OR
+
+.. code-block:: bash
+
+    wget https://github.com/mbj4668/pyang/archive/master.zip
+
+Step 2: Change directory to the downloaded directory and run the setup file.
+
+.. code-block:: bash
+
+    cd pyang
+    python setup.py
+
+2. python-lxml
+--------------
+
+Please follow the below installation link. http://lxml.de/installation.html
+
+
+Installation
+============================
+
+Please follow the below installation steps to install parser.
+
+Step 1: Clone the parser project.
+
+.. code-block:: bash
+
+    git clone https://gerrit.opnfv.org/gerrit/parser
diff --git a/docs/userguide/policy2tosca.rst b/docs/userguide/policy2tosca.rst
new file mode 100644
index 0000000..3f4f2e7
--- /dev/null
+++ b/docs/userguide/policy2tosca.rst
@@ -0,0 +1,52 @@
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+Execution
+===========================
+
+Step 1: To see a list of commands available.
+
+.. code-block:: bash
+
+    policy2tosca --help
+
+Step 2: To see help for an individual command, include the command name on the command line
+
+.. code-block:: bash
+
+    policy2tosca help <service>
+
+Step 3: To inject/remove policy types/policy definitions provide the TOSCA file as input to policy2tosca command line.
+
+.. code-block:: bash
+
+    policy2tosca <service> [arguments]
+
+Example:
+
+.. code-block:: bash
+
+    policy2tosca add-definition --policy_name rule2 --policy_type  tosca.policies.Placement.Geolocation --description "test description" --properties region:us-north-1,region:us-north-2,min_inst:2 --targets VNF2,VNF4 --metadata "map of strings" --triggers "1,2,3,4" --source example.yaml
+
+
+Step 4: Verify the TOSCA YAMl updated with the injection/removal executed.
+
+.. code-block:: bash
+
+    cat "<source tosca file>"
+
+Example:
+
+.. code-block:: bash
+
+    cat example_tosca.yaml
diff --git a/docs/userguide/yang2tosca.rst b/docs/userguide/yang2tosca.rst
new file mode 100644
index 0000000..4708c9a
--- /dev/null
+++ b/docs/userguide/yang2tosca.rst
@@ -0,0 +1,49 @@
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+Execution
+===========================
+
+Step 1: Change directory to where the scripts are present.
+
+.. code-block:: bash
+
+    cd parser/yang2tosca
+
+Step 2: Copy the YANG file which needs to be converted into TOSCA to
+        current (parser/yang2tosca) folder.
+
+Step 3: Run the python script "parser.py" with the YANG file as an input option.
+
+.. code-block:: bash
+
+    python parser.py -n "YANG filename"
+
+Example:
+
+.. code-block:: bash
+
+    python parser.py -n example.yaml
+
+Step 4: Verify the TOSCA YAMl which file has been created with the same name
+        as the YANG file with a “_tosca” suffix.
+
+.. code-block:: bash
+
+    cat "YANG filename_tosca.yaml"
+
+Example:
+
+.. code-block:: bash
+
+    cat example_tosca.yaml