From fa44d0821c35d401be256ced90eda934b20bf8d6 Mon Sep 17 00:00:00 2001 From: shiva-charan Date: Fri, 16 Sep 2016 21:28:44 -0500 Subject: Installation doc and userguide for policy2tosca and yang2tosca Change-Id: I10e5745b75e4cdeafae28767ad8233decabf3482 Signed-off-by: shiva-charan (cherry picked from commit 86b894e80fcb29f0354109730ee37bff20b1a89b) --- docs/userguide/policy2tosca.rst | 52 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100644 docs/userguide/policy2tosca.rst (limited to 'docs/userguide/policy2tosca.rst') 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 + +Step 3: To inject/remove policy types/policy definitions provide the TOSCA file as input to policy2tosca command line. + +.. code-block:: bash + + policy2tosca [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 "" + +Example: + +.. code-block:: bash + + cat example_tosca.yaml -- cgit 1.2.3-korg