From 76e596002a617015044274afae9fd9f30a9e7b81 Mon Sep 17 00:00:00 2001 From: Irina Povolotskaya Date: Thu, 12 Feb 2015 15:30:38 +0300 Subject: [PATCH] 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 --- README.md | 53 +++++++++++++++++++++++++++--------- specs/fuel-plugin-vpnaas.rst | 22 +++++++++------ 2 files changed, 53 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index ac889d0..b39a450 100644 --- a/README.md +++ b/README.md @@ -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-.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-.fp root@::/tmp`` + ``cd /tmp`` + +6. Install the VPNaaS plugin: + + ``fuel plugins --install vpnaas-plugin-.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 + + diff --git a/specs/fuel-plugin-vpnaas.rst b/specs/fuel-plugin-vpnaas.rst index 942880c..fa9188e 100644 --- a/specs/fuel-plugin-vpnaas.rst +++ b/specs/fuel-plugin-vpnaas.rst @@ -22,7 +22,7 @@ and a private network in some cloud. 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. Alternatives @@ -88,16 +88,20 @@ Assignee(s) Primary assignee: -Feature Lead: Andrey Epifanov -Mandatory Design Reviewers: Stanislaw Bogatkin, Sergey Kolekonov, -Sergey Vasilenko -Developers: Andrey Epifanov -QA: Timur Nurlygayanov + Andrey Epifanov - feature lead, developer + +Other contributors: + + Stanislaw Bogatkin - design reviewer + Sergey Kolekonov - design reviewer + Sergey Vasilenko - design reviewer + Timur Nurlygayanov - QA engineer + Irina Povolotskaya - technical writer Work Items ---------- -* Implement FUEL plugin. +* Implement Fuel plugin. * Implement puppet manifests. * Testing. * Write Documentation. @@ -106,7 +110,7 @@ Dependencies ============ * OpenSwan package. -* FUEL 6.0 and higher. +* Fuel 6.0 and higher. Testing ======= @@ -114,7 +118,7 @@ Testing * Prepare a test plan. * Test a deployment with activated plugin on all FUEL deployment modes. * 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 ====================