From b4824100a54eb33bd27d0aaf083cbd512b3a6479 Mon Sep 17 00:00:00 2001 From: spzala Date: Fri, 11 Sep 2015 06:27:54 -0700 Subject: [PATCH] Update doc references Update doc to remove toscalib references. Completing the work to remoev TOSCA code from heat-translator herewith. Change-Id: I6a36b443ea60ed9944caa05f0368623923715425 Implements: blueprint use-tosca-parser-library --- README.rst | 6 +++--- doc/source/usage.rst | 6 +++--- heat_translator.py | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index 23e58c32..92665da8 100644 --- a/README.rst +++ b/README.rst @@ -33,9 +33,9 @@ Directory Structure Three main directories related to the heat-translator are: -1. toscalib: It is TOSCA parser for TOSCA Simple Profile YAML. It validates tosca input file and creates an in memory graphs. -2. hot: It is the generator, that has logic of converting TOSCA in memory graph to HOT yaml files. -3. common: It has all the file that can support the execution of parser and generator. +1. hot: It is the generator, that has logic of converting TOSCA in memory graph to HOT yaml files. +2. common: It has all the file that can support the execution of parser and generator. +3. tests: It contains test programs and more importantly several templates which are used for testing. Project Info ------------ diff --git a/doc/source/usage.rst b/doc/source/usage.rst index cb4e99ee..8a2024b0 100644 --- a/doc/source/usage.rst +++ b/doc/source/usage.rst @@ -14,11 +14,11 @@ Once installation is complete, Heat-Translator is ready to use. Currently you ca Translate and get output on command line. For example: :: - openstack translate template --template-file /home/openstack/heat-translator/translator/toscalib/tests/data/tosca_helloworld.yaml --template-type tosca + openstack translate template --template-file /home/openstack/heat-translator/translator/tests/data/tosca_helloworld.yaml --template-type tosca Translate and save output of translated file to a desired destination. For example: :: - openstack translate template --template-file /home/openstack/heat-translator/translator/toscalib/tests/data/tosca_helloworld.yaml --template-type tosca --output-file /tmp/hot_hello_world.yaml + openstack translate template --template-file /home/openstack/heat-translator/translator/tests/data/tosca_helloworld.yaml --template-type tosca --output-file /tmp/hot_hello_world.yaml You can learn more about available options by running following help command:: @@ -42,7 +42,7 @@ An optional argument can be provided to handle user inputs parameters. For example, a TOSCA hello world template can be translated by running the following command from the directory where you have cloned the project:: - python heat_translator.py --template-file=translator/toscalib/tests/data/tosca_helloworld.yaml --template-type=tosca + python heat_translator.py --template-file=translator/tests/data/tosca_helloworld.yaml --template-type=tosca This should produce a translated Heat Orchestration Template on the command line. In the near future, new options will be added to save the output to destination file. diff --git a/heat_translator.py b/heat_translator.py index a6cde61a..07890260 100644 --- a/heat_translator.py +++ b/heat_translator.py @@ -53,7 +53,7 @@ def main(): "Please refer to the usage documentation.") raise ValueError(msg) path = sys.argv[1].split('--template-file=')[1] - # e.g. --template_file=translator/toscalib/tests/data/tosca_helloworld.yaml + # e.g. --template_file=translator/tests/data/tosca_helloworld.yaml template_type = sys.argv[2].split('--template-type=')[1] # e.g. --template_type=tosca supported_types = ['tosca']