From 8174f0ada87d3845705b245071d22054f6a8b17b Mon Sep 17 00:00:00 2001
From: Felix Huettner <felix.huettner@stackit.cloud>
Date: Tue, 10 Dec 2024 14:36:30 +0100
Subject: [PATCH] ovn-sb: Introduce Advertised_ and Learned_Route.

These two tables will be used in the future to coordinate routing
information between northd and ovn-controller.
Northd will insert routes that should be advertised to the outside
fabric to Advertised_Route.
Ovn-controller will insert routes that have been learned from the
outside fabric to Learned_Route.

Signed-off-by: Felix Huettner <felix.huettner@stackit.cloud>
Signed-off-by: Dumitru Ceara <dceara@redhat.com>
---
 ovn-sb.ovsschema | 38 ++++++++++++++++++++++++--
 ovn-sb.xml       | 70 ++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 106 insertions(+), 2 deletions(-)

diff --git a/ovn-sb.ovsschema b/ovn-sb.ovsschema
index 73abf2c8dc..61bc264579 100644
--- a/ovn-sb.ovsschema
+++ b/ovn-sb.ovsschema
@@ -1,7 +1,7 @@
 {
     "name": "OVN_Southbound",
-    "version": "20.37.0",
-    "cksum": "1950136776 31493",
+    "version": "20.38.0",
+    "cksum": "2175279464 33450",
     "tables": {
         "SB_Global": {
             "columns": {
@@ -617,6 +617,40 @@
                     "type": {"key": "string", "value": "string",
                              "min": 0, "max": "unlimited"}}},
             "indexes": [["chassis"]],
+            "isRoot": true},
+        "Advertised_Route": {
+            "columns": {
+                "datapath": {"type": {"key": {"type": "uuid",
+                                              "refTable": "Datapath_Binding",
+                                              "refType": "strong"}}},
+                "logical_port": {"type": {"key": {"type": "uuid",
+                                                  "refTable": "Port_Binding",
+                                                  "refType": "strong"}}},
+                "ip_prefix": {"type": "string"},
+                "tracked_port": {"type": {"key": {"type": "uuid",
+                                                  "refTable": "Port_Binding",
+                                                  "refType": "strong"},
+                                          "min": 0,
+                                          "max": 1}},
+                "external_ids": {
+                    "type": {"key": "string", "value": "string",
+                             "min": 0, "max": "unlimited"}}},
+            "indexes": [["datapath", "logical_port", "ip_prefix"]],
+            "isRoot": true},
+        "Learned_Route": {
+            "columns": {
+                "datapath": {"type": {"key": {"type": "uuid",
+                                              "refTable": "Datapath_Binding",
+                                              "refType": "strong"}}},
+                "logical_port": {"type": {"key": {"type": "uuid",
+                                                  "refTable": "Port_Binding",
+                                                  "refType": "strong"}}},
+                "ip_prefix": {"type": "string"},
+                "nexthop": {"type": "string"},
+                "external_ids": {
+                    "type": {"key": "string", "value": "string",
+                             "min": 0, "max": "unlimited"}}},
+            "indexes": [["datapath", "logical_port", "ip_prefix", "nexthop"]],
             "isRoot": true}
     }
 }
diff --git a/ovn-sb.xml b/ovn-sb.xml
index 9394bb5f43..3919b44e3a 100644
--- a/ovn-sb.xml
+++ b/ovn-sb.xml
@@ -5218,4 +5218,74 @@ tcp.flags = RST;
       The set of variable values for a given chassis.
     </column>
   </table>
+
+  <table name="Advertised_Route">
+    <p>
+      Each record represents a route that should be exported from ovn to the
+      outside network fabric.
+      It is populated by <code>ovn-northd</code> based on the addresses,
+      routes and NAT Entries of a
+      <code>OVN_Northbound.Logical_Router_Port</code>.
+    </p>
+
+    <column name="datapath">
+      The datapath belonging to the
+      <code>OVN_Northbound.Logical_Router</code> that this route is valid
+      for.
+    </column>
+
+    <column name="logical_port">
+      This is the <ref table="Port_Binding"/> that the router will send packets
+      out that are received for the below prefix.
+    </column>
+
+    <column name="ip_prefix">
+      IP prefix of this route (e.g. 192.168.100.0/24).
+    </column>
+
+    <column name="tracked_port">
+      In combination with a host <code>ip_prefix</code> this tracks the port
+      OVN will forward the packets for this destination to.
+      If set the <ref table="Advertised_Route" column="ip_prefix"/> will always
+      contain a /32 (for ipv4) or /128 (for ipv6) prefix.
+
+      An announcing chassis can use this information to check if this
+      destination is local and adjust the route priorities based on that.
+    </column>
+
+    <column name="external_ids">
+      See <em>External IDs</em> at the beginning of this document.
+    </column>
+  </table>
+
+  <table name="Learned_Route">
+    <p>
+      Each record represents a route that learned by ovn using some dynamic
+      routing logic outside of ovn.
+      It is populated by <code>ovn-controller</code> with routes it learns
+      locally.
+    </p>
+
+    <column name="datapath">
+      The datapath belonging to the
+      <code>OVN_Northbound.Logical_Router</code> that this route is valid
+      for.
+    </column>
+
+    <column name="logical_port">
+      This is the <ref table="Port_Binding"/> that the route was learned on.
+    </column>
+
+    <column name="ip_prefix">
+      IP prefix of this route (e.g. 192.168.100.0/24).
+    </column>
+
+    <column name="nexthop">
+      This is the nexthop ip we learned from outside of OVN.
+    </column>
+
+    <column name="external_ids">
+      See <em>External IDs</em> at the beginning of this document.
+    </column>
+  </table>
 </database>