Advanced Services documentation

Adds the beginnings of documentation for the Firewall as a Service,
Loadbalancer as a Service, and VPN as a Service.

Part of blueprint developer-documentation

Change-Id: I5e46df2dc4f87f961490ee75791a7e825ea94e1e

diff --git a/doc/source/devref/advanced_services.rst b/doc/source/devref/advanced_services.rst
new file mode 100644 (file)
index 0000000..2e87712
--- /dev/null
+++ b/doc/source/devref/advanced_services.rst
@@ -0,0 +1,7 @@
+Advanced Services
+=================
+
+.. toctree::
+   fwaas
+   lbaas
+   vpnaas

diff --git a/doc/source/devref/fwaas.rst b/doc/source/devref/fwaas.rst
new file mode 100644 (file)
index 0000000..7b7680c
--- /dev/null
+++ b/doc/source/devref/fwaas.rst
@@ -0,0 +1,30 @@
+Firewall as a Service
+=====================
+
+`Design Document`_
+
+.. _Design Document: https://docs.google.com/document/d/1PJaKvsX2MzMRlLGfR0fBkrMraHYF0flvl0sqyZ704tA/edit#heading=h.aed6tiupj0qk
+
+Plugin
+------
+.. automodule:: neutron.services.firewall.fwaas_plugin
+
+.. autoclass:: FirewallPlugin
+   :members:
+
+Database layer
+--------------
+
+.. automodule:: neutron.db.firewall.firewall_db
+
+.. autoclass:: Firewall_db_mixin
+   :members:
+
+
+Driver layer
+------------
+
+.. automodule:: neutron.services.firewall.drivers.fwaas_base
+
+.. autoclass:: FwaasDriverBase
+   :members:

diff --git a/doc/source/devref/index.rst b/doc/source/devref/index.rst
index 446f0862b06c7888a84447edab6674338495a05b..46d2edd0e8f4a693b2a2b5ba42450df425efefbd 100644 (file)
--- a/doc/source/devref/index.rst
+++ b/doc/source/devref/index.rst
@@ -44,6 +44,7 @@ Neutron Internals
    rpc_api
    layer3
    l2_agents
+   advanced_services
 
 
 Module Reference

diff --git a/doc/source/devref/lbaas.rst b/doc/source/devref/lbaas.rst
new file mode 100644 (file)
index 0000000..86f4087
--- /dev/null
+++ b/doc/source/devref/lbaas.rst
@@ -0,0 +1,32 @@
+Loadbalancer as a Service
+=========================
+
+
+https://wiki.openstack.org/wiki/Neutron/LBaaS/Architecture
+
+https://wiki.openstack.org/wiki/Neutron/LBaaS/API_1.0
+
+
+Plugin
+------
+.. automodule:: neutron.services.loadbalancer.plugin
+
+.. autoclass:: LoadBalancerPlugin
+   :members:
+
+Database layer
+--------------
+
+.. automodule:: neutron.db.loadbalancer.loadbalancer_db
+
+.. autoclass:: LoadBalancerPluginDb
+   :members:
+
+
+Driver layer
+------------
+
+.. automodule:: neutron.services.loadbalancer.drivers.abstract_driver
+
+.. autoclass:: LoadBalancerAbstractDriver
+   :members:

diff --git a/doc/source/devref/vpnaas.rst b/doc/source/devref/vpnaas.rst
new file mode 100644 (file)
index 0000000..e2d2f1b
--- /dev/null
+++ b/doc/source/devref/vpnaas.rst
@@ -0,0 +1,21 @@
+VPN as a Service
+=====================
+
+`API Specification`_
+
+.. _API Specification: http://docs.openstack.org/api/openstack-network/2.0/content/vpnaas_ext.html
+
+Plugin
+------
+.. automodule:: neutron.services.vpn.plugin
+
+.. autoclass:: VPNPlugin
+   :members:
+
+Database layer
+--------------
+
+.. automodule:: neutron.db.vpn.vpn_db
+
+.. autoclass:: VPNPluginDb
+   :members: