From a8e355c582114fc4ba17d61dc7c365f990b46d2d Mon Sep 17 00:00:00 2001 From: Sahdev Zala Date: Wed, 3 Feb 2016 09:29:55 -0800 Subject: [PATCH] Fix CSAR usage in README The CSAR support is provided now and needs to be corrected in README. Change-Id: I40601bf58274a89c7d50eab2e20aeee3acea1018 Closes-Bug: 1541518 --- README.rst | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index 51161eca..d80d75b7 100644 --- a/README.rst +++ b/README.rst @@ -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