From 15c8e4eb1f3d740d7a9e9874539ee2bd63f1719e Mon Sep 17 00:00:00 2001 From: Javeria Khan Date: Tue, 15 Mar 2016 12:21:24 -0700 Subject: [PATCH] Add Fuel PLUMgrid plugin spec Change-Id: I9317ae3ca4c74238f00cabaff3f487d3d4654f0b Signed-off-by: Javeria Khan --- specs/plumgrid-plugin-spec.rst | 156 +++++++++++++++++++++++++++++++++ 1 file changed, 156 insertions(+) create mode 100644 specs/plumgrid-plugin-spec.rst diff --git a/specs/plumgrid-plugin-spec.rst b/specs/plumgrid-plugin-spec.rst new file mode 100644 index 0000000..5d021e9 --- /dev/null +++ b/specs/plumgrid-plugin-spec.rst @@ -0,0 +1,156 @@ +.. + +Copyright 2016 PLUMgrid Inc. + +===================== +PLUMgrid Fuel Plugin +===================== + +The PLUMgrid plugin for Fuel provides the capability to use PLUMgrid +ONS as the entire network backend for Mirantis OpenStack. This installs +the PLUMgrid core neutron plugin in collaboration with PLUMgrid Director, +Edge and Gateway components to provide a virtual network infrastructure +for the Cloud. + +-------------------- +Problem description +-------------------- + +PLUMgrid is a core neutron networking plugin that has been a part of OpenStack +neutron since Grizzly. It offers a Network Virtualization Platform that uses +direct communication with the Hypervisor layer to provide all the networking +functionality requested through Neutron APIs. The PLUMgrid Neutron Plugin +implements Neutron v2 APIs and helps configure L2/L3 virtual networks +created through the PLUMgrid Platform. It also implements External Networks +and Port Binding Extensions. + +APIs supported by the PLUMgrid plugin: + - Networks + - Subnets + - Ports + - External Networks + - Routers + - Security Groups + - Quotas + - Port Binding + - Provider Networks + +---------------- +Proposed changes +---------------- + +Implement a Fuel plugin that deploys PLUMgrid as the core neutron +plugin and configure Mirantis OpenStack to use PLUMgrid as the networking +backend. + +The plugin deployment will also include deploying PLUMgrid Zone components +which reside on the controller and compute nodes to interact with the cluster. +A new role will also be created to deploy PLUMgrid Gateway nodes. These +Gateway nodes reside outside of the OpenStack cluster and are deployed +over standard Ubuntu servers. + +------------ +Alternatives +------------ + +None. + +-------------- +Upgrade impact +-------------- + +Upgrading the Fuel PLUMgrid plugin will be possible through the standard +fuel cli. Also upgrading the PLUMgrid ONS version will be possible through +re-running post_deployment tasks after pointing to a repository with newer +PLUMgrid packages. + +--------------- +Security impact +--------------- + +None. + +-------------------- +Notifications impact +-------------------- + +None. + +--------------- +End user impact +--------------- + +End users will be able to leverage the enhanced scale and operational +capabilities provided by the PLUMgrid plugin when choosing to install +this plugin. Further details can be found in the References section below. + +------------------ +Performance impact +------------------ + +Same as End user impact. + +----------------- +Deployment impact +----------------- + +The PLUMgrid plugin tasks all run in post_deployment stage. + +---------------- +Developer impact +---------------- + +None. + +-------------------- +Documentation impact +-------------------- + +Documentation describing how to configure the Fuel UI PLUMgrid plugin +parameters to install PLUMgrid, will be provided with the plugin. This +will be deployer documentation. + + +Implementation +-------------- + +Assignee(s) +=========== + +Primary assignee: + +* Javeria Khan https://launchpad.net/~javeria-ak + +Other contributors: + +* Abdullah Khan + +Work Items +========== + +* Implement the Fuel plugin. +* Implement the Puppet manifests. +* Testing (automatic and manual tests). +* Write the documentation. + +Dependencies +============ + +* Fuel 7.0 or higher. +* PLUMgrid-Gateway node must be deployed. + +------------ +Testing, QA +------------ + +* Functional, Tempest & Rally suites will be run on deployment. +* Test the plugin upgrades on a running enviroment. +* Test PLUMgrid ONS upgrades on a running enviroment. +* Test HA functionality of deployed environment. + +---------- +References +---------- + +* http://www.plumgrid.com/ +* https://wiki.openstack.org/wiki/PLUMgrid-Neutron