diff options
| author |   zhipengh <huangzhipeng@huawei.com> | 2017-03-06 16:16:45 +0800 |
|---|---|---|
| committer | zhipengh <huangzhipeng@huawei.com> | 2017-03-07 19:42:30 +0800 |
| commit | c09ba66cc51c4db17503f79c05ea0b0cd0626596 (patch) | |
| tree | d8bcb874d6c3c6b5f3962f24e775061134415486 /tosca2heat/tosca-parser/README.rst | |
| parent | 119d491d35d02195cd0f77ba63f9dc133c15666f (diff) | |
Danube Release Docs Fixup patch 2
This patch provide an initial content for the docs/
release/release-notes.rst file. Further work needed.
Remove policy2tosca and yang2tosca doc files in the
code folder, move tosca2heat diff files to release
folder.
Remove all the tosca2heat original upstream rst docs
due to CI failures
Change-Id: I789102a7974b5ac79445f90e08e3f8252e0f4169
Signed-off-by: zhipengh <huangzhipeng@huawei.com>
Diffstat (limited to 'tosca2heat/tosca-parser/README.rst')
| -rw-r--r-- | tosca2heat/tosca-parser/README.rst | 54 |
1 files changed, 0 insertions, 54 deletions
diff --git a/tosca2heat/tosca-parser/README.rst b/tosca2heat/tosca-parser/README.rst deleted file mode 100644 index 0f94072..0000000 --- a/tosca2heat/tosca-parser/README.rst +++ /dev/null @@ -1,54 +0,0 @@ -======================== -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/ - |