diff options
Diffstat (limited to 'docs/developer/design')
| -rw-r--r-- | docs/developer/design/examples/parser_new_keywords.rst (renamed from docs/developer/design/parser_new_keywords.rst) | 0 | ||||
| -rw-r--r-- | docs/developer/design/examples/vRNC_tosca_intro.rst (renamed from docs/developer/design/vRNC_tosca_intro.rst) | 0 | ||||
| -rw-r--r-- | docs/developer/design/index.rst | 4 | ||||
| -rw-r--r-- | docs/developer/design/policy2tosca.rst | 81 | ||||
| -rw-r--r-- | docs/developer/design/tosca2heat.rst | 7 | ||||
| -rw-r--r-- | docs/developer/design/verigraph.rst | 7 | ||||
| -rw-r--r-- | docs/developer/design/yang2tosca.rst | 93 |
7 files changed, 18 insertions, 174 deletions
diff --git a/docs/developer/design/parser_new_keywords.rst b/docs/developer/design/examples/parser_new_keywords.rst index f430b1d..f430b1d 100644 --- a/docs/developer/design/parser_new_keywords.rst +++ b/docs/developer/design/examples/parser_new_keywords.rst diff --git a/docs/developer/design/vRNC_tosca_intro.rst b/docs/developer/design/examples/vRNC_tosca_intro.rst index 11e1bdb..11e1bdb 100644 --- a/docs/developer/design/vRNC_tosca_intro.rst +++ b/docs/developer/design/examples/vRNC_tosca_intro.rst diff --git a/docs/developer/design/index.rst b/docs/developer/design/index.rst index ab83cec..55be2b5 100644 --- a/docs/developer/design/index.rst +++ b/docs/developer/design/index.rst @@ -9,7 +9,7 @@ OPNFV Parser Design Documentation :numbered: :maxdepth: 6 + tosca2heat.rst yang2tosca.rst policy2tosca.rst - parser_new_keywords.rst - vRNC_tosca_intro.rst + verigraph.rst diff --git a/docs/developer/design/policy2tosca.rst b/docs/developer/design/policy2tosca.rst index fa238b2..3753d6c 100644 --- a/docs/developer/design/policy2tosca.rst +++ b/docs/developer/design/policy2tosca.rst @@ -2,86 +2,7 @@ .. http://creativecommons.org/licenses/by/4.0 =================== -Parser POLICY2TOSCA +Parser polic2tosca =================== -Overview -======== -Parser is an open source project and licensed under Apache 2. Parser will help -to provide a tooling mechanism, by parsing Telecom operators’ VNF descriptors -(YANG templates) into TOSCA templates and then further translate TOSCA -templates into certain common templates, which could be used in IaaS orchestration -projects like OpenStack Heat. - -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 - -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/developer/design/tosca2heat.rst b/docs/developer/design/tosca2heat.rst new file mode 100644 index 0000000..d4ead14 --- /dev/null +++ b/docs/developer/design/tosca2heat.rst @@ -0,0 +1,7 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +=================== +Parser tosca2heat +=================== + diff --git a/docs/developer/design/verigraph.rst b/docs/developer/design/verigraph.rst new file mode 100644 index 0000000..91d5a36 --- /dev/null +++ b/docs/developer/design/verigraph.rst @@ -0,0 +1,7 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +================= +Parser verigraph +================= + diff --git a/docs/developer/design/yang2tosca.rst b/docs/developer/design/yang2tosca.rst index 5aaf463..61d31b2 100644 --- a/docs/developer/design/yang2tosca.rst +++ b/docs/developer/design/yang2tosca.rst @@ -2,97 +2,6 @@ .. http://creativecommons.org/licenses/by/4.0 ================= -Parser YANG2TOSCA +Parser yang2tosca ================= -Overview -======== - -Parser is an open source project and licensed under Apache 2. Parser will help -to provide a tooling mechanism, by parsing Telecom operators’ VNF descriptors -(YANG templates) into TOSCA templates and then further translate TOSCA -templates into certain common templates, which could be used in IaaS orchestration -projects like OpenStack Heat. - -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 - -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 |