From c457f3dd00eb5e5aef67d1b0182b76844e3ee546 Mon Sep 17 00:00:00 2001 From: irina povolotskaya Date: Mon, 17 Nov 2014 14:53:07 +0300 Subject: [PATCH] Provides introductory information about repo Since Fuel 6.0 has Pluggable architecture feature, fuel-plugins repo serves to create plugins. This commit adds some introductory information and links into README.md file. Change-Id: Iddacaa04d0db892fc0fee4140020001551c97d18 Co-Authored-By: Evgeny Li --- README.md | 25 ++++++++++++++++++++++--- 1 file changed, 22 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2b4c6b7..51df516 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,23 @@ -fuel-plugins -============ +Fuel plugins repository +======================= -Fuel plugins +Starting with version 6.0, Fuel supports Pluggable architecture. +Currently, Cinder and Neutron plugins are available. + +* *fuel_plugin_builder* - command line interface that helps to create, check and build Fuel plugin. You can create your own plugin in three simple steps: + + * `pip install fuel-plugin-builder` + * `fpb --create fuel_plugin_name` + * `fpb --build fuel_plugin_name` + +* *fuel_plugin_example* - simple Fuel plugin example that shows how you can create a plugin. It deploys simple service on your Controller nodes. +* *lbaas* - Fuel plugin that provides [Neutron LBaaS](https://wiki.openstack.org/wiki/Neutron/LBaaS/PluginDrivers "Neutron LBaaS") for multinode mode. +* *external_glusterfs* - Fuel plugin that allows to use existing [GlusterFS](http://www.gluster.org/documentation/About_Gluster/ "GlusterFS") cluster as the Cinder backend. + +For instructions on creating your plugin, see + +For instructions on installing your plugin, see + +For production plugin versions, see + +For built development plugin versions, see [Fuel CI job]( https://fuel-jenkins.mirantis.com/job/stackforge-master-fuel-plugins/ "Fuel CI job")