x/fuel-plugin-neutron-vpnaas
Code Issues Proposed changes

Adds links to README file

Browse Source 
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

Change-Id: I2374226a91e03b529e9b24987aff30a2a5bebf30
This commit is contained in:
Irina Povolotskaya 2015-02-12 15:30:38 +03:00
parent 407d6cf127
commit 3a02da8fae
1 changed files with 40 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
README.md
View File

@ -4,32 +4,59 @@ VPNaaS plugin
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.
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
-------------------
1. Clone the fuel-plugin repo from:
git clone https://github.com/stackforge/fuel-plugin-neutron-vpnaas
2. Install Fuel Plugin Builder:
pip install fuel-plugin-builder
``git clone https://github.com/stackforge/fuel-plugin-neutron-vpnaas``
2. Install the Fuel Plugin Builder:
``pip install fuel-plugin-builder``
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
ll fuel-plugin-neutron-vpnaas/
5. Move this file to the Fuel master node and install
fuel plugins --install vpnaas-plugin-x.x.x.fp
6. Plugin is ready to use and can be enabled via Fuel WebUI ('Settings' tab)
``fpb --build fuel-plugin-neutron-vpnaas/``
4. The vpnaas-plugin-<x.x.x>.fp plugin file will be created in the plugin folder
(fuel-plugin-neutron-vpnaas/).
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
------------------
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.
Accessing VPNaaS functionality
------------------------------
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:
- https://wiki.openstack.org/wiki/Neutron/VPNaaS