diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/installationprocedure/feature.configuration.rst | 9 | ||||
| -rw-r--r-- | docs/installationprocedure/featureconfig.rst (renamed from docs/configguide/featureconfig.rst) | 0 | ||||
| -rw-r--r-- | docs/installationprocedure/index.rst (renamed from docs/configguide/index.rst) | 9 | ||||
| -rw-r--r-- | docs/installationprocedure/installerconfig.rst (renamed from docs/configguide/installerconfig.rst) | 0 | ||||
| -rw-r--r-- | docs/parser_docs/policy2tosca/policy2tosca.rst | 87 |
5 files changed, 100 insertions, 5 deletions
diff --git a/docs/installationprocedure/feature.configuration.rst b/docs/installationprocedure/feature.configuration.rst new file mode 100644 index 0000000..86d7dfa --- /dev/null +++ b/docs/installationprocedure/feature.configuration.rst @@ -0,0 +1,9 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + .. (c) <optionally add copywriters name> + + +Abstract +======== +This document provides information on how to configure required +components during the installation of the platform. diff --git a/docs/configguide/featureconfig.rst b/docs/installationprocedure/featureconfig.rst index dc4fc50..dc4fc50 100644 --- a/docs/configguide/featureconfig.rst +++ b/docs/installationprocedure/featureconfig.rst diff --git a/docs/configguide/index.rst b/docs/installationprocedure/index.rst index 03ba4b0..13def7e 100644 --- a/docs/configguide/index.rst +++ b/docs/installationprocedure/index.rst @@ -3,13 +3,12 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) OPNFV, Ericsson AB and others. -========================== -Parser Configuration Guide -========================== +******************************************** +Parser Configuration and Configuration Guide +******************************************** .. toctree:: :numbered: :maxdepth: 2 -.. include:: featureconfig.rst -.. include:: installerconfig.rst + feature.configuration.rst diff --git a/docs/configguide/installerconfig.rst b/docs/installationprocedure/installerconfig.rst index efe6265..efe6265 100644 --- a/docs/configguide/installerconfig.rst +++ b/docs/installationprocedure/installerconfig.rst diff --git a/docs/parser_docs/policy2tosca/policy2tosca.rst b/docs/parser_docs/policy2tosca/policy2tosca.rst new file mode 100644 index 0000000..fa238b2 --- /dev/null +++ b/docs/parser_docs/policy2tosca/policy2tosca.rst @@ -0,0 +1,87 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +=================== +Parser POLICY2TOSCA +=================== + +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 |