Update README and other doc files
README needs more information and update on project info. Change-Id: Ic409253d76903535fb89f15765204d46d2153f02 Closes-Bug: #1363139
This commit is contained in:
parent
be799ae629
commit
be9551b5a1
33
README.rst
33
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/
|
||||
|
@ -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
|
||||
Heat-Translator project is planned to be made available via Heat Client,
|
||||
which then can be invoked on command line.
|
@ -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 <type of template format e.g. tosca> <path to the input template>
|
Loading…
Reference in New Issue
Block a user