From 9cbd590ee9286cb8c12688b9ae358d6772d200ae Mon Sep 17 00:00:00 2001 From: Ihar Hrachyshka Date: Fri, 20 Feb 2015 14:51:08 +0100 Subject: [PATCH] devref: updated documentation for advanced services 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 | 18 ++++++++++---- doc/source/devref/fwaas.rst | 30 ----------------------- doc/source/devref/lbaas.rst | 32 ------------------------- doc/source/devref/vpnaas.rst | 21 ---------------- 4 files changed, 14 insertions(+), 87 deletions(-) delete mode 100644 doc/source/devref/fwaas.rst delete mode 100644 doc/source/devref/lbaas.rst delete mode 100644 doc/source/devref/vpnaas.rst diff --git a/doc/source/devref/advanced_services.rst b/doc/source/devref/advanced_services.rst index 2e877128a..d96c2ff7f 100644 --- a/doc/source/devref/advanced_services.rst +++ b/doc/source/devref/advanced_services.rst @@ -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 index 7b7680c6f..000000000 --- a/doc/source/devref/fwaas.rst +++ /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 index 86f408718..000000000 --- a/doc/source/devref/lbaas.rst +++ /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 index e2d2f1b6d..000000000 --- a/doc/source/devref/vpnaas.rst +++ /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: -- 2.45.2