Describes Pluggable architecture feature

Since Fuel 6.0 has a brand new feature,
we have the following tasks:

* create instructions on how to install a plugin (User Guide)

Co-Authored-By: Evgeniy L <eli@mirantis.com>

Links to plug-in-related CRs:

* Separate all-in-one Plug-in Development Guide: https://review.openstack.org/#/c/138013/

* Certification issue (to be posted to Plug-in DevGuide): https://review.openstack.org/#/c/140421/

* Updates on Terminology articles: https://review.openstack.org/#/c/140350/

Change-Id: Id44d195c8a70e1b3a943ad7e15dff0753ad8499b
Implements: blueprint cinder-neutron-plugins-in-fuel
Closes-Bug: 1397889
This commit is contained in:
irina povolotskaya
2014-10-23 15:31:00 +04:00
committed by Dmitry Borodaenko
parent 62017fc9e6
commit f992773ffa
14 changed files with 221 additions and 2 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 77 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB

BIN
_images/vpnaas_plugin.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

View File

@@ -1,6 +1,7 @@
.. include:: /pages/user-guide/0070-introduction.rst
.. include:: /pages/user-guide/1500-confirm-hardware.rst
.. include:: /pages/user-guide/2000-install-boot.rst
.. include:: /pages/user-guide/fuel-plugins/010-install-plugin.rst
.. include:: /pages/user-guide/3000-create-environment.rst
.. include:: /pages/user-guide/4000-configure-environment.rst
.. include:: /pages/user-guide/5000-deploy-environment.rst

View File

@@ -87,7 +87,5 @@ default gateway, and DNS server for the Fuel Master Node.
For more details, see :ref:`fuel-on-vsphere-ug`.
.. include:: /pages/user-guide/initialize-fuel/0400-pxe-config.rst
.. include:: /pages/user-guide/initialize-fuel/0500-fuel-boot.rst
.. include:: /pages/user-guide/initialize-fuel/0600-boot-nodes.rst

View File

@@ -0,0 +1,43 @@
.. _install-plugin:
Install Fuel plug-ins
=====================
Beginning with Mirantis OpenStack 6.0,
Fuel features the ability to install plug-ins when you deploy your environment.
Plug-ins are downloadable software components that extend the functionality of your environments in a flexible, repeatable and reliable manner.
For example, :ref:`Neutron LBaaS<plugin-lbaas>` provides Load-Balancing-as-a-Service for Neutron, OpenStack Network Service.
Plug-ins fall into two categories:
* *Certified*: certified plug-ins are thoroughly reviewed, tested and supported by Mirantis.
* *Non-Certified*: non-certified plug-ins are reviewed by Mirantis, but not supported or guaranteed.
All plug-ins, both certified and non-certified are digitally signed and hosted by Mirantis.
Installing Fuel plug-ins
------------------------
Installation procedure is common for all plug-ins, but their requirements differ.
.. note:: Fuel plug-ins can be installed only before
deploying an environment you want to use the plug-in with.
#. Copy the plug-in on already installed Fuel Master node; ssh can be used for that.
If you do not have the Fuel Master node yet, see :ref:`virtualbox`.
::
scp fuel_plugin_name-1.0.0.fp root@:master_node_ip:/tmp
cd /tmp
fuel plugins --install fuel_plugin_name-1.0.0.fp
#. After your environment is created, the checkbox will appear on Fuel web UI *Settings* tab.
Use the *Settings* tab to enable and configure the plug-in and run the deployment.
.. include:: /pages/user-guide/fuel-plugins/020-fuel-plugin-ver.rst
.. include:: /pages/user-guide/fuel-plugins/030-fuel-plugin-ext.rst

View File

@@ -0,0 +1,7 @@
.. _020-fuel-plugin-ver:
Certified plug-ins
------------------
.. include:: /pages/user-guide/fuel-plugins/022-plugin-lbaas.rst
.. include:: /pages/user-guide/fuel-plugins/021-plugin-gluster.rst

View File

