Update metadata of hc2vpp YANG models 08/11308/4
authorMarek Gradzki <[email protected]>
Thu, 22 Mar 2018 13:55:10 +0000 (14:55 +0100)
committerMarek Gradzki <[email protected]>
Tue, 3 Apr 2018 11:39:28 +0000 (13:39 +0200)
Adds organization and contact statements.
Includes copyright in the description of modules.
Fixes minor formatting issues.

Change-Id: I9fa90c24e956d5cb2c3fde8621ed289f383501ac
Signed-off-by: Marek Gradzki <[email protected]>
32 files changed:
acl/acl-api/src/main/yang/[email protected]
acl/acl-api/src/main/yang/[email protected]
acl/acl-api/src/main/yang/[email protected]
dhcp/dhcp-api/src/main/yang/[email protected]
interface-role/api/src/main/yang/[email protected]
l3/api/src/main/yang/[email protected]
l3/api/src/main/yang/[email protected]
nat/nat-api/src/main/yang/[email protected]
nat/nat-api/src/main/yang/[email protected]
nat/nat-api/src/main/yang/[email protected]
nat/nat-api/src/main/yang/[email protected]
routing/routing-api/src/main/yang/[email protected]
routing/routing-api/src/main/yang/[email protected]
routing/routing-api/src/main/yang/[email protected]
samples/samples-api/src/main/yang/[email protected]
v3po/api/src/main/yang/[email protected]
v3po/api/src/main/yang/[email protected]
v3po/api/src/main/yang/[email protected]
v3po/api/src/main/yang/[email protected]
v3po/api/src/main/yang/[email protected]
v3po/api/src/main/yang/[email protected]
v3po/api/src/main/yang/[email protected]
vpp-classifier/api/src/main/yang/[email protected]
vpp-classifier/api/src/main/yang/[email protected]
vpp-classifier/api/src/main/yang/[email protected]
vpp-classifier/api/src/main/yang/[email protected]
vpp-classifier/api/src/main/yang/[email protected]
vpp-classifier/api/src/main/yang/[email protected]
vpp-classifier/api/src/main/yang/[email protected]
vpp-common/naming-context-api/src/main/yang/[email protected]
vpp-common/naming-context-api/src/main/yang/[email protected]
vpp-management/api/src/main/yang/[email protected]

index a54e3d8..f051830 100644 (file)
@@ -23,7 +23,9 @@ module interface-acl {
      Mailing List <[email protected]>";
 
   description
-    "Provides augmentations to ietf-interfaces model for assigning ACLs via ACL plugin of VPP.
+    "This module contains a collection of YANG definitions for
+     applying ACLs on VPP interfaces.
+     Uses ACL implementation provided by ACL plugin of VPP.
 
      Copyright (c) 2016 Cisco and/or its affiliates.
 
@@ -43,7 +45,7 @@ module interface-acl {
     description "Initial revision of interface-acl model";
   }
 
-  grouping vpp-acls-base-attributes  {
+  grouping vpp-acls-base-attributes {
     description
       "List of ACLs of vpp-acl type"; // TODO(HC2VPP-201): express constraint in the model if possible
     list vpp-acls {
@@ -61,7 +63,7 @@ module interface-acl {
     }
   }
 
-  grouping vpp-macip-acls-base-attributes  {
+  grouping vpp-macip-acls-base-attributes {
     container vpp-macip-acl {
       description
         "ACL of vpp-macip-acl type"; // TODO(HC2VPP-201): express constraint in the model if possible
index f965f6e..016883e 100644 (file)
@@ -19,8 +19,12 @@ module vpp-acl-context {
          Mailing List <[email protected]>";
 
     description
-        "Provides mapping between YANG identifiers (names)
-         and identifiers used by VPP ACL plugin.
+        "This module provides mapping between ACL identifiers
+         defined in the ietf-access-control-list module
+         and identifiers used by the VPP ACL plugin.
+
+         The mapping is managed internally by the HC ACL plugin.
+         It is exposed as operational state data for debugging purposes.
 
          Copyright (c) 2017 Cisco and/or its affiliates.
 
index dffab79..f681724 100644 (file)
@@ -31,7 +31,9 @@ module vpp-acl {
      Mailing List <[email protected]>";
 
   description
-    "Provides augmentations to ietf-access-control-list exposing VPP specific features of the VPP ACL plugin.
+    "This module contains a collection of YANG definitions
+     that extend ietf-access-control-list module
+     with VPP specific features provided by the VPP ACL plugin.
 
      Copyright (c) 2016 Cisco and/or its affiliates.
 
index a813dde..8ce48ed 100644 (file)
@@ -15,8 +15,8 @@ module dhcp {
          Mailing List <[email protected]>";
 
     description
-        "This YANG module defines the generic configuration and
-        operational data for dhcp in VPP
+        "This module contains a collection of YANG definitions for
+         managing DHCP in VPP.
 
          Copyright (c) 2017-2018 Cisco and/or its affiliates.
 
index 215213d..8bcd741 100644 (file)
@@ -20,8 +20,10 @@ module interface-role {
      Mailing List <[email protected]>";
 
   description
-    "Provides interface roles - additional metadata that can be assigned to interfaces.
-     Interface roles are visible in config DS, but not translated to VPP calls.
+    "This module contains a collection of YANG definitions for
+     assigning roles to VPP interfaces.
+     Interface roles provide additional metadata visible in config DS,
+     but not translated to VPP API calls.
 
      Copyright (c) 2017-2018 Cisco and/or its affiliates.
 
index 8903f91..d4da1fa 100644 (file)
@@ -24,7 +24,8 @@ module nd-proxy {
          Mailing List <[email protected]>";
 
     description
-        "Neighbour discovery proxy model for VPP.
+        "This module contains a collection of YANG definitions for
+         managing neighbour discovery proxies in VPP.
 
          Copyright (c) 2017 Cisco and/or its affiliates.
 
@@ -44,7 +45,7 @@ module nd-proxy {
         description "Initial revision of neighbour discovery proxy model for VPP";
     }
 
-    augment /if:interfaces/if:interface/ip:ipv6  {
+    augment /if:interfaces/if:interface/ip:ipv6 {
         ext:augment-identifier "nd-proxy-ip6-augmentation";
         container nd-proxies {
             list nd-proxy {
@@ -66,5 +67,5 @@ module nd-proxy {
                 }
             }
         }
-  }
+    }
 }
\ No newline at end of file
index fb0f5e1..3fa1595 100644 (file)
@@ -21,7 +21,8 @@ module proxy-arp {
      Mailing List <[email protected]>";
 
   description
-    "Proxy ARP model for VPP.
+    "This module contains a collection of YANG definitions for
+     managing Proxy ARP in VPP.
 
      Copyright (c) 2017 Cisco and/or its affiliates.
 
index d8791c3..c4e2554 100644 (file)
@@ -10,7 +10,30 @@ module interface-nat {
     prefix "ext";
   }
 
-  description "Augmentations to interfaces model to connect interfaces with nat configuration.";
+  organization
+    "FD.io - The Fast Data Project";
+
+  contact
+    "Hc2vpp Wiki <https://wiki.fd.io/view/Hc2vpp>
+     Mailing List <[email protected]>";
+
+  description
+    "This module contains a collection of YANG definitions for
+     applying NAT configuration on VPP interfaces.
+
+     Copyright (c) 2016-2018 Cisco and/or its affiliates.
+
+     Licensed under the Apache License, Version 2.0 (the 'License');
+     you may not use this file except in compliance with the License.
+     You may obtain a copy of the License at:
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+     Unless required by applicable law or agreed to in writing, software
+     distributed under the License is distributed on an 'AS IS' BASIS,
+     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+     See the License for the specific language governing permissions and
+     limitations under the License.";
 
   revision "2017-08-16" {
     description "Added support for NAT64.";
index cb8bb83..3f5393c 100644 (file)
@@ -15,7 +15,34 @@ module nat-context {
        prefix "ext";
     }
 
-    description "Context for nat mapping";
+    organization
+        "FD.io - The Fast Data Project";
+
+    contact
+        "Hc2vpp Wiki <https://wiki.fd.io/view/Hc2vpp>
+         Mailing List <[email protected]>";
+
+    description
+        "This module provides mapping between NAT identifiers
+         defined in the ietf-nat module
+         and identifiers used by the VPP NAT plugin.
+
+         The mapping is managed internally by the HC NAT plugin.
+         It is exposed as operational state data for debugging purposes.
+
+         Copyright (c) 2016-2018 Cisco and/or its affiliates.
+
+         Licensed under the Apache License, Version 2.0 (the 'License');
+         you may not use this file except in compliance with the License.
+         You may obtain a copy of the License at:
+
+         http://www.apache.org/licenses/LICENSE-2.0
+
+         Unless required by applicable law or agreed to in writing, software
+         distributed under the License is distributed on an 'AS IS' BASIS,
+         WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+         See the License for the specific language governing permissions and
+         limitations under the License.";
 
     revision "2016-12-14" {
         description "Initial revision.";
index 0de8afc..02515c5 100644 (file)
@@ -16,13 +16,36 @@ module subinterface-nat {
     prefix "ext";
   }
 
-  description "Augmentations to subinterfaces model to connect subinterfaces with nat configuration";
+  organization
+    "FD.io - The Fast Data Project";
+
+  contact
+    "Hc2vpp Wiki <https://wiki.fd.io/view/Hc2vpp>
+     Mailing List <[email protected]>";
+
+  description
+    "This module contains a collection of YANG definitions for
+     applying NAT configuration on VPP subinterfaces.
+
+     Copyright (c) 2017-2018 Cisco and/or its affiliates.
+
+     Licensed under the Apache License, Version 2.0 (the 'License');
+     you may not use this file except in compliance with the License.
+     You may obtain a copy of the License at:
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+     Unless required by applicable law or agreed to in writing, software
+     distributed under the License is distributed on an 'AS IS' BASIS,
+     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+     See the License for the specific language governing permissions and
+     limitations under the License.";
 
   revision "2017-06-15" {
     description "Initial revision of subinterface-nat model";
   }
 
-  augment  /if:interfaces/if:interface/vpp-vlan:sub-interfaces/vpp-vlan:sub-interface {
+  augment /if:interfaces/if:interface/vpp-vlan:sub-interfaces/vpp-vlan:sub-interface {
     ext:augment-identifier "nat-subinterface-augmentation";
 
     uses ifc-nat:interface-nat-attributes;
index b0f7ea3..7f28638 100644 (file)
@@ -10,7 +10,30 @@ module vpp-nat {
     prefix "ext";
   }
 
-  description "Augmentations to ietf-nat model providing vpp specific attributes.";
+  organization
+    "FD.io - The Fast Data Project";
+
+  contact
+    "Hc2vpp Wiki <https://wiki.fd.io/view/Hc2vpp>
+     Mailing List <[email protected]>";
+
+  description
+    "This module contains a collection of YANG definitions that extend ietf-nat module
+     with VPP specific features provided by the VPP NAT plugin.
+
+     Copyright (c) 2017-2018 Cisco and/or its affiliates.
+
+     Licensed under the Apache License, Version 2.0 (the 'License');
+     you may not use this file except in compliance with the License.
+     You may obtain a copy of the License at:
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+     Unless required by applicable law or agreed to in writing, software
+     distributed under the License is distributed on an 'AS IS' BASIS,
+     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+     See the License for the specific language governing permissions and
+     limitations under the License.";
 
   revision "2017-08-04" {
     description "Initial revision of vpp-nat model.";
index 342fbc0..4b3de5f 100644 (file)
@@ -15,7 +15,31 @@ module vpp-routing-ra {
         prefix "v6ur";
     }
 
-    description "General extensions for routing advertisments message configuration provided by VPP APIs";
+    organization
+        "FD.io - The Fast Data Project";
+
+    contact
+        "Hc2vpp Wiki <https://wiki.fd.io/view/Hc2vpp>
+         Mailing List <[email protected]>";
+
+    description
+        "This module contains a collection of YANG definitions
+         that extend hc2vpp-ietf-routing module
+         with VPP specific routing advertisments features.
+
+         Copyright (c) 2017-2018 Cisco and/or its affiliates.
+
+         Licensed under the Apache License, Version 2.0 (the 'License');
+         you may not use this file except in compliance with the License.
+         You may obtain a copy of the License at:
+
+         http://www.apache.org/licenses/LICENSE-2.0
+
+         Unless required by applicable law or agreed to in writing, software
+         distributed under the License is distributed on an 'AS IS' BASIS,
+         WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+         See the License for the specific language governing permissions and
+         limitations under the License.";
 
     revision 2017-05-02 {
         description "Changed namespace";
index aaef97b..997fbee 100644 (file)
@@ -7,14 +7,37 @@ module vpp-routing-table-lookup {
         prefix "vpp-r";
     }
 
-    description "General extensions for routes to be able to use VPP table lookup option";
+    organization
+        "FD.io - The Fast Data Project";
+
+    contact
+        "Hc2vpp Wiki <https://wiki.fd.io/view/Hc2vpp>
+         Mailing List <[email protected]>";
+
+    description
+        "This module extends hc2vpp-ietf-routing module
+         with VPP table lookup option.
+
+         Copyright (c) 2017-2018 Cisco and/or its affiliates.
+
+         Licensed under the Apache License, Version 2.0 (the 'License');
+         you may not use this file except in compliance with the License.
+         You may obtain a copy of the License at:
+
+         http://www.apache.org/licenses/LICENSE-2.0
+
+         Unless required by applicable law or agreed to in writing, software
+         distributed under the License is distributed on an 'AS IS' BASIS,
+         WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+         See the License for the specific language governing permissions and
+         limitations under the License.";
 
     revision 2017-09-17 {
         description "Initial revision";
     }
 
     grouping table-lookup-case-params {
-        leaf secondary-vrf{
+        leaf secondary-vrf {
            type vpp-r:vni-reference;
            mandatory true;
            description "Secondary vrf used to lookup in";
index 807d6aa..dced18f 100644 (file)
@@ -1,4 +1,4 @@
-module vpp-routing{
+module vpp-routing {
 
     namespace "urn:ietf:params:xml:ns:yang:vpp-routing";
     prefix "vpp-routing";
@@ -15,7 +15,31 @@ module vpp-routing{
         prefix "ietf-r";
     }
 
-    description "General extensions for routes to be able to use VPP route defining apis";
+    organization
+        "FD.io - The Fast Data Project";
+
+    contact
+        "Hc2vpp Wiki <https://wiki.fd.io/view/Hc2vpp>
+         Mailing List <[email protected]>";
+
+    description
+        "This module contains a collection of YANG definitions
+         that extend hc2vpp-ietf-routing module
+         with VPP specific routing features.
+
+         Copyright (c) 2016-2018 Cisco and/or its affiliates.
+
+         Licensed under the Apache License, Version 2.0 (the 'License');
+         you may not use this file except in compliance with the License.
+         You may obtain a copy of the License at:
+
+         http://www.apache.org/licenses/LICENSE-2.0
+
+         Unless required by applicable law or agreed to in writing, software
+         distributed under the License is distributed on an 'AS IS' BASIS,
+         WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+         See the License for the specific language governing permissions and
+         limitations under the License.";
 
     revision 2017-09-17 {
         description "Support for table lookup option moved to separate model.";
index 5704b32..58050f0 100644 (file)
@@ -8,6 +8,30 @@ module sample-plugin {
         prefix "inet";
     }
 
+    organization
+        "FD.io - The Fast Data Project";
+
+    contact
+        "Hc2vpp Wiki <https://wiki.fd.io/view/Hc2vpp>
+         Mailing List <[email protected]>";
+
+    description
+        "Sample model for demonstration of transation code.
+
+         Copyright (c) 2016-2018 Cisco and/or its affiliates.
+
+         Licensed under the Apache License, Version 2.0 (the 'License');
+         you may not use this file except in compliance with the License.
+         You may obtain a copy of the License at:
+
+         http://www.apache.org/licenses/LICENSE-2.0
+
+         Unless required by applicable law or agreed to in writing, software
+         distributed under the License is distributed on an 'AS IS' BASIS,
+         WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+         See the License for the specific language governing permissions and
+         limitations under the License.";
+
     revision 2016-12-14 {
         description "Sample model for demonstration of transation code";
     }
index cb9fbb1..047215e 100644 (file)
@@ -4,31 +4,53 @@ module pbb-types {
   prefix "pbb-types";
 
   import ietf-yang-types {
-      prefix yang;
+    prefix yang;
   }
 
-  description "Common types used for defining Pbb based subinterfaces";
+  organization
+    "FD.io - The Fast Data Project";
+
+  contact
+    "Hc2vpp Wiki <https://wiki.fd.io/view/Hc2vpp>
+     Mailing List <[email protected]>";
+
+  description
+    "This module contains a collection of YANG definitions
+     used for defining PBB based subinterfaces.
+
+     Copyright (c) 2016-2018 Cisco and/or its affiliates.
+
+     Licensed under the Apache License, Version 2.0 (the 'License');
+     you may not use this file except in compliance with the License.
+     You may obtain a copy of the License at:
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+     Unless required by applicable law or agreed to in writing, software
+     distributed under the License is distributed on an 'AS IS' BASIS,
+     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+     See the License for the specific language governing permissions and
+     limitations under the License.";
 
   revision "2016-12-14" {
-          description
-              "Initial revision.";
+    description
+      "Initial revision.";
   }
 
   typedef operation {
-      type enumeration {
-        // NOTE - Does not specify disabled enum value(0), because its used internally to delete/disable rewrite
-        enum "push-2" {
-            value 2;
-        }
-
-        enum "pop-2" {
-            value 4;
-            description "Encapsulate/Decapsulate pbb packet according to incoming/outcoming direction";
-        }
-        enum "translate-2-1" {
-            value 7;
+    type enumeration {
+      // NOTE - Does not specify disabled enum value(0), because its used internally to delete/disable rewrite
+      enum "push-2" {
+        value 2;
+      }
+      enum "pop-2" {
+        value 4;
+          description "Encapsulate/Decapsulate pbb packet according to incoming/outcoming direction";
         }
+      enum "translate-2-1" {
+        value 7;
       }
+    }
   }
 
   grouping pbb-rewrite-attributes {
@@ -45,29 +67,29 @@ module pbb-types {
     }
 
     leaf outer-tag {
-        type uint16;
+      type uint16;
     }
 
     leaf b-vlan-tag-vlan-id {
-        type uint16 {
-            //12 bit range
-            range "1..4095";
-        }
-        description "backbone vlan id";
+      type uint16 {
+        //12 bit range
+        range "1..4095";
+      }
+      description "backbone vlan id";
     }
 
     leaf i-tag-isid {
-        type uint32 {
-          //24 bit range
-          range "1..16777215";
-        }
-        description "identifier of the backbone service instance ";
+      type uint32 {
+        //24 bit range
+        range "1..16777215";
+      }
+      description "identifier of the backbone service instance ";
     }
 
     leaf interface-operation {
-        type operation;
-        default pop-2;
-        description "Define operation that will pbb interface perform while processing packets";
+      type operation;
+      default pop-2;
+      description "Define operation that will pbb interface perform while processing packets";
     }
   }
 }
index 22f8ee1..0141c1a 100644 (file)
@@ -19,6 +19,31 @@ module subinterface-span {
     prefix "v3po";
   }
 
+  organization
+    "FD.io - The Fast Data Project";
+
+  contact
+    "Hc2vpp Wiki <https://wiki.fd.io/view/Hc2vpp>
+     Mailing List <[email protected]>";
+
+  description
+    "This model contains a collection of YANG definitions for
+     span interface management in VPP.
+
+     Copyright (c) 2017-2018 Cisco and/or its affiliates.
+
+     Licensed under the Apache License, Version 2.0 (the 'License');
+     you may not use this file except in compliance with the License.
+     You may obtain a copy of the License at:
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+     Unless required by applicable law or agreed to in writing, software
+     distributed under the License is distributed on an 'AS IS' BASIS,
+     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+     See the License for the specific language governing permissions and
+     limitations under the License.";
+
   revision "2017-06-07" {
     description "Eliminated config leafrefs in operational tree";
   }
@@ -32,17 +57,16 @@ module subinterface-span {
   }
 
   augment /if:interfaces/if:interface/vpp-vlan:sub-interfaces/vpp-vlan:sub-interface {
-      ext:augment-identifier "vpp-subinterface-span-augmentation";
-
-      container span {
-        uses v3po:span-attributes;
-      }
+    ext:augment-identifier "vpp-subinterface-span-augmentation";
+    container span {
+      uses v3po:span-attributes;
+    }
   }
 
   augment /if:interfaces-state/if:interface/vpp-vlan:sub-interfaces/vpp-vlan:sub-interface {
-      ext:augment-identifier "vpp-subinterface-span-state-augmentation";
-      container span-state {
-        uses v3po:span-state-attributes;
-      }
+    ext:augment-identifier "vpp-subinterface-span-state-augmentation";
+    container span-state {
+      uses v3po:span-state-attributes;
+    }
   }
 }
\ No newline at end of file
index 515573e..babb959 100644 (file)
@@ -15,6 +15,31 @@ module unnumbered-interfaces {
     prefix "ext";
   }
 
+  organization
+    "FD.io - The Fast Data Project";
+
+  contact
+    "Hc2vpp Wiki <https://wiki.fd.io/view/Hc2vpp>
+     Mailing List <[email protected]>";
+
+  description
+    "This module contains a collection of YANG definitions
+     providing IP unnumbered feature for VPP interfaces and subinterfaces.
+
+     Copyright (c) 2017-2018 Cisco and/or its affiliates.
+
+     Licensed under the Apache License, Version 2.0 (the 'License');
+     you may not use this file except in compliance with the License.
+     You may obtain a copy of the License at:
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+     Unless required by applicable law or agreed to in writing, software
+     distributed under the License is distributed on an 'AS IS' BASIS,
+     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+     See the License for the specific language governing permissions and
+     limitations under the License.";
+
   revision "2018-01-03" {
     description
       "Use if:interface-ref for name of the interface which provides IP.";
index ae35be5..75ec8c1 100644 (file)
@@ -3,6 +3,30 @@ module v3po-context {
   namespace "urn:opendaylight:params:xml:ns:yang:v3po:context";
   prefix "v3po-ctx";
 
+  organization
+    "FD.io - The Fast Data Project";
+
+  contact
+    "Hc2vpp Wiki <https://wiki.fd.io/view/Hc2vpp>
+     Mailing List <[email protected]>";
+
+  description
+    "This module contains data definition for v3po module metadata.
+
+     Copyright (c) 2016-2018 Cisco and/or its affiliates.
+
+     Licensed under the Apache License, Version 2.0 (the 'License');
+     you may not use this file except in compliance with the License.
+     You may obtain a copy of the License at:
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+     Unless required by applicable law or agreed to in writing, software
+     distributed under the License is distributed on an 'AS IS' BASIS,
+     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+     See the License for the specific language governing permissions and
+     limitations under the License.";
+
   revision "2016-09-09" {
     description
     "Initial revision of v3po specific context";
index e05c804..abdf5b5 100644 (file)
@@ -19,6 +19,31 @@ module v3po {
     prefix "ext";
   }
 
+  organization
+    "FD.io - The Fast Data Project";
+
+  contact
+    "Hc2vpp Wiki <https://wiki.fd.io/view/Hc2vpp>
+     Mailing List <[email protected]>";
+
+  description
+    "This module contains a collection of YANG definitions
+     that extend ietf-interfaces module with VPP specific interface types.
+
+     Copyright (c) 2015-2018 Cisco and/or its affiliates.
+
+     Licensed under the Apache License, Version 2.0 (the 'License');
+     you may not use this file except in compliance with the License.
+     You may obtain a copy of the License at:
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+     Unless required by applicable law or agreed to in writing, software
+     distributed under the License is distributed on an 'AS IS' BASIS,
+     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+     See the License for the specific language governing permissions and
+     limitations under the License.";
+
   revision "2017-06-07" {
     description "Eliminated config leafrefs in operational tree";
   }
index 7301b86..36dd123 100644 (file)
@@ -15,20 +15,46 @@ module vpp-pbb {
     prefix "ext";
   }
 
+  organization
+    "FD.io - The Fast Data Project";
+
+  contact
+    "Hc2vpp Wiki <https://wiki.fd.io/view/Hc2vpp>
+     Mailing List <[email protected]>";
+
+  description
+    "This module contains a collection of YANG definitions
+     that extend ietf-interfaces module
+     with support for PBB based subinterfaces.
+
+     Copyright (c) 2016-2018 Cisco and/or its affiliates.
+
+     Licensed under the Apache License, Version 2.0 (the 'License');
+     you may not use this file except in compliance with the License.
+     You may obtain a copy of the License at:
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+     Unless required by applicable law or agreed to in writing, software
+     distributed under the License is distributed on an 'AS IS' BASIS,
+     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+     See the License for the specific language governing permissions and
+     limitations under the License.";
+
   revision "2016-12-14" {
     description "Initial revision of pbb model";
   }
 
   augment /if:interfaces/if:interface {
      ext:augment-identifier "pbb-rewrite-interface-augmentation";
-     container pbb-rewrite{
+     container pbb-rewrite {
         uses pbb-types:pbb-rewrite-attributes;
      }
   }
 
   augment /if:interfaces-state/if:interface {
       ext:augment-identifier "pbb-rewrite-state-interface-augmentation";
-      container pbb-rewrite-state{
+      container pbb-rewrite-state {
          uses pbb-types:pbb-rewrite-attributes;
          config false;
       }
index 53d657e..34425aa 100644 (file)
@@ -22,6 +22,31 @@ module vpp-vlan {
     prefix v3po;
   }
 
+  organization
+    "FD.io - The Fast Data Project";
+
+  contact
+    "Hc2vpp Wiki <https://wiki.fd.io/view/Hc2vpp>
+     Mailing List <[email protected]>";
+
+  description
+    "This module contains a collection of YANG definitions
+     for managing VPP VLANs.
+
+     Copyright (c) 2016-2018 Cisco and/or its affiliates.
+
+     Licensed under the Apache License, Version 2.0 (the 'License');
+     you may not use this file except in compliance with the License.
+     You may obtain a copy of the License at:
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+     Unless required by applicable law or agreed to in writing, software
+     distributed under the License is distributed on an 'AS IS' BASIS,
+     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+     See the License for the specific language governing permissions and
+     limitations under the License.";
+
   revision "2018-03-19" {
     description "Prefix invalid 802dot1q and 802dot1ad identifiers with underscore.";
   }
@@ -47,7 +72,7 @@ module vpp-vlan {
        - ingress/egress ACLs support";
   }
 
-  revision "2015-05-27" {
+  revision "2016-05-27" {
     description
     "Initial revision of vlan model for VPP.
      Reuses some concepts from draft-wilton-netmod-intf-vlan-yang-02 model.";
@@ -461,5 +486,4 @@ module vpp-vlan {
       }
     }
   }
-
 }
index fb4f8b0..8358c44 100644 (file)
@@ -16,11 +16,32 @@ module interface-policer {
         prefix "ext";
     }
 
+    organization
+        "FD.io - The Fast Data Project";
+
+    contact
+        "Hc2vpp Wiki <https://wiki.fd.io/view/Hc2vpp>
+         Mailing List <[email protected]>";
+
     description
         "This YANG module defines policer configuration and
-        operational data for interfaces in VPP.
-        Mapped to policer_classify_set_interface:
-        https://git.fd.io/vpp/tree/src/vnet/classify/classify.api#n119";
+         operational data for interfaces in VPP.
+         Mapped to policer_classify_set_interface:
+         https://git.fd.io/vpp/tree/src/vnet/classify/classify.api#n119.
+
+         Copyright (c) 2017-2018 Cisco and/or its affiliates.
+
+         Licensed under the Apache License, Version 2.0 (the 'License');
+         you may not use this file except in compliance with the License.
+         You may obtain a copy of the License at:
+
+         http://www.apache.org/licenses/LICENSE-2.0
+
+         Unless required by applicable law or agreed to in writing, software
+         distributed under the License is distributed on an 'AS IS' BASIS,
+         WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+         See the License for the specific language governing permissions and
+         limitations under the License.";
 
     revision "2017-03-15" {
         description "Initial revision of interface-policer model";
index fa2b8f0..52ed69b 100644 (file)
@@ -8,15 +8,39 @@ module policer {
       prefix inet;
     }
 
+    organization
+        "FD.io - The Fast Data Project";
+
+    contact
+        "Hc2vpp Wiki <https://wiki.fd.io/view/Hc2vpp>
+         Mailing List <[email protected]>";
+
     description
-        "VPP specific configuration of policer messages. Mapped to policer API:
+        "This module contains a collection of YANG definitions for
+         managing VPP policer.
+
+         Mapped to policer API:
          https://git.fd.io/vpp/tree/src/vnet/policer/policer.api
 
          Partially based on
-         https://tools.ietf.org/html/draft-asechoud-netmod-qos-model-02";
+         https://tools.ietf.org/html/draft-asechoud-netmod-qos-model-02.
+
+         Copyright (c) 2017-2018 Cisco and/or its affiliates.
+
+         Licensed under the Apache License, Version 2.0 (the 'License');
+         you may not use this file except in compliance with the License.
+         You may obtain a copy of the License at:
+
+         http://www.apache.org/licenses/LICENSE-2.0
+
+         Unless required by applicable law or agreed to in writing, software
+         distributed under the License is distributed on an 'AS IS' BASIS,
+         WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+         See the License for the specific language governing permissions and
+         limitations under the License.";
 
     reference
-        "https://docs.fd.io/vpp/17.04/clicmd_src_vnet_policer.html";
+        "https://docs.fd.io/vpp/18.04/clicmd_src_vnet_policer.html";
 
     revision "2017-03-15" {
         description "Initial revision of policer model";
index fe3007d..66d3b05 100644 (file)
@@ -7,6 +7,31 @@ module vpp-classifier-acl {
     prefix "vpp-classifier";
   }
 
+  organization
+    "FD.io - The Fast Data Project";
+
+  contact
+    "Hc2vpp Wiki <https://wiki.fd.io/view/Hc2vpp>
+     Mailing List <[email protected]>";
+
+  description
+    "This module contains a collection of YANG definitions for
+     managing classifier based ACLs in VPP.
+
+     Copyright (c) 2017-2018 Cisco and/or its affiliates.
+
+     Licensed under the Apache License, Version 2.0 (the 'License');
+     you may not use this file except in compliance with the License.
+     You may obtain a copy of the License at:
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+     Unless required by applicable law or agreed to in writing, software
+     distributed under the License is distributed on an 'AS IS' BASIS,
+     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+     See the License for the specific language governing permissions and
+     limitations under the License.";
+
   revision "2017-05-03" {
     description
       "Removed support for ietf based acls.";
@@ -52,13 +77,13 @@ module vpp-classifier-acl {
   }
 
   grouping vpp-acl-attributes {
-      container acl {
-        container ingress {
-          uses vpp-classifier-acl:acl-base-attributes;
-        }
-        container egress {
-          uses vpp-classifier-acl:acl-base-attributes;
-        }
+    container acl {
+      container ingress {
+        uses vpp-classifier-acl:acl-base-attributes;
       }
+      container egress {
+        uses vpp-classifier-acl:acl-base-attributes;
+      }
+    }
   }
 }
\ No newline at end of file
index 38f096c..26cc0a2 100644 (file)
@@ -3,8 +3,32 @@ module vpp-classifier-context {
   namespace "urn:opendaylight:params:xml:ns:yang:vpp:classifier:context";
   prefix "vpp-classifier-context";
 
+  organization
+    "FD.io - The Fast Data Project";
+
+  contact
+    "Hc2vpp Wiki <https://wiki.fd.io/view/Hc2vpp>
+     Mailing List <[email protected]>";
+
   description
-    "This module contains vpp classfier metadata definition";
+    "This module provides metadata required for vpp-classifier management.
+
+     Metadata are managed internally by the HC vpp-classifier plugin.
+     They are exposed as operational state data for debugging purposes.
+
+     Copyright (c) 2016-2018 Cisco and/or its affiliates.
+
+     Licensed under the Apache License, Version 2.0 (the 'License');
+     you may not use this file except in compliance with the License.
+     You may obtain a copy of the License at:
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+     Unless required by applicable law or agreed to in writing, software
+     distributed under the License is distributed on an 'AS IS' BASIS,
+     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+     See the License for the specific language governing permissions and
+     limitations under the License.";
 
   revision "2017-05-02" {
     description "Changed namespace";
@@ -26,8 +50,7 @@ module vpp-classifier-context {
        also finding base node that is needed to perform the conversion
        is not allways possible (https://jira.fd.io/browse/VPP-220).
 
-       Therefore Honeycomb needs to provide relative node to index mapping.
-       ";
+       Therefore Honeycomb needs to provide relative node to index mapping.";
 
     list classify-table-context {
       key "name";
index 5e3b876..1f3ce4e 100644 (file)
@@ -11,24 +11,49 @@ module vpp-classifier {
     prefix "policer";
   }
 
+  organization
+    "FD.io - The Fast Data Project";
+
+  contact
+    "Hc2vpp Wiki <https://wiki.fd.io/view/Hc2vpp>
+     Mailing List <[email protected]>";
+
+  description
+    "This module contains a collection of YANG definitions for
+     managing VPP packet classifier.
+
+     Copyright (c) 2016-2018 Cisco and/or its affiliates.
+
+     Licensed under the Apache License, Version 2.0 (the 'License');
+     you may not use this file except in compliance with the License.
+     You may obtain a copy of the License at:
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+     Unless required by applicable law or agreed to in writing, software
+     distributed under the License is distributed on an 'AS IS' BASIS,
+     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+     See the License for the specific language governing permissions and
+     limitations under the License.";
+
   revision "2017-03-27" {
     description
       "This revision updates classify table ref to be compatible with LeafRefContext
         (ODL tool for checking leafrefs in runtime)";
   }
 
-  revision "2016-12-14" {
+  revision "2017-03-15" {
     description
-      "This revision adds the following new features:
-        - updates order of union types for opaque-index";
+      "This revision adds policer support";
   }
 
-  revision "2016-03-15" {
+  revision "2016-12-14" {
     description
-      "This revision adds policer support";
+      "This revision adds the following new features:
+        - updates order of union types for opaque-index";
   }
 
-  revision "2015-06-03" {
+  revision "2016-06-03" {
     description
       "Initial revision of model for VPP packet classifier.
       The model can be used ony to implement ACLs.
@@ -244,5 +269,4 @@ module vpp-classifier {
       uses classify-table-operational-attributes;
     }
   }
-
 }
index f1fa66d..d2d77e2 100644 (file)
@@ -15,6 +15,32 @@ module vpp-interface-acl {
         prefix "ext";
     }
 
+    organization
+        "FD.io - The Fast Data Project";
+
+    contact
+        "Hc2vpp Wiki <https://wiki.fd.io/view/Hc2vpp>
+         Mailing List <[email protected]>";
+
+    description
+        "This module contains a collection of YANG definitions for
+         applying ACLs on VPP interfaces.
+         Uses ACL implementation based on VPP packet classifier.
+
+         Copyright (c) 2017-2018 Cisco and/or its affiliates.
+
+         Licensed under the Apache License, Version 2.0 (the 'License');
+         you may not use this file except in compliance with the License.
+         You may obtain a copy of the License at:
+
+         http://www.apache.org/licenses/LICENSE-2.0
+
+         Unless required by applicable law or agreed to in writing, software
+         distributed under the License is distributed on an 'AS IS' BASIS,
+         WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+         See the License for the specific language governing permissions and
+         limitations under the License.";
+
     revision "2017-03-15" {
         description
             "Initial revision of vpp-interface-acl model.";
index 53fdb24..1658485 100644 (file)
@@ -19,6 +19,32 @@ module vpp-subinterface-acl {
         prefix "ext";
     }
 
+    organization
+        "FD.io - The Fast Data Project";
+
+    contact
+        "Hc2vpp Wiki <https://wiki.fd.io/view/Hc2vpp>
+         Mailing List <[email protected]>";
+
+    description
+        "This module contains a collection of YANG definitions for
+         applying ACLs on VPP sub-interfaces.
+         Uses ACL implementation based on VPP packet classifier.
+
+         Copyright (c) 2017-2018 Cisco and/or its affiliates.
+
+         Licensed under the Apache License, Version 2.0 (the 'License');
+         you may not use this file except in compliance with the License.
+         You may obtain a copy of the License at:
+
+         http://www.apache.org/licenses/LICENSE-2.0
+
+         Unless required by applicable law or agreed to in writing, software
+         distributed under the License is distributed on an 'AS IS' BASIS,
+         WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+         See the License for the specific language governing permissions and
+         limitations under the License.";
+
     revision "2017-03-15" {
         description
             "Initial revision of vpp-subinterface-acl model.";
index 1d886de..dd43c13 100644 (file)
@@ -11,15 +11,43 @@ module multi-naming-context {
        prefix "ext";
     }
 
+    organization
+        "FD.io - The Fast Data Project";
+
+    contact
+        "Hc2vpp Wiki <https://wiki.fd.io/view/Hc2vpp>
+         Mailing List <[email protected]>";
+
     description
-        "This module contains data definition for naming multi-mapping context";
+        "This module contains data definition for naming multi-mapping context.
+
+         Multi-naming context provides mapping between string names used in YANG models
+         and integer indices used by VPP.
+
+         The mapping is managed internally by the HC plugins.
+         It is exposed as operational state data for debugging purposes.
+
+         Copyright (c) 2016-2018 Cisco and/or its affiliates.
+
+         Licensed under the Apache License, Version 2.0 (the 'License');
+         you may not use this file except in compliance with the License.
+         You may obtain a copy of the License at:
+
+         http://www.apache.org/licenses/LICENSE-2.0
+
+         Unless required by applicable law or agreed to in writing, software
+         distributed under the License is distributed on an 'AS IS' BASIS,
+         WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+         See the License for the specific language governing permissions and
+         limitations under the License.";
 
     revision "2016-04-11" {
         description
             "Initial revision.";
     }
+    // TODO(HC2VPP-296): move to routing plugin
 
-    grouping multi-naming-contexts-attributes{
+    grouping multi-naming-contexts-attributes {
         container multi-naming-contexts {
             config false;
             // context data
@@ -41,7 +69,7 @@ module multi-naming-context {
                             type string;
                         }
 
-                        list value{
+                        list value {
                             key "name";
 
                             unique "index";
index c101b5c..0621cff 100644 (file)
@@ -3,8 +3,35 @@ module naming-context {
     namespace "urn:honeycomb:params:xml:ns:yang:naming:context";
     prefix "nc";
 
+    organization
+        "FD.io - The Fast Data Project";
+
+    contact
+        "Hc2vpp Wiki <https://wiki.fd.io/view/Hc2vpp>
+         Mailing List <[email protected]>";
+
     description
-        "This module contains data definition for naming mapping context";
+        "This module contains data definition for naming mapping context.
+
+         Naming context provides mapping between string names used in YANG models
+         and integer indices used by VPP.
+
+         The mapping is managed internally by the HC plugins.
+         It is exposed as operational state data for debugging purposes.
+
+         Copyright (c) 2016-2018 Cisco and/or its affiliates.
+
+         Licensed under the Apache License, Version 2.0 (the 'License');
+         you may not use this file except in compliance with the License.
+         You may obtain a copy of the License at:
+
+         http://www.apache.org/licenses/LICENSE-2.0
+
+         Unless required by applicable law or agreed to in writing, software
+         distributed under the License is distributed on an 'AS IS' BASIS,
+         WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+         See the License for the specific language governing permissions and
+         limitations under the License.";
 
     revision "2016-05-13" {
         description
@@ -40,5 +67,4 @@ module naming-context {
             }
         }
     }
-
 }
\ No newline at end of file
index 2582cbe..b1ad8d8 100644 (file)
@@ -3,40 +3,65 @@ module vpp-management {
   namespace "urn:opendaylight:params:xml:ns:yang:vpp:management";
   prefix "vpp-m";
 
+  organization
+    "FD.io - The Fast Data Project";
+
+  contact
+    "Hc2vpp Wiki <https://wiki.fd.io/view/Hc2vpp>
+     Mailing List <[email protected]>";
+
+  description
+    "This module contains a collection of YANG definitions
+     that expose VPP operational state.
+
+     Copyright (c) 2017-2018 Cisco and/or its affiliates.
+
+     Licensed under the Apache License, Version 2.0 (the 'License');
+     you may not use this file except in compliance with the License.
+     You may obtain a copy of the License at:
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+     Unless required by applicable law or agreed to in writing, software
+     distributed under the License is distributed on an 'AS IS' BASIS,
+     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+     See the License for the specific language governing permissions and
+     limitations under the License.";
+
   revision "2017-03-15" {
     description
-        "This revision add support for
-           - Vpp state attributes read
-           - RPC cli support";
+      "This revision add support for
+         - Vpp state attributes read
+         - RPC cli support";
   }
 
   container vpp-state {
-      config false;
+    config false;
 
-      description
-        "VPP operational data";
-
-      container version {
-        leaf name {
-          type string;
-        }
-        leaf build-directory {
-          type string;
-        }
-        leaf build-date {
-          type string;
-        }
-        leaf branch {
-          type string;
-        }
-        leaf pid {
-          type uint32;
-          description
-            "PID of the vpp process";
-        }
+    description
+      "VPP operational data";
+
+    container version {
+      leaf name {
+        type string;
+      }
+      leaf build-directory {
+        type string;
+      }
+      leaf build-date {
+        type string;
+      }
+      leaf branch {
+        type string;
+      }
+      leaf pid {
+        type uint32;
         description
-        "vlib version info";
+          "PID of the vpp process";
       }
+      description
+        "vlib version info";
+    }
   }
 
   rpc cli-inband {