Merge "Add documentation about bundles"

This commit is contained in:
Jenkins 2016-04-05 10:11:02 +00:00 committed by Gerrit Code Review
commit 9dc8a7b6b2
2 changed files with 61 additions and 0 deletions

View File

@ -0,0 +1,60 @@
.. _murano-bundles:
.. toctree::
:maxdepth: 2
==============
Murano bundles
==============
A bundle is a collection of packages. In the Community App Catalog, you can find
such bundles as ``container-based-apps``, ``app-servers``, and so on.
The packages in the Application Catalog are sorted by usage. You can import
bundles from the catalog using Dashboard or CLI. You can read about this in
:ref:`Managing applications <manage_applications>` and :ref:`Using CLI <use-cli>`.
Specific information about *bundle-import* command can be found at
:ref:`Murano command-line client <cli-ref>`.
Bundle structure
~~~~~~~~~~~~~~~~
Bundle description is a json structure, that contains list of packages
in the bundle and bundle version. Here is the example:
.. code-block:: javascript
{
"Packages": [
{
"Name": "io.murano.apps.apache.ApacheHttpServer",
"Version": ""
},
{
"Name": "io.murano.apps.apache.Tomcat",
"Version": ""
}
],
"Version": 1
}
..
``Name`` is a required parameter and should contain package fully qualified name.
``Version`` is not a mandatory parameter. Version for package entry specifies the
version of the package to look into :ref:`Murano package repository <repository>`.
If it is specified, murano client would look for a file with that version
specification in murano repository (for example ``io.murano.apps.MyApp.0.0.1.zip``
for io.murano.apps.MyApp of version 0.0.1). If the version is omitted or left
blank client would search for ``io.murano.apps.MyApp.zip``.
Create local bundle
~~~~~~~~~~~~~~~~~~~
However, you may need to create a local bundle. You may need it if you want to
setup your own :ref:`Murano package repository <repository>`. To create a new
bundle, perform the following steps:
#. Navigate to the directory with the target packages.
#. Create a ``.bundle`` file. List all the required packages in ``Packages``
section. If needed, specify the bundle version in the ``Version`` section.

View File

@ -88,6 +88,7 @@ Developing Applications
appdev-guide/hot_packages appdev-guide/hot_packages
appdev-guide/murano_pl appdev-guide/murano_pl
appdev-guide/murano_packages appdev-guide/murano_packages
appdev-guide/murano_bundles
appdev-guide/app_migrating appdev-guide/app_migrating
appdev-guide/app_unit_tests appdev-guide/app_unit_tests
appdev-guide/examples appdev-guide/examples