@@ -0,0 +1,58 @@
.. _plugin-gluster:
GlusterFS
+++++++++
This plug-in allows use of an existing `GlusterFS <http://www.gluster.org/
documentation/About_Gluster>`_ cluster as the Cinder backend.
**Requirements**
This plug-in is compatible with the following GlusterFS version:
+------------------------------------------------+------------------------------------+
| Description |Ubuntu 14.04 LTS |
+------------------------------------------------+------------------------------------+
| Release |14.04 |
+------------------------------------------------+------------------------------------+
| Codename |trusty |
+------------------------------------------------+------------------------------------+
| glusterfs 3.4.2 built on Jan 14 2014 18:05:35 | |
+------------------------------------------------+------------------------------------+
|Repository revision |git://git.gluster.com/glusterfs.git |
+------------------------------------------------+------------------------------------+
**Installation**
#. Download the plug-in from `<https://software.mirantis.com/fuel-plugins>`_.
#. Install GlusterFS plug-in. For instructions, see :ref:`install-plugin`.
#. After plug-in is installed, create an environment.
**Configuration**
#. Enable the plug-in on the *Settings* tab of the Fuel web UI.
.. image:: /_images/fuel_plugin_glusterfs_configuration.png
#. After GlusterFS plug-in is installed and a volume is created,
configure each Gluster volume to accept libgfapi connections.
To do this, configure every Gluster volume to all insecure ports [1, 2]:
::
gluster volume set <volume_name> server.allow-insecure on
gluster volume stop <volume_name>
gluster volume start <volume_name>
#. Add to /etc/glusterfs/glusterd.vol the following option:
::
option rpc-auth-allow-insecure on
#. Restart glusterd daemon.
.. SeeAlso:: For more information on GlusterFS, see
`Configure GlusterFS backend <http://docs.openstack.org/admin-guide-cloud/content/glusterfs_backend.html>`_ in the official OpenStack documentation.

View File

@@ -0,0 +1,30 @@
.. _plugin-lbaas:
Neutron LBaaS
+++++++++++++
This plug-in provides `Neutron LBaaS <https://wiki.openstack.org/wiki/Neutron/LBaaS/
PluginDrivers>`_ for environments with multiple compute nodes.
**Requirements**
Note that LBaaS plug-in can be enabled
only in multi-node environments.
**Installation**
#. Download the plug-in from `<https://software.mirantis.com/fuel-plugins>`_.
#. Install LBaaS plug-in. For instructions, see :ref:`install-plugin`.
#. After plugin is installed, create a *multi-node*
environment with Neutron.
**Configuration**
#. Enable the plug-in on the *Settings* tab of the Fuel web UI.
.. image:: /_images/fuel_plugin_lbaas_configuration.png
#. For further steps, see
`Configure Neutron LBaaS <https://wiki.openstack.org/wiki/Neutron/LBaaS/UI>`_ in the official OpenStack documentation.

View File

@@ -0,0 +1,7 @@
.. _fuel-plugin-ext:
Non-Certified plug-ins
----------------------
.. include:: /pages/user-guide/fuel-plugins/031-plugin-vpnaas.rst
.. include:: /pages/user-guide/fuel-plugins/032-plugin-netapp.rst

View File

@@ -0,0 +1,34 @@
.. _plugin-vpnaas:
Neutron VPNaaS
++++++++++++++
VPNaaS plug-in provides `Neutron VPNaaS <https://wiki.openstack.org/wiki/Neutron/VPNaaS>`__ functionality.
**Requirements**
VPNaaS plug-in is compatible with OpenStack Juno Release 2014.2.
It also supports Ubuntu 14.04 LTS and CentOS 6.5.
**Installation**
#. Download the plug-in from `<https://software.mirantis.com/fuel-plugins>`_.
#. Move this file to the Fuel
Master node and install it using the following command:
::
fuel plugins --install vpnaas-plugin-1.0.0.fp
#. After plug-in is installed, create an environment with Neutron.
**Configuration**
#. Enable the plug-in on the *Settings* tab of the Fuel web UI.
.. image:: _images/vpnaas_plugin.png
#. For further steps, see
`Configure VPN-as-a-Service (VPNaaS) <https://www.mirantis.com/blog/mirantis-openstack-express-vpn-service-vpnaas-step-step/>`_ from Mirantis blogpost.

View File

@@ -0,0 +1,41 @@
.. _032-plugin-netapp:
NetApp
++++++
NetApp plug-in will replace LVM Cinder driver.
**Requirements**
Note that to enable NetApp plug-in for Cinder, you should check the following:
* NetApp appliance is deployed and configured.
* NetApp appliance is reachable via one of the Mirantis OpenStack networks.
.. note:: Since only one Cinder node should be deployed,
Cinder volume is **not** highly available.
**Installation**
#. Download the plug-in from `<https://software.mirantis.com/fuel-plugins>`_.
#. Move this file to the Fuel
Master node and install it using the following command:
::
fuel plugins --install cinder_netapp-1.0.0.fp
#. After plug-in is installed, create an environment the default Cinder backend.
**Configuration**
#. Enable the plug-in on the *Settings* tab of the Fuel web UI.
.. image:: /_images/fuel-plugin-netapp-configuration.png
#. Configure the plug-in and assign Cinder role to one of the nodes.
#. For more information on accessing Cinder NetApp functionality,
see `the Official OpenStack documentation <http://docs.openstack.org/juno/config-reference/content/netapp-volume-driver.html>`_.