Contributor Guide

In the Contributor Guide, you will find information on the design, and architecture of the Neutron Virtual Private Network as a Service repo. This include things like, information on the reference implementation flavors, design details on VPNaaS internals, and testing. Developers will extend this, as needed, in the future to contain more information.

If you would like to contribute to the development of OpenStack, you must follow the steps documented at: https://docs.openstack.org/infra/manual/developers.html

Once those steps have been completed, changes to OpenStack should be submitted for review via the Gerrit tool, following the workflow documented at: https://docs.openstack.org/infra/manual/developers.html#development-workflow

Pull requests submitted through GitHub will be ignored.

Bugs should be filed on Launchpad in the neutron project with vpnaas tag added.

New features should be filed on Launchpad in the neutron project with rfe tag added in order to get decision from neutron drivers team. Before doing that, it is recommended to check Request for Feature Enhancements (RFE) process.

To get in touch with the neutron-vpnaas community, look at the following resource:

• Join the #openstack-vpnaas IRC channel on OFTC. This is where the VPNaaS team is available for discussion.

• We will hold for VPN-as-a-Service (bi-)weekly IRC meeting when needed in the near further.

These are great places to get recommendations on where to start contributing to neutron-vpnaas.

VPNaaS Team

• Core reviewers and Driver maintainers
  • Core reviewers
  • Driver maintainers

VPNaaS Internals

• Multiple Local Subnets for VPNaaS
  • Design Notes
  • Client CLI API
  • Examples
  • Database
  • Database Migration
  • Backwards Compatibility
  • Stories

VPNaaS Tests

• VPNaaS Tempest Tests
  • How to test:
  • Usage in gate
  • External Resources
• VPNaaS Rally Tests
  • Structure
  • How to test
  • External Resources

Testing

• Configuring VPNaaS for DevStack
  • Multinode vs All-In-One
  • How to Configure
• Testing VPNaaS with devstack
  • Installation
  • Quick Test Script
  • Using Two DevStack Nodes for Testing
    • Example Topology
    • DevStack Configuration
    • VPNaaS Configuration
    • Verification
  • Using single DevStack and two routers for testing
    • Preparation
    • DevStack Configuration
    • Cloud Configuration
    • IPsec Site-to-site Connection Creation
    • Multiple Local Subnets

Todo

Add notes about functional testing, with info on how different reference drivers are tested.

Set up VPNaaS for OVN

• Configuring VPNaaS for OVN
  • Enabling VPNaaS for OVN
  • Specifics of the OVN variant of the plugin

Module Reference

Todo

Add in all the big modules as automodule indexes.

About This Documentation

This documentation is generated by the Sphinx toolkit and lives in the source tree. Additional documentation on VPNaaS and other components of OpenStack can be found on the OpenStack wiki and the Neutron section of the wiki (see the VPN related pages). The Neutron Development wiki is also a good resource for new contributors.