Adds information into VPNaaS plugin spec and readme file
Since README.md file contains common information about the plugin, it should be updated with the following: 1) link to Fuel Plugins Catalog 2) link to the VPNaaS plugin tutorial 3) fixes for installation instructions Spec is now updated with assignees, their roles and contacts. Change-Id: I2374226a91e03b529e9b24987aff30a2a5bebf30
This commit is contained in:
parent
407d6cf127
commit
76e596002a
53
README.md
53
README.md
|
@ -4,32 +4,59 @@ VPNaaS plugin
|
||||||
VPNaaS (VPN-as-a-Service) is a Neutron extension that introduces VPN feature set.
|
VPNaaS (VPN-as-a-Service) is a Neutron extension that introduces VPN feature set.
|
||||||
|
|
||||||
This repo contains all necessary files to build VPNaaS Fuel plugin.
|
This repo contains all necessary files to build VPNaaS Fuel plugin.
|
||||||
Currently the only supported Fuel versions are 6.0 and higher.
|
Currently, the only supported Fuel versions are 6.0 and higher.
|
||||||
|
|
||||||
Building the plugin
|
Building the plugin
|
||||||
-------------------
|
-------------------
|
||||||
|
|
||||||
1. Clone the fuel-plugin repo from:
|
1. Clone the fuel-plugin repo from:
|
||||||
git clone https://github.com/stackforge/fuel-plugin-neutron-vpnaas
|
|
||||||
2. Install Fuel Plugin Builder:
|
``git clone https://github.com/stackforge/fuel-plugin-neutron-vpnaas``
|
||||||
pip install fuel-plugin-builder
|
|
||||||
|
2. Install the Fuel Plugin Builder:
|
||||||
|
|
||||||
|
``pip install fuel-plugin-builder``
|
||||||
|
|
||||||
3. Build VPNaaS Fuel plugin:
|
3. Build VPNaaS Fuel plugin:
|
||||||
fpb --build fuel-plugin-neutron-vpnaas/
|
|
||||||
4. vpnaas-plugin-x.x.x.fp plugin file will be created in the plugin folder
|
``fpb --build fuel-plugin-neutron-vpnaas/``
|
||||||
ll fuel-plugin-neutron-vpnaas/
|
|
||||||
5. Move this file to the Fuel master node and install
|
4. The vpnaas-plugin-<x.x.x>.fp plugin file will be created in the plugin folder
|
||||||
fuel plugins --install vpnaas-plugin-x.x.x.fp
|
(fuel-plugin-neutron-vpnaas/).
|
||||||
6. Plugin is ready to use and can be enabled via Fuel WebUI ('Settings' tab)
|
|
||||||
|
5. Move this file to the Fuel Master node with secure copy (scp):
|
||||||
|
|
||||||
|
``scp vpnaas-plugin-<x.x.x>.fp root@:<the_Fuel_Master_node_IP address>:/tmp``
|
||||||
|
``cd /tmp``
|
||||||
|
|
||||||
|
6. Install the VPNaaS plugin:
|
||||||
|
|
||||||
|
``fuel plugins --install vpnaas-plugin-<x.x.x>.fp``
|
||||||
|
|
||||||
|
6. Plugin is ready to use and can be enabled on the Settings tab of the Fuel web UI.
|
||||||
|
|
||||||
|
Note that you can also download the built VPNaaS
|
||||||
|
plugin from
|
||||||
|
the [Fuel Plugins Catalog](https://software.mirantis.com/download-mirantis-openstack-fuel-plug-ins/).
|
||||||
|
|
||||||
Deployment details
|
Deployment details
|
||||||
------------------
|
------------------
|
||||||
Neutron VPN agent replaces Neutron L3 agent because it combines both L3 and
|
|
||||||
VPNaaS functionality. No user interaction is required, VPNaaS will be enabled
|
Neutron VPN agent replaces Neutron L3 agent
|
||||||
|
because it combines both L3 and
|
||||||
|
VPNaaS functionality. No user interaction is required,
|
||||||
|
VPNaaS will be enabled
|
||||||
immediately after deployment.
|
immediately after deployment.
|
||||||
|
|
||||||
Accessing VPNaaS functionality
|
Accessing VPNaaS functionality
|
||||||
------------------------------
|
------------------------------
|
||||||
|
|
||||||
VPN settings can be found in Openstack Dashboard:
|
VPN settings can be found in Openstack Dashboard:
|
||||||
Project -> Network -> VPN
|
Project -> Network -> VPN.
|
||||||
|
|
||||||
|
For step-by-step instructions, see [the Mirantis blogpost](https://www.mirantis.com/blog/mirantis-openstack-express-vpn-service-vpnaas-step-step/).
|
||||||
|
|
||||||
Please use official Openstack documentation to obtain more information:
|
Please use official Openstack documentation to obtain more information:
|
||||||
- https://wiki.openstack.org/wiki/Neutron/VPNaaS
|
- https://wiki.openstack.org/wiki/Neutron/VPNaaS
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -22,7 +22,7 @@ and a private network in some cloud.
|
||||||
Proposed change
|
Proposed change
|
||||||
===============
|
===============
|
||||||
|
|
||||||
Implement a FUEL plugin which will deploy IPSec service(OpenSwan) and configure
|
Implement a Fuel plugin which will deploy IPSec service(OpenSwan) and configure
|
||||||
VPNaaS functionality in Neutron and Horizon.
|
VPNaaS functionality in Neutron and Horizon.
|
||||||
|
|
||||||
Alternatives
|
Alternatives
|
||||||
|
@ -88,16 +88,20 @@ Assignee(s)
|
||||||
|
|
||||||
Primary assignee:
|
Primary assignee:
|
||||||
|
|
||||||
Feature Lead: Andrey Epifanov
|
Andrey Epifanov <aepifanov@mirantis.com> - feature lead, developer
|
||||||
Mandatory Design Reviewers: Stanislaw Bogatkin, Sergey Kolekonov,
|
|
||||||
Sergey Vasilenko
|
Other contributors:
|
||||||
Developers: Andrey Epifanov
|
|
||||||
QA: Timur Nurlygayanov
|
Stanislaw Bogatkin <sbogatkin@mirantis.com> - design reviewer
|
||||||
|
Sergey Kolekonov <skilekonov@mirantis.com> - design reviewer
|
||||||
|
Sergey Vasilenko <svasilenko@mirantis.com> - design reviewer
|
||||||
|
Timur Nurlygayanov <tnurlygayanov@mirantis.com> - QA engineer
|
||||||
|
Irina Povolotskaya <ipovolotskaya@mirantis.com> - technical writer
|
||||||
|
|
||||||
Work Items
|
Work Items
|
||||||
----------
|
----------
|
||||||
|
|
||||||
* Implement FUEL plugin.
|
* Implement Fuel plugin.
|
||||||
* Implement puppet manifests.
|
* Implement puppet manifests.
|
||||||
* Testing.
|
* Testing.
|
||||||
* Write Documentation.
|
* Write Documentation.
|
||||||
|
@ -106,7 +110,7 @@ Dependencies
|
||||||
============
|
============
|
||||||
|
|
||||||
* OpenSwan package.
|
* OpenSwan package.
|
||||||
* FUEL 6.0 and higher.
|
* Fuel 6.0 and higher.
|
||||||
|
|
||||||
Testing
|
Testing
|
||||||
=======
|
=======
|
||||||
|
@ -114,7 +118,7 @@ Testing
|
||||||
* Prepare a test plan.
|
* Prepare a test plan.
|
||||||
* Test a deployment with activated plugin on all FUEL deployment modes.
|
* Test a deployment with activated plugin on all FUEL deployment modes.
|
||||||
* Test VPN connection with test VPN point.
|
* Test VPN connection with test VPN point.
|
||||||
* Integration tests with other OpenStack components and Neutron plugins.
|
* Provide integration tests with other OpenStack components and Neutron plugins.
|
||||||
|
|
||||||
Documentation Impact
|
Documentation Impact
|
||||||
====================
|
====================
|
||||||
|
|
Loading…
Reference in New Issue