From 960297e36e8a9fc7c3032e249219a8d736ed6c41 Mon Sep 17 00:00:00 2001 From: Nikolay Starodubtsev Date: Thu, 24 Mar 2016 10:43:39 +0300 Subject: [PATCH] Add documentation about bundles Change-Id: Ie5a8b02f1966a6a9d2730bb530b3cd0ff2eb4ffc --- .../draft/appdev-guide/murano_bundles.rst | 60 +++++++++++++++++++ doc/source/draft/index.rst | 1 + 2 files changed, 61 insertions(+) create mode 100644 doc/source/draft/appdev-guide/murano_bundles.rst diff --git a/doc/source/draft/appdev-guide/murano_bundles.rst b/doc/source/draft/appdev-guide/murano_bundles.rst new file mode 100644 index 00000000..0cfe97dc --- /dev/null +++ b/doc/source/draft/appdev-guide/murano_bundles.rst @@ -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 ` and :ref:`Using CLI `. +Specific information about *bundle-import* command can be found at +:ref:`Murano command-line client `. + +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 `. +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 `. 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. diff --git a/doc/source/draft/index.rst b/doc/source/draft/index.rst index 05b8bb9d..804727c4 100644 --- a/doc/source/draft/index.rst +++ b/doc/source/draft/index.rst @@ -87,6 +87,7 @@ Developing Applications appdev-guide/hot_packages appdev-guide/murano_pl appdev-guide/murano_packages + appdev-guide/murano_bundles appdev-guide/app_migrating appdev-guide/app_unit_tests appdev-guide/examples