openstack/tosca-parser
Code Issues Proposed changes

Merge "Fix CSAR usage in README"

Browse Source
This commit is contained in:
Jenkins 2016-02-03 22:15:12 +00:00 committed by Gerrit Code Review
commit 0a0abe5b42
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.rst
View File

@ -12,16 +12,18 @@ and creates an in-memory graph of TOSCA nodes and their relationship.
Architecture
------------
The TOSCA Parser takes TOSCA YAML template as an input, with optional input of
dictionary of needed parameters with their values, and produces in-memory
objects of different TOSCA elements with their relationship to each other. It
also creates a graph of TOSCA node templates and their relationship. The support
for parsing template within TOSCA CSAR is under development.
The TOSCA Parser takes TOSCA YAML template or TOSCA Cloud Service Archive (CSAR)
file as an input, with optional input of dictionary of needed parameters with their
values, and produces in-memory objects of different TOSCA elements with their
relationship to each other. It also creates a graph of TOSCA node templates and their
relationship.
The ToscaTemplate class located in the toscaparser/tosca_template.py is an entry
class of the parser and various functionality of parser can be used by initiating
this class. In order to see an example usage, refer to the heat-translator
class TranslateTemplate located in the translator/osc/v1/translate.py module.
this class. In order to see an example usage of TOSCA Parser from a separate tool,
refer to the OpenStack heat-translator class TranslateTemplate located in the
translator/osc/v1/translate.py module. The toscaparser/shell.py module of tosca-parser
also provides a good reference on how to invoke TOSCA Parser from Command Line Interface.
The toscaparser/elements sub-directory contains various modules to handle
various TOSCA type elements like node type, relationship type etc. The