summaryrefslogtreecommitdiffstats
path: root/tosca2heat/tosca-parser/README.md
diff options
context:
space:
mode:
authorJulien <zhang.jun3g@zte.com.cn>2017-07-19 21:40:40 +0800
committerJulien <zhang.jun3g@zte.com.cn>2017-07-19 21:40:40 +0800
commit00219e7e9b24ee2298a7d0d977afdf123a6de88b (patch)
tree26adc25806b642937b804bb5caa26332a1998f69 /tosca2heat/tosca-parser/README.md
parent6a24bbe353242f78c2a2eb08f522cccea60befc4 (diff)
rename all READM.rst to README.md
Change-Id: I95930de9fefd0897bd0b75d2aeb5a1d731332dad Signed-off-by: Julien <zhang.jun3g@zte.com.cn>
Diffstat (limited to 'tosca2heat/tosca-parser/README.md')
-rw-r--r--tosca2heat/tosca-parser/README.md54
1 files changed, 54 insertions, 0 deletions
diff --git a/tosca2heat/tosca-parser/README.md b/tosca2heat/tosca-parser/README.md
new file mode 100644
index 0000000..0f94072
--- /dev/null
+++ b/tosca2heat/tosca-parser/README.md
@@ -0,0 +1,54 @@
+========================
+Team and repository tags
+========================
+
+.. image:: http://governance.openstack.org/badges/tosca-parser.svg
+ :target: http://governance.openstack.org/reference/tags/index.html
+
+.. Change things from this point on
+
+===============
+TOSCA Parser
+===============
+
+Overview
+--------
+
+The TOSCA Parser is an OpenStack project and licensed under Apache 2. It is
+developed to parse TOSCA Simple Profile in YAML. It reads the TOSCA templates
+and creates an in-memory graph of TOSCA nodes and their relationship.
+
+Architecture
+------------
+
+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 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
+entity_type.py module is a parent of all type elements. The toscaparser
+directory contains various python module to handle service template including
+topology template, node templates, relationship templates etc. The
+entity_template.py is a parent of all template elements.
+
+
+How To Use
+----------
+Please refer to `doc/source/usage.rst <https://github.com/openstack/tosca-parser/blob/master/doc/source/usage.rst>`_
+
+Project Info
+------------
+
+* License: Apache License, Version 2.0
+* Source: http://git.openstack.org/cgit/openstack/tosca-parser/
+