summaryrefslogtreecommitdiffstats
path: root/docs/userguide/yang2tosca.rst
diff options
context:
space:
mode:
authorshiva-charan <shiva-charan.m-s@hpe.com>2016-09-16 21:28:44 -0500
committershiva-charan <shiva-charan.m-s@hpe.com>2016-09-16 21:29:40 -0500
commit86b894e80fcb29f0354109730ee37bff20b1a89b (patch)
treeff953d57269a7da8f6be0a56a2f8324dc73b2d37 /docs/userguide/yang2tosca.rst
parentae543033a8c4af9c291261fec55859c2f1191a1a (diff)
Installation doc and userguide for policy2tosca and yang2tosca
Change-Id: I10e5745b75e4cdeafae28767ad8233decabf3482 Signed-off-by: shiva-charan <shiva-charan.m-s@hpe.com>
Diffstat (limited to 'docs/userguide/yang2tosca.rst')
-rw-r--r--docs/userguide/yang2tosca.rst49
1 files changed, 49 insertions, 0 deletions
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