Merge "Update Murano plugin guide"

This commit is contained in:
Jenkins 2016-09-01 10:41:24 +00:00 committed by Gerrit Code Review
commit 3c078ac700
10 changed files with 108 additions and 63 deletions

View File

@ -1,14 +0,0 @@
.. _links:
============
Useful links
============
For more information about Murano plugin for Fuel described in this document,
see:
* `Specification <https://specs.openstack.org/openstack/fuel-specs/specs/9.0/murano-fuel-plugin.html>`__
* `Launchpad project <https://launchpad.net/fuel-plugin-murano>`__
* `GitHub project <http://git.openstack.org/cgit/openstack/fuel-plugin-murano>`__

View File

@ -4,11 +4,65 @@
Configure Murano plugin
=======================
Configuring Murano plugin involves ...
Once the *Murano Plugin* is installed, follow the instruction below to create
an OpenStack environment with Murano services.
**To confgiure Murano plugin:**
Plugin configuration
--------------------
#. Create an OpenStack environment as described in
the `Fuel User Guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/create-environment.html>`_:
**To configure the plugin:**
#. ...
#. Create an OpenStack environment as described in the
`Fuel User Guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/create-environment.html>`_
or use an existing one.
#. To enable the Murano plugin, navigate to the :guilabel:`Environments` tab
and select the :guilabel:`Murano plugin` checkbox:
.. image:: images/murano-plugin-9-0.png
:width: 440pt
#. Configure the Murano plugin as required selecting the following available
settings.
:guilabel:`Murano Repository URL` specifies the murano applications
repository to import a package.
:guilabel:`Install Murano service broker for Cloud Foundry` enables Cloud
Foundry Service Broker API. Cloud Foundry is PaaS which supports full
lifecycle from initial development through all testing stages to
deployment. Most well-known Cloud Foundry flavors are Cloud Foundry OSS,
Pivotal Cloud Foundry, and Pivotal Web Services. If Cloud Foundry Service
Broker API is enabled, Murano apps are available at Cloud Foundry as
services.
:guilabel:`Enable glance artifact repository` enables usage of new Glance
API, which stores not only the VM images but also data assets and their
metadata for other OpenStack projects. This specification defines the usage
of this feature in Murano. Therefore, Murano may store its packages in
Glance and benefit from all its features.
:guilabel:`Install Application Catalog UI` enables the OpenStack Community
App Catalog, which will help make applications available on OpenStack cloud
by providing a community-driven catalog containing Glance images, Heat
templates, and Murano applications.
:guilabel:`Additional config` allows specifying Murano end-user credentials,
such as names of Murano users (db, keystone, rabbit), passwords, and others.
.. image:: images/murano-options-9-0.png
:width: 440pt
#. To deploy Murano services on a particular OpenStack node, assign the
:guilabel:`Murano node` role to this node in the :guilabel:`Nodes` tab.
There are no restrictions to combining the Murano role with other node
roles. Otherwise, Murano services will be deployed on controller nodes.
.. image:: images/murano-node-role.png
:width: 440pt
#. Configure your environment as described in the
`Fuel User Guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/configure-environment.html>`__.
Now, you can deploy your OpenStack environment with Murano as described in the
`Fuel user Guide <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/deploy-environment.html>`__.

Binary file not shown.

After

Width:  |  Height:  |  Size: 113 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 67 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 98 KiB

View File

@ -2,16 +2,10 @@
Murano Plugin for Fuel Guide
============================
Murano plugin for Fuel is ...
This guide documents the ... version of Murano plugin.
.. toctree::
:maxdepth: 2
intro
install
configure
licenses
appendix
update

View File

@ -1,11 +1,11 @@
.. _pg-install:
=====================
Install Murano plugin
=====================
========================
Installing Murano plugin
========================
Before you install Murano plugin, verify that your environment meets
the requirements described in :ref:`pg-prerequisites`. You must have the Fuel
Before you install Murano plugin, verify that your environment meets the
requirements described in :ref:`pg-prerequisites`. You must have the Fuel
Master node installed and configured before you can install the plugin.
Typically, you install a Fuel plugin before you deploy an OpenStack environment.
@ -19,15 +19,15 @@ Typically, you install a Fuel plugin before you deploy an OpenStack environment.
.. code-block:: console
# scp <plugin filename> root@fuel-master:/tmp
# scp detach-murano-<plugin_version> root@fuel-master:/tmp
#. Log into Fuel Master node CLI as root.
#. Log in to the Fuel Master node CLI as root.
#. Install the plugin by typing:
.. code-block:: console
# fuel plugins --install <plugin filename>
# fuel plugins --install detach-murano-<plugin_version>
#. Verify that the plugin is installed correctly:
@ -36,8 +36,8 @@ Typically, you install a Fuel plugin before you deploy an OpenStack environment.
# fuel plugins
id | name | version | package_version
---|---------------|---------|----------------
1 | <name> |<version>| <version>
1 | detach-murano | 1.0.0 | 4.0.0
#. Proceed to :ref:`pg-configure`.
.. _Fuel Plugins Catalog: https://www.mirantis.com/products/openstack-drivers-and-plugins/fuel-plugins/
.. _Fuel Plugins Catalog: https://www.mirantis.com/products/openstack-drivers-and-plugins/fuel-plugins/

View File

@ -1,17 +1,15 @@
.. _overview:
=========================
Overview of Murano plugin
=========================
========
Overview
========
Murano plugin provides functionality to <describe functionality of the plugin>.
You can use Murano plugin to configure <describe use cases for the plugin,
what problems>.
The plugin includes the following components:
* Component 1
* Component 2
Murano plugin for Fuel is a plugin to install the Application Catalog Service
for OpenStack.
Murano plugin provides flexibility for the OpenStack Application Catalog
service by supporting multiple releases and versions (for some Fuel version).
Also, the plugin provides the capability to detach Murano from the controller
node as a separate node.
.. _pg-prerequisites:
@ -24,14 +22,30 @@ To use Murano plugin, verify that your environment meets the following prerequis
Prerequisites Version/Comment
======================= =================================
Fuel 9.0
<component 1>
<hardware>
======================= =================================
Limitations
~~~~~~~~~~~
Murano plugin has some known issues and limitations of usage:
Murano plugin has no issues or limitations of usage.
* ...
* ...
Licenses
~~~~~~~~
================= ============
**Component** **License**
================= ============
Murano plugin Apache 2.0
================= ============
References
~~~~~~~~~~
For more information about Murano plugin for Fuel described in this document,
see:
* `Specification <https://specs.openstack.org/openstack/fuel-specs/specs/9.0/murano-fuel-plugin.html>`__
* `Launchpad project <https://launchpad.net/fuel-plugin-murano>`__
* `GitHub project <http://git.openstack.org/cgit/openstack/fuel-plugin-murano>`__

View File

@ -1,11 +0,0 @@
.. _pg-license:
========
Licenses
========
================= ============
**Component** **License**
================= ============
Murano plugin Apache 2.0
================= ============

View File

@ -0,0 +1,8 @@
.. _pg-update:
======================
Updating Murano plugin
======================
To update the plugin, follow the steps described in the
`Fuel Plugins Guide <https://wiki.openstack.org/wiki/Fuel/Plugins#Plugin_versioning_system>`_.