Introduce refactored aft summary model (#997)

* add refactored aft summary model
openconfig · Nov 21, 2023 · 4d31358 · 4d31358
1 parent 48d0a7d
commit 4d31358
Show file tree

Hide file tree

Showing 3 changed files with 129 additions and 4 deletions.
diff --git a/release/models/aft/.spec.yml b/release/models/aft/.spec.yml
@@ -2,7 +2,9 @@
   docs:
     - yang/aft/openconfig-aft.yang
     - yang/aft/openconfig-aft-types.yang
+    - yang/aft/openconfig-aft-summary.yang
   build:
     - yang/network-instance/openconfig-network-instance.yang
     - yang/aft/openconfig-aft-network-instance.yang
+    - yang/aft/openconfig-aft-summary.yang
   run-ci: true
diff --git a/release/models/aft/openconfig-aft-summary.yang b/release/models/aft/openconfig-aft-summary.yang
@@ -0,0 +1,120 @@
+module openconfig-aft-summary {
+  yang-version "1";
+
+  namespace "http://openconfig.net/yang/aft-summary";
+
+  prefix "oc-aftsummary";
+
+  import openconfig-extensions { prefix "oc-ext"; }
+  import openconfig-yang-types { prefix "oc-yang-types"; }
+  import openconfig-policy-types { prefix "oc-pol-types"; }
+  import openconfig-network-instance { prefix "oc-ni"; }
+
+  organization
+    "OpenConfig working group";
+
+  contact
+    "OpenConfig working group
+    www.openconfig.net";
+
+  description
+    "This module provides summary of aft entry counts per protocol type for each network
+    instance.";
+
+  oc-ext:openconfig-version "0.1.0";
+
+  revision "2023-11-09" {
+    description
+      "Initial version.";
+    reference "0.1.0";
+  }
+
+  grouping protocols-state {
+    description
+      "Grouping for protocol type state.";
+
+    leaf origin-protocol {
+      description
+        "Protocol type that keys the protocol list.";
+
+      type identityref {
+        base "oc-pol-types:INSTALL_PROTOCOL_TYPE";
+      }
+    }
+
+    container counters {
+      description
+      "Enclosing container for aft entry counters";
+
+      leaf aft-entries {
+        description
+          "Total number of entries in the aft.";
+        type oc-yang-types:counter64;
+      }
+    }
+  }
+
+  grouping aft-summary {
+    description
+      "A summary of aft entries by protocol type.";
+
+    container protocols {
+      description
+        "Enclosing container for a list of protocols";
+      list protocol {
+        key "origin-protocol";
+
+        description
+          "Protocol type that keys the aft entry count list.";
+
+        leaf origin-protocol {
+          type leafref {
+            path "../state/origin-protocol";
+          }
+          description
+            "Reference to the protocol type which added the aft entry.";
+        }
+
+        container state {
+          description
+            "State parameters for the aft entry list.";
+          uses protocols-state;
+        }
+      }
+    }
+  }
+
+  grouping aft-summary-ipv4 {
+    description
+      "Grouping of all aft summaries for ipv4.";
+      container ipv4-unicast {
+        description
+          "Container for ipv4 unicast aft summary by protocol type.";
+        uses aft-summary;
+      }
+  }
+
+  grouping aft-summary-ipv6 {
+    description
+      "Grouping of all aft summaries for ipv6.";
+      container ipv6-unicast {
+        description
+          "Container for ipv6 aft counts by protocol type.";
+        uses aft-summary;
+      }
+  }
+
+  augment "/oc-ni:network-instances/oc-ni:network-instance/oc-ni:afts" {
+    description
+      "Augment the afts model with the aft summary container.";
+
+    container aft-summaries {
+      uses aft-summary-ipv4;
+      uses aft-summary-ipv6;
+
+      description
+        "Aft summary for the network instance.";
+    }
+  }
+
+}
diff --git a/release/models/network-instance/.spec.yml b/release/models/network-instance/.spec.yml
@@ -1,18 +1,21 @@
 - name: openconfig-network-instance
   docs:
-    - yang/network-instance/openconfig-network-instance-types.yang
-    - yang/network-instance/openconfig-network-instance.yang
+    - yang/aft/openconfig-aft-network-instance.yang
+    - yang/aft/openconfig-aft-summary.yang
     - yang/network-instance/openconfig-evpn-types.yang
     - yang/network-instance/openconfig-evpn.yang
+    - yang/network-instance/openconfig-network-instance-types.yang
+    - yang/network-instance/openconfig-network-instance.yang
     - yang/network-instance/openconfig-programming-errors.yang
-    - yang/aft/openconfig-aft-network-instance.yang
     - yang/segment-routing/openconfig-rsvp-sr-ext.yang
     - yang/segment-routing/openconfig-segment-routing.yang
     - yang/rib/openconfig-rib-bgp-ext.yang
+
   build:
+    - yang/aft/openconfig-aft-network-instance.yang
+    - yang/aft/openconfig-aft-summary.yang
     - yang/network-instance/openconfig-network-instance.yang
     - yang/network-instance/openconfig-programming-errors.yang
-    - yang/aft/openconfig-aft-network-instance.yang
     - yang/segment-routing/openconfig-rsvp-sr-ext.yang
   run-ci: true
 - name: openconfig-network-instance-bgp-rib-augment