Migrate NatApp dev docs to rst

Change-Id: Ie4806796ff476222e03db213ab6c74a2c313de2e
Signed-off-by: Colin Dixon <colin@colindixon.com>

diff --git a/docs/developer-guide/index.rst b/docs/developer-guide/index.rst
index c2795ebed3f2848c33bfa32906fc101a567f7b72..52b42125bba06c87a3690567c5b477df4131ee61 100644 (file)
--- a/docs/developer-guide/index.rst
+++ b/docs/developer-guide/index.rst
@@ -31,6 +31,7 @@ Project-specific Developer Guides
    l2switch-developer-guide
    lacp-developer-guide
    ../user-guide/lisp-flow-mapping-user-guide
+   natapp-developer-guide
    nemo-developer-guide
    netconf-developer-guide
    network-intent-composition-(nic)-developer-guide

diff --git a/docs/developer-guide/natapp-developer-guide.rst b/docs/developer-guide/natapp-developer-guide.rst
new file mode 100644 (file)
index 0000000..d9129fb
--- /dev/null
+++ b/docs/developer-guide/natapp-developer-guide.rst
@@ -0,0 +1,90 @@
+NATApp Developer Guide
+======================
+
+Overview
+--------
+
+NATApp acts as a basic framework for providing NAT functionality to the
+SDN controller. One can use REST or Java APIs to enter global IP address
+into YANG Data Store which will be used by the odl-natapp-feature to map
+local IP to global IP addresses.
+
+NATApp Architecture
+-------------------
+
+NATApp listens on OpenFlow southbound interface for Packet\_In messages.
+The application parses the message for header information. If the
+received message has a local IP address the application installs rules
+on the OpenFlow switch for network address translation from local to
+global IP addresses. NATApp has NATPacketHandler class that implements
+the PacketProcessing interface to override the OnPacketReceived
+notification by which the application is notified of Packet\_In
+messages.
+
+NATApp is implemented with the help of a few java classes.
+
+1. NATPacketHandler
+
+   -  Receives Packet\_In messages coming to the controller and process
+      them appropriately
+
+2. NATPacketParsing
+
+   -  Decodes Packet\_In messages for packet header information (L2, L3
+      & L4 information)
+
+3. NATInventoryUtility
+
+   -  Decodes Packet\_In messages for OpenFlow Switch and Port
+      information
+
+4. NATFlowBuilder
+
+   -  Creates NAT flow rules at the OpenFlow Switch
+
+5. NATYangStore
+
+   -  Reads Global IP entered by user and maps local IP to Global IP
+      information
+
+6. NATFlowHandler
+
+   -  Manages expired flows in the switch and frees up used global IP
+      address for future natting.
+
+Key APIs and Interfaces
+-----------------------
+
+1. RPC APIs
+
+   -  Static - Configure Static Natting Functionality
+
+   -  Dynamic - Configure Static Dynamic Functionality
+
+   -  PAT - Configure PAT Functionality
+
+2. DataStore APIs
+
+   -  StaticNatIp - Configure floating IP addresses for Static Natting
+
+   -  StaticIpMapInfo - Mapped Information between floating and private
+      IP addresses in Static Natting
+
+   -  DynamicNatIp - Configure floating IP addresses for Dynamic Natting
+
+   -  DynamicIpMapInfo - Mapped Information between floating and private
+      IP addresses in Dynamic Natting
+
+   -  PatIp - Configure floating IP addresses for Port Address
+      Translation
+
+   -  PatIpMapInfo - Mapped Information between TCP Port numbers of
+      floating IP and private IP addresses
+
+3. Notification APIs
+
+   -  DynamicIPExhaustion - Exhaustion of Dynamic Global IP Addresses
+
+   -  PatOverConnection - More than 10 TCP or UDP connections from one
+      private IP address
+

diff --git a/manuals/developer-guide/src/main/asciidoc/natapp/odl-natapp-dev.adoc b/manuals/developer-guide/src/main/asciidoc/natapp/odl-natapp-dev.adoc
index 1fb0e012b311c37ae3b446f73d4f4630f91b5a9d..88b3846b4476f72d00874e9f18c4c4ddad1d14b3 100644 (file)
--- a/manuals/developer-guide/src/main/asciidoc/natapp/odl-natapp-dev.adoc
+++ b/manuals/developer-guide/src/main/asciidoc/natapp/odl-natapp-dev.adoc
@@ -1,45 +1,3 @@
 == NATApp  Developer Guide
 
-=== Overview
-NATApp  acts as a basic framework for providing  NAT functionality
-to the SDN controller. One can use REST or Java APIs to enter global IP address into
-YANG Data Store which will be used by the odl-natapp-feature to map 
-local IP to global IP addresses. 
-
-=== NATApp  Architecture
-NATApp listens on OpenFlow southbound interface for Packet_In messages. The application parses
-the message for header information. If the received message has a local IP address the application
-installs rules on the OpenFlow switch for network address translation from local to global IP addresses.
-NATApp has NATPacketHandler class that implements the PacketProcessing interface to override the 
-OnPacketReceived notification by which the application is notified of Packet_In messages.
-
-NATApp is implemented with the help of a few java classes.
-
-. NATPacketHandler
-  * Receives Packet_In messages coming to the controller and process them appropriately
-. NATPacketParsing
-  * Decodes Packet_In messages for packet header information (L2, L3 & L4 information)
-. NATInventoryUtility
-  * Decodes Packet_In messages for OpenFlow Switch and Port information 
-. NATFlowBuilder
-  * Creates NAT flow rules at the OpenFlow Switch
-. NATYangStore
-  * Reads Global IP entered by user and maps local IP to Global IP information 
-. NATFlowHandler
-  * Manages expired flows in the switch and frees up used global IP address for future natting. 
-
-=== Key APIs and Interfaces
-. RPC APIs
-* Static - Configure Static Natting Functionality
-* Dynamic - Configure Static Dynamic Functionality
-* PAT - Configure PAT Functionality
-. DataStore APIs
-* StaticNatIp - Configure floating IP addresses for Static Natting
-* StaticIpMapInfo - Mapped Information between floating and private IP addresses in Static Natting
-* DynamicNatIp - Configure floating IP addresses for Dynamic Natting
-* DynamicIpMapInfo - Mapped Information between floating and private IP addresses in Dynamic Natting
-* PatIp - Configure floating IP addresses for Port Address Translation
-* PatIpMapInfo - Mapped Information between TCP Port numbers of floating IP and private IP addresses
-. Notification APIs
-* DynamicIPExhaustion - Exhaustion of Dynamic Global IP Addresses
-* PatOverConnection - More than 10 TCP or UDP connections from one private IP address
+This content has been migrated to: http://docs.opendaylight.org/en/stable-boron/developer-guide/natapp-developer-guide.html