diff --git a/README.rst b/README.rst index 9dff7bb9..c6366efa 100644 --- a/README.rst +++ b/README.rst @@ -1,10 +1,35 @@ =============== -heat-translator +Heat-Translator =============== -Tool to translate non-heat templates to Heat Orchestration Template. +Tool to translate non-heat templates to Heat Orchestration Template (HOT). + +Overview +-------- + +Heat-Translator is a StackForge 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 is mainly built of two components: + +1. **Parser** - parser for a particular template format e.g. TOSCA parser +2. **Generator** - takes an in-memory graph from **Parser**, maps it to Heat +resources and software configuration and then produces a HOT. + +Project Info +------------ * Free software: Apache license * Documentation: http://heat-translator.readthedocs.org/ -* Bugs: https://launchpad.net/heat-translator -* Source: https://github.com/stackforge/heat-translator/ +* Launchpad: https://launchpad.net/heat-translator +* Blueprints: https://blueprints.launchpad.net/heat-translator +* Bugs: https://bugs.launchpad.net/heat-translator +* Source Code: https://github.com/stackforge/heat-translator/ diff --git a/doc/source/installation.rst b/doc/source/installation.rst index 5427983c..fce69f3c 100644 --- a/doc/source/installation.rst +++ b/doc/source/installation.rst @@ -2,11 +2,5 @@ Installation ============ -At the command line:: - - $ pip install heat-translator - -Or, if you have virtualenvwrapper installed:: - - $ mkvirtualenv heat-translator - $ pip install heat-translator \ No newline at end of file +Heat-Translator project is planned to be made available via Heat Client, +which then can be invoked on command line. \ No newline at end of file diff --git a/doc/source/usage.rst b/doc/source/usage.rst index 4089dec2..f25160cd 100644 --- a/doc/source/usage.rst +++ b/doc/source/usage.rst @@ -2,6 +2,7 @@ Usage ===== -To use heat-translator in a project:: +Heat-Translator project is planned to be made available via Heat Client an +which then can be invoked on command line as, - import heat-translator +heat-translator \ No newline at end of file