openstack/heat-translator
Code Issues Proposed changes

The —template-type is no longer required arg

Browse Source 
The translator by default uses tosca as a value to the --template-type arg.
The --template-type arg which used to be a required arg is an optional arg and
needs to be reflected in the doc.

Change-Id: Idb9da528ea9e08c331e554c0167ac449f9f9a6e3
Closes-Bug: #1610581
This commit is contained in:
Sahdev Zala 2016-08-06 12:06:20 -07:00
parent 7a2fa32b83
commit a331dfadfe
2 changed files with 7 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/source/usage.rst
View File

@ -12,7 +12,8 @@ Assuming that OpenStackClient (OSC) is available in your environment, you can ea
Alternatively, you can install a particular release of Heat-Translator as available at https://pypi.python.org/pypi/heat-translator.
Once installation is complete, Heat-Translator is ready to use. Currently you can use it in following three ways.
Once installation is complete, Heat-Translator is ready to use. The only required argument is ``--template-file``. By default, the ``--template-type`` is set to ``tosca`` which is the
only supported template type at present. Currently you can use Heat-Translator in following three ways.
Translate and get output on command line. For example: ::
@ -39,15 +40,13 @@ Heat-Translator can be used without any specific OpenStack environment set up as
python heat_translator.py --template-file==<path to the YAML template> --template-type=<type of template e.g. tosca> --parameters="purpose=test"
The heat_translator.py test program is at the root level of the project. The program has currently tested with TOSCA templates.
It requires two arguments::
1. Path to the file that needs to be translated. The file, flat yaml template or CSAR, can be specified as a local file in your
The only required argument is ``--template-file``. By default, the ``--template-type`` is set to ``tosca`` which is the only supported template type at present.
The value to the ``--template-file`` is a path to the file that needs to be translated. The file, flat yaml template or CSAR, can be specified as a local file in your
system or via URL.
2. Type of translation (e.g. tosca)
For example, a TOSCA hello world template can be translated by running the following command from the project location::
python heat_translator.py --template-file=translator/tests/data/tosca_helloworld.yaml --template-type=tosca
python heat_translator.py --template-file=translator/tests/data/tosca_helloworld.yaml
This should produce a translated Heat Orchestration Template on the command line. The translated content can be saved to a desired file by setting --output-file=<path>.
For example: ::

4
translator/shell.py
View File

@ -44,8 +44,8 @@ Test the heat-translator translation from command line as:
--template-type=<type of template e.g. tosca>
--parameters="purpose=test"
Takes three user arguments,
1. type of translation (e.g. tosca) (required)
2. Path to the file that needs to be translated (required)
1. Path to the file that needs to be translated (required)
2. type of translation (e.g. tosca) (optional)
3. Input parameters (optional)
In order to use heat-translator to only validate template,