App Dev Guide: Hot Packages

Includes:
 -Compose a package
 -Upload a package (removed)

Change-Id: I8bbc993505f965d35402f24d5ac0659ca32b1742

doc/source/draft/appdev-guide/hot_packages.rst

@@ -7,8 +7,5 @@
 HOT packages
 ============
 
-Compose a package
+.. include:: hotpackages/compose.rst
-~~~~~~~~~~~~~~~~~
 
-Upload a package
-~~~~~~~~~~~~~~~~

doc/source/draft/appdev-guide/hotpackages/compose.rst

@@ -0,0 +1,86 @@
+.. _compose_package:
+
+Compose a package
+~~~~~~~~~~~~~~~~~
+
+Murano is an Application catalog which intends to support applications defined in different formats. As a first step to universality, support of a heat orchestration template was added.
+It means that any heat template could be added as a separate application into the Application Catalog. This could be done in two ways: manual and automatic.
+
+Automatic package composing
+---------------------------
+
+Before uploading an application into the catalog, it should be prepared and archived.
+A Murano command line will do all preparation for you.
+Just choose the desired Heat Orchestration Template and perform the following command:
+
+::
+
+murano package-create  --template wordpress/template.yaml
+
+Note, that optional parameters could be specified:
+
+:--name: an application name, copied from a template by default
+:--logo: an application square logo, by default the heat logo will be used
+:--description: text information about an application, by default copied from a template
+:--author: a name of an application author
+:--output: a name of an output file archive to save locally
+:--full-name:  a fully qualified domain name that specifies exact application location
+
+.. note::
+    To performing this command python-muranoclient should be installed in the system
+
+As the result, an application definition archive will be ready for uploading.
+
+Manual package composing
+------------------------
+
+Application package could be composed manually. Follow the 5 steps below.
+
+* *Step 1. Choose the desired heat orchestration template*
+
+  For this example
+  `chef-server.yaml <https://github.com/openstack/heat-templates/blob/master/hot/chef-server.yaml>`_
+  template will be used.
+
+* *Step 2. Rename it to template.yaml*
+* *Step 3. Prepare an application logo (optional step)*
+
+  It could be any picture associated with the application.
+
+* *Step 4. Create manifest.yaml file*
+
+  All service information about the application is contained here. Specify the following parameters:
+
+   :Format: defines an application definition format; should be set to ``Heat.HOT/1.0``
+   :Type: defines a manifest type, should be set to ``Application``
+   :FullName: a unique name which will be used to identify the application in Murano Catalog
+   :Description: text information about an application
+   :Author: a name of an application author or a company
+   :Tags: keywords associated with the application
+   :Logo: a name of a logo file for an application
+
+   Take a look at the example:
+
+    .. code-block:: yaml
+
+        Format: Heat.HOT/1.0
+        Type: Application
+        FullName: io.murano.apps.Chef-Server
+        Name: Chef Server
+        Description: "Heat template to deploy Open Source CHEF server on a VM"
+        Author: Kate
+        Tags:
+          - hot-based
+        Logo: logo.png
+
+* *Step 5. Create a zip archive, containing the specified files:* ``template.yaml``, ``manifest.yaml``, ``logo.png``
+
+`Applications` page looks like:
+
+.. image:: hotpackages/chef_server.png
+
+The configuration form, where you can enter template parameters, will be generated automatically and looks as follows:
+
+.. image:: hotpackages/chef_server_form.png
+
+After filling the form the application is ready to be deployed.