]> review.fuel-infra Code Review - openstack-build/neutron-build.git/commitdiff
devref: updated documentation for advanced services
authorIhar Hrachyshka <ihrachys@redhat.com>
Fri, 20 Feb 2015 13:51:08 +0000 (14:51 +0100)
committerHenry Gessau <gessau@cisco.com>
Mon, 23 Feb 2015 18:47:05 +0000 (13:47 -0500)
Now that we don't maintain the code for the services, we should not ship
documentation to it, but just refer to it.

Change-Id: Id0ced1196718204dda8d51b26715e2f845792ca1

doc/source/devref/advanced_services.rst
doc/source/devref/fwaas.rst [deleted file]
doc/source/devref/lbaas.rst [deleted file]
doc/source/devref/vpnaas.rst [deleted file]

index 2e877128aa3d01ba16579fdaabf85e243c13e0ec..d96c2ff7f5378c48da04e76661cbc1c8145b76f5 100644 (file)
@@ -1,7 +1,17 @@
 Advanced Services
 =================
 
-.. toctree::
-   fwaas
-   lbaas
-   vpnaas
+Historically, Neutron supported the following advanced services:
+
+#. **FWaaS** (*Firewall-as-a-Service*): runs as part of the L3 agent.
+#. **LBaaS** (*Load-Balancer-as-a-Service*): implemented purely inside
+   neutron-server, does not interact directly with agents.
+#. **VPNaaS** (*VPN-as-a-Service*): derives from L3 agent to add
+   VPNaaS functionality.
+
+Starting with the Kilo release, these services are split into separate
+repositories managed by extended reviewer teams.
+
+#. http://git.openstack.org/cgit/openstack/neutron-fwaas/
+#. http://git.openstack.org/cgit/openstack/neutron-lbaas/
+#. http://git.openstack.org/cgit/openstack/neutron-vpnaas/
diff --git a/doc/source/devref/fwaas.rst b/doc/source/devref/fwaas.rst
deleted file mode 100644 (file)
index 7b7680c..0000000
+++ /dev/null
@@ -1,30 +0,0 @@
-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/lbaas.rst b/doc/source/devref/lbaas.rst
deleted file mode 100644 (file)
index 86f4087..0000000
+++ /dev/null
@@ -1,32 +0,0 @@
-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
deleted file mode 100644 (file)
index e2d2f1b..0000000
+++ /dev/null
@@ -1,21 +0,0 @@
-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: