From 3edc384ac6cbeb68d36dbb4a51aa027c3bd3257d Mon Sep 17 00:00:00 2001
From: Michal Cmarada <michal.cmarada@pantheon.tech>
Date: Fri, 15 Jun 2018 13:09:56 +0200
Subject: HC2VPP-288 - add SRv6 module (writers only)

Changes:
- add new module for SRv6
- add models for SRv6 configuration:
  from https://datatracker.ietf.org/doc/draft-raza-spring-srv6-yang/
   - hc2vpp-ietf-srv6-base@2018-03-01.yang
   - hc2vpp-ietf-srv6-static@2018-03-01.yang
   - ietf-srv6-types@2018-03-01.yang
- implements Configuration of local sids and their end functions.
- implements support for FIB table management (HC2VPP-345)

Models hc2vpp-ietf-srv6-base and hc2vpp-ietf-srv6-static
are changed (HC2VPP-332):
 - imports for routing models (HC2VPP-298)
 - presence in end function containers was added to fix
   mandatory child verification if parent container is not present

Change-Id: Ib74e48023b671383f076b84773e26ce7c5ae282a
Signed-off-by: Michal Cmarada <michal.cmarada@pantheon.tech>
Signed-off-by: Jan Srnicek <jan.srnicek@pantheon.tech>
---
 srv6/srv6-impl/asciidoc/Readme.adoc | 43 +++++++++++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)
 create mode 100644 srv6/srv6-impl/asciidoc/Readme.adoc

(limited to 'srv6/srv6-impl/asciidoc/Readme.adoc')

diff --git a/srv6/srv6-impl/asciidoc/Readme.adoc b/srv6/srv6-impl/asciidoc/Readme.adoc
new file mode 100644
index 000000000..73b6f1b82
--- /dev/null
+++ b/srv6/srv6-impl/asciidoc/Readme.adoc
@@ -0,0 +1,43 @@
+= srv6-impl
+
+== Implemented features:
+
+- locator read,write and delete requests and customizers,
+  based on augmentation of routing model in: +
+  `hc2vpp-ietf-routing:routing/hc2vpp-ietf-srv6-base:srv6/locators/locator`
+- local sid read,write and delete requests and customizers,
+  based on augmentation of routing model in: +
+  `hc2vpp-ietf-routing:routing/hc2vpp-ietf-srv6-base:srv6/locators/locator/static/local-sids/sid/`
+- encapsulation source write and delete requests and customizers,
+  based on augmentation of routing model in: +
+  `hc2vpp-ietf-routing:routing/hc2vpp-ietf-srv6-base:srv6/hc2vpp-ietf-srv6-base:encapsulation`
+
+== VPP mapping
+
+- local sid and locator configuration maps to *sr_localsid_add_del* in VPP API:
+  *IPv6 SR LocalSID add/del params:* +
+      *is_del* Boolean of whether its a delete instruction +
+      *localsid_addr* IPv6 address of the localsid +
+      *end_psp* Boolean of whether decapsulation is allowed in this function +
+      *behavior* Type of behavior (function) for this localsid +
+      *sw_if_index* Only for L2/L3 xconnect. OIF. In VRF variant the fib_table. +
+      *vlan_index* Only for L2 xconnect. Outgoing VLAN tag. +
+      *fib_table*  FIB table in which we should install the localsid entry +
+      *nh_addr6* Next Hop IPv6 address. Only for L2/L3 xconnect. +
+      *nh_addr4* Next Hop IPv6 address. Only for L2/L3 xconnect. +
+- encapsulation source maps to *sr_set_encap_source* in VPP API: +
+  *IPv6 SR Set SRv6 encapsulation source params:* +
+      *bsid* is the bindingSID of the SR Policy +
+      *index* is the index of the SR policy
+
+
+== Supported End function configurations:
+
+- *END* (VPP behavior type 1)
+- *END X* (VPP behavior type 2)
+- *END DX2* (VPP behavior type 5)
+- *END DX4* (VPP behavior type 7)
+- *END DX6* (VPP behavior type 6)
+- *END T* (VPP behavior type 3)
+- *END DT4* (VPP behavior type 9)
+- *END DT6* (VPP behavior type 8)
-- 
cgit 1.2.3-korg

