18f3915374
This wasn't setup in the reppo, so I'm adding it now. Empty for now, with TODOs for some sections. The "tox -e docs" was updated to generate the documentation. Change-Id: I17e475b2a870a1ecdb2a1cacf2087a96beac3f78
51 lines
1.8 KiB
ReStructuredText
51 lines
1.8 KiB
ReStructuredText
..
|
|
Copyright 2015 OpenStack Foundation
|
|
All Rights Reserved.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
not use this file except in compliance with the License. You may obtain
|
|
a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
License for the specific language governing permissions and limitations
|
|
under the License.
|
|
|
|
Welcome to Neutron VPNaaS developer documentation!
|
|
==================================================
|
|
|
|
This provides Virtual Private Network as a Service (VPNaaS) capabilities to Neutron.
|
|
Maintained as a separate repo, this works in conjunction with the Neutron repo to
|
|
provide VPN services for OpenStack. The `VPNaaS API`_ is implementation as an
|
|
extension to Neutron's networking API:
|
|
|
|
.. _`VPNaaS API`: http://developer.openstack.org/api-ref-networking-v2-ext.html#vpnaas-v2.0
|
|
|
|
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.
|
|
|
|
.. _`OpenStack wiki`: http://wiki.openstack.org
|
|
.. _`Neutron section of the wiki`: http://wiki.openstack.org/Neutron
|
|
.. _`Neutron Development wiki`: http://wiki.openstack.org/NeutronDevelopment
|
|
|
|
Enjoy!
|
|
|
|
Developer Docs
|
|
==============
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
devref/index
|
|
|
|
API Extensions
|
|
==============
|
|
|
|
Go to http://api.openstack.org for information about OpenStack Network API extensions.
|