diff options
author | shangxdy <shang.xiaodong@zte.com.cn> | 2017-03-09 19:29:34 +0800 |
---|---|---|
committer | shangxdy <shang.xiaodong@zte.com.cn> | 2017-03-09 20:03:51 +0800 |
commit | d10f22decf8e511ce9421d707c56bed0d26c848d (patch) | |
tree | 10a57dc01eb3ce2a39c4103a0c1856763bce3112 /tosca2heat/heat-translator | |
parent | c09ba66cc51c4db17503f79c05ea0b0cd0626596 (diff) |
Fix docs bug
Fix docs bug when install parser or run tox tools
JIRA:PARSER-122
Change-Id: I247afee0b81e64ea691b061ab600e20ce55849c7
Signed-off-by: shangxdy <shang.xiaodong@zte.com.cn>
Diffstat (limited to 'tosca2heat/heat-translator')
-rw-r--r-- | tosca2heat/heat-translator/README.md | 56 | ||||
-rw-r--r-- | tosca2heat/heat-translator/setup.cfg | 10 |
2 files changed, 57 insertions, 9 deletions
diff --git a/tosca2heat/heat-translator/README.md b/tosca2heat/heat-translator/README.md new file mode 100644 index 0000000..c8af42a --- /dev/null +++ b/tosca2heat/heat-translator/README.md @@ -0,0 +1,56 @@ +======================== +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 diff --git a/tosca2heat/heat-translator/setup.cfg b/tosca2heat/heat-translator/setup.cfg index 21d0c6f..38bc1b9 100644 --- a/tosca2heat/heat-translator/setup.cfg +++ b/tosca2heat/heat-translator/setup.cfg @@ -2,7 +2,7 @@ name = heat-translator summary = Tool to translate non-heat templates to Heat Orchestration Template. description-file = - README.rst + README.md author = OpenStack author-email = openstack-dev@lists.openstack.org home-page = http://docs.openstack.org/developer/heat-translator/ @@ -35,14 +35,6 @@ openstack.translator.v1 = console_scripts = heat-translator = translator.shell:main -[build_sphinx] -source-dir = doc/source -build-dir = doc/build -all_files = 1 - -[upload_sphinx] -upload-dir = doc/build/html - [compile_catalog] directory = translator/locale domain = translator |