SRv6 dynamic proxy plugin

Change-Id: Ie460005510b8a70d00de31b6651e762cc3a63229
Signed-off-by: Francois Clad <fclad@cisco.com>

1 files changed, 23 insertions, 0 deletions

diff --git a/src/plugins/srv6-ad/ad_plugin_doc.md b/src/plugins/srv6-ad/ad_plugin_doc.md
new file mode 100644
index 00000000000..fc8ebfe352f
--- /dev/null
+++ b/src/plugins/srv6-ad/ad_plugin_doc.md
@@ -0,0 +1,23 @@
+# SRv6 endpoint to SR-unaware appliance via dynamic proxy (End.AD) {#srv6_ad_plugin_doc}
+
+## Overview
+
+The "Endpoint to SR-unaware appliance via dynamic proxy" (End.AD) is a two-parts
+proxy function for processing SRv6 encapsulated traffic on behalf of an
+SR-unaware appliance. The first part decapsulates the incoming traffic and sends
+it towards an appliance on a specific interface, while the second
+re-encapsulates the traffic coming back from the appliance.
+
+In this scenario, there are no restrictions on the operations that can be
+performed by the appliance on the stream of packets. It may operate at all
+protocol layers, terminate transport layer connections, generate new packets and
+initiate transport layer connections. This function may also be used to
+integrate an IPv4-only appliance into an SRv6 policy.
+
+The End.AD function relies on a local caching mechanism to learn and
+re-encapsulate the traffic with the same headers that were removed. 
+This cache is used to store the IPv6 header and its
+extension headers while the appliance processes the inner packet. In the
+following, we refer to an entry in this cache as C(type,iface), where type is
+either IPv4 or IPv6 and iface is the receiving interface on the SRv6 proxy
+(IFACE-IN).