summaryrefslogtreecommitdiffstats
path: root/infra/bgp-translate-api/asciidoc/Readme.adoc
diff options
context:
space:
mode:
Diffstat (limited to 'infra/bgp-translate-api/asciidoc/Readme.adoc')
-rw-r--r--infra/bgp-translate-api/asciidoc/Readme.adoc11
1 files changed, 11 insertions, 0 deletions
diff --git a/infra/bgp-translate-api/asciidoc/Readme.adoc b/infra/bgp-translate-api/asciidoc/Readme.adoc
new file mode 100644
index 000000000..29a8e3275
--- /dev/null
+++ b/infra/bgp-translate-api/asciidoc/Readme.adoc
@@ -0,0 +1,11 @@
+= bgp-translate-api
+
+API for translation between Binding Aware representation of BGP routes and actual device data.
+Consists of writers responsible for RIB to FIB translation.
+
+Provides registry of writers for the data layer.
+For every supported route type (e.g. ipv4, ipv6, labeled-unicast, etc.),
+there should be at least one writer registered.
+
+BGP routes are based on bgp-rib model, provided by
+https://wiki.opendaylight.org/view/BGP_LS_PCEP:Main[ODL's BGP]. \ No newline at end of file