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/heat-translator/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/heat-translator/README.rst')
-rw-r--r-- | tosca2heat/heat-translator/README.rst | 56 |
1 files changed, 0 insertions, 56 deletions
diff --git a/tosca2heat/heat-translator/README.rst b/tosca2heat/heat-translator/README.rst deleted file mode 100644 index c8af42a..0000000 --- a/tosca2heat/heat-translator/README.rst +++ /dev/null @@ -1,56 +0,0 @@ -======================== -Team and repository tags -======================== - -.. image:: http://governance.openstack.org/badges/heat-translator.svg - :target: http://governance.openstack.org/reference/tags/index.html - -.. Change things from this point on - -=============== -Heat-Translator -=============== - -Overview --------- - -Heat-Translator is an Openstack project and licensed under Apache 2. It is a -command line tool which takes non-Heat templates as an input and produces a -Heat Orchestration Template (HOT) which can be deployed by Heat. Currently the -development and testing is done with an aim to translate OASIS Topology and -Orchestration Specification for Cloud Applications (TOSCA) templates to -HOT. However, the tool is designed to be easily extended to use with any -format other than TOSCA. - -Architecture ------------- - -Heat-Translator project takes a non-Heat template (e.g. TOSCA flat YAML -template or template embedded in TOSCA Cloud Service Archive (CSAR) format) as -an input, calls an appropriate Parser (e.g. TOSCA Parser) per the type of input -template to parse it and create an in-memory graph, maps it to Heat resources -and then produces a Heat Orchestration Template (HOT) as an output. - -How To Use ----------- -Please refer to `doc/source/usage.rst <https://github.com/openstack/heat-translator/blob/master/doc/source/usage.rst>`_ - -Directory Structure -------------------- - -Three main directories related to the heat-translator are: - -1. hot: It is the generator, that has logic of converting TOSCA in memory graph to HOT YAML files. -2. common: It has all the file that can support the execution of parser and generator. -3. tests: It contains test programs and more importantly several templates which are used for testing. - -Project Info ------------- - -* License: Apache License, Version 2.0 -* Documentation: http://docs.openstack.org/developer/heat-translator/ -* Launchpad: https://launchpad.net/heat-translator -* Blueprints: https://blueprints.launchpad.net/heat-translator -* Bugs: https://bugs.launchpad.net/heat-translator -* Source: http://git.openstack.org/cgit/openstack/heat-translator/ -* IRC Channel: #openstack-heat-translator |