OSPFD yang #6055

Spantik · 2020-03-20T07:16:39Z

Initial version of OSPF configuration Yang.

module: frr-vrf +--rw lib +--rw vrf* [name] +--rw name string +--ro id? uint32 +--ro active? boolean <false> +--rw netns {netns}? +--rw name? string Signed-off-by: Chirag Shah <chirag@cumulusnetworks.com>

lib: Adding frr-vrf yang module to common place so it can be accessed from all frr modules. Signed-off-by: Chirag Shah <chirag@cumulusnetworks.com>

yang: add vrf model

module: frr-vrf +--rw lib +--rw vrf* [name] +--rw name string +--ro id? uint32 +--ro active? boolean <false> +--rw netns {netns}? +--rw name? string Signed-off-by: Chirag Shah <chirag@cumulusnetworks.com>

lib: Adding frr-vrf yang module to common place so it can be accessed from all frr modules. Signed-off-by: Chirag Shah <chirag@cumulusnetworks.com>

…o nb_conversions

module: frr-interface +--rw lib +--rw interface* [name vrf] +--rw name string +--rw vrf frr-vrf:vrf-ref +--rw description? string Signed-off-by: Chirag Shah <chirag@cumulusnetworks.com>

yang: add vrf ref to interface model

Yang files for staticd to use northbound APIs Co-authored-by: Santosh P K <sapk@vmware.com> Co-authored-by: vishaldhingra <vdhingra@vmware.com> Signed-off-by: vishaldhingra <vdhingra@vmware.com>

Yang files for basic frr-routing used by other daemons like staticd and pim Co-authored-by: Santosh P K <sapk@vmware.com> Co-authored-by: vishaldhingra <vdhingra@vmware.com> Signed-off-by: vishaldhingra <vdhingra@vmware.com>

A common nexthop and group nexthop yang data model for all protocols in FRR. Co-authored-by: Santosh P K <sapk@vmware.com> Co-authored-by: Vishaldhingra <vdhingra@vmware.com> Signed-off-by: Santosh P K <sapk@vmware.com>

lib: FRR next-hop yang data model.

staticd: yang definition

lib: yang defination for basic routing frr-routing

module: frr-vrf +--rw lib +--rw vrf* [name] +--rw name string +--ro id? uint32 +--ro active? boolean <false> +--rw netns {netns}? +--rw name? string Signed-off-by: Chirag Shah <chirag@cumulusnetworks.com>

lib: Adding frr-vrf yang module to common place so it can be accessed from all frr modules. Signed-off-by: Chirag Shah <chirag@cumulusnetworks.com>

module: frr-interface +--rw lib +--rw interface* [name vrf] +--rw name string +--rw vrf frr-vrf:vrf-ref +--rw description? string Signed-off-by: Chirag Shah <chirag@cumulusnetworks.com>

A common nexthop and group nexthop yang data model for all protocols in FRR. Co-authored-by: Santosh P K <sapk@vmware.com> Co-authored-by: Vishaldhingra <vdhingra@vmware.com> Signed-off-by: Santosh P K <sapk@vmware.com>

Yang files for staticd to use northbound APIs Co-authored-by: Santosh P K <sapk@vmware.com> Co-authored-by: vishaldhingra <vdhingra@vmware.com> Signed-off-by: vishaldhingra <vdhingra@vmware.com>

Yang files for basic frr-routing used by other daemons like staticd and pim Co-authored-by: Santosh P K <sapk@vmware.com> Co-authored-by: vishaldhingra <vdhingra@vmware.com> Signed-off-by: vishaldhingra <vdhingra@vmware.com>

…o nb_conversions

module: frr-vrf +--rw lib +--rw vrf* [name] +--rw name string +--ro id? uint32 +--ro active? boolean <false> +--rw netns {netns}? +--rw name? string Signed-off-by: Chirag Shah <chirag@cumulusnetworks.com>

lib: Adding frr-vrf yang module to common place so it can be accessed from all frr modules. Signed-off-by: Chirag Shah <chirag@cumulusnetworks.com>

module: frr-interface +--rw lib +--rw interface* [name vrf] +--rw name string +--rw vrf frr-vrf:vrf-ref +--rw description? string Signed-off-by: Chirag Shah <chirag@cumulusnetworks.com>

A common nexthop and group nexthop yang data model for all protocols in FRR. Co-authored-by: Santosh P K <sapk@vmware.com> Co-authored-by: Vishaldhingra <vdhingra@vmware.com> Signed-off-by: Santosh P K <sapk@vmware.com>

Yang files for staticd to use northbound APIs Co-authored-by: Santosh P K <sapk@vmware.com> Co-authored-by: vishaldhingra <vdhingra@vmware.com> Signed-off-by: vishaldhingra <vdhingra@vmware.com>

Yang files for basic frr-routing used by other daemons like staticd and pim Co-authored-by: Santosh P K <sapk@vmware.com> Co-authored-by: vishaldhingra <vdhingra@vmware.com> Signed-off-by: vishaldhingra <vdhingra@vmware.com>

…o nb_conversions

Spantik · 2020-03-20T07:21:59Z

OSPF Yang tree.

ton31337 · 2020-04-02T09:41:31Z

yang/frr-ospfd.yang

+
+
+      container timers {
+        leaf dead-interval {


indentation here as well

ton31337 · 2020-04-02T09:44:17Z

yang/frr-ospfd.yang

+	leaf out { 
+	  type empty; 
+	  description
+	    "In direction."; 


ton31337 · 2020-04-02T09:44:24Z

yang/frr-ospfd.yang

+	leaf in { 
+	  type empty; 
+	  description
+	    "Out direction."; 


ton31337 · 2020-04-02T09:45:19Z

yang/frr-ospfd.yang

+	description
+	  "Stable IP address of the advertising router."; 
+      } 
+      container inrer-as { 


ton31337 · 2020-04-02T09:45:59Z

yang/frr-ospfd.yang

+	  enum "cisco" { 
+	    value 1; 
+	    description
+	      "Alternative ABR,  cisco implementation.";


two spaces?

Cisco (capital first maybe)?

ton31337 · 2020-04-02T09:47:00Z

yang/frr-ospfd.yang

+      leaf rfc1583compatibility { 
+        type empty; 
+	description
+	  "Enable the RFC1583Compatibility flag.";


Enable the RFC1583 compatibility flag.

ton31337 · 2020-04-02T09:47:27Z

yang/frr-ospfd.yang

+      leaf opaque-lsa { 
+        type empty; 
+	description
+	  "Enable the Opaque-LSA capability (rfc2370)";


Can we use RFC or rfc, but not mixed everywhere?

ton31337 · 2020-04-02T09:48:26Z

yang/frr-ospfd.yang

+          range "10..1800"; 
+        } 
+	description
+	  "Timer value in seconds.";


what timer? :)

That's a poor description indeed.

Also, please use units seconds;.

ton31337 · 2020-04-02T09:50:49Z

yang/frr-ospfd.yang

+          description
+	    "Prefix SID.";
+	} 
+	leaf no-php-flag { 


ton31337 · 2020-04-02T09:53:31Z

yang/frr-ospfd.yang

+      list neighbor {
+        key "as";
+        leaf as {
+          type uint16;


0 is valid AS as well?

ton31337

I just recommend reviewing all the typos, whitespaces, indentation.

rwestphal

@Spantik Thanks for starting this work!

A few preliminary review comments:

For configuration data, please use boolean leafs instead of empty leafs. That's necessary for the show configuration <running|candidate|...> with-defaults command to work properly. Using empty leafs there's no way to know if the configuration option is enabled by default or not.
This module makes mixed use of hyphens and underscores (e.g. leaf key_id, then leaf mds-key a few lines below). I think it would be better to consolidate on hyphens only (that's what the IETF modules seem to be doing, even though there doesn't seem to be any guideline in that regard).
This module contains lots of indentation and whitespace issues. Examples: trailing whitespaces, redundant new lines, lines that are too long, etc. You can use yanglint to format this module automatically for you.
Finally, you could reuse definitions from ietf-ospf.yang whenever possible. That would give us nice node descriptions for free and make the native<->IETF module translation process easier in the future.

rwestphal · 2020-04-15T00:24:07Z

yang/frr-ospfd.yang

+	  "A list of area objects";
+
+	leaf area_id {
+	  type inet:ipv4-address;


In the CLI we can specify the OSPF area using either an IPv4 address or an unsigned integer, and the CLI retains the chosen format when displaying the running configuration. With this YANG module we won't be able to preserve that behavior, so we need to discuss if that's acceptable. There are a few options to preserve the old behavior, like using YANG unions, choices, or extending the NB to have the ability to associate metadata to data nodes. But all solutions imply an extra complexity that might not be worth the effort.

rwestphal · 2020-04-15T00:25:28Z

yang/frr-ospfd.yang

+          range "10..1800"; 
+        } 
+	description
+	  "Timer value in seconds.";


That's a poor description indeed.

Also, please use units seconds;.

rwestphal · 2020-04-15T00:26:39Z

yang/frr-ospfd.yang

+        range "1..4294967";
+      } 
+      description
+        "The reference bandwidth in terms of Mbits per second.";


please use units Mbits; like in the IETF module.

rwestphal · 2020-04-15T00:28:12Z

yang/frr-ospfd.yang

+      }
+    }
+    leaf retransmit-interval {
+      type uint16;


This and other timers are missing ranges ("1..65535" in this case).

Initial version of OSPF configuration Yang. Raised new PR with review comment fixes on top of FRRouting#6055 Co-authored-by : Santosh P K <sapk@vmware.com> Co-authored-by : Mobashshera Rasool <mrasool@vmware.com> Signed-off-by : Mobashshera Rasool <mrasool@vmware.com>

Initial version of OSPF configuration Yang. Raised new PR with review comment fixes on top of FRRouting#6055 Co-authored-by : Santosh P K <sapk@vmware.com> Co-authored-by : Mobashshera Rasool <mrasool@vmware.com> Signed-off-by: Mobashshera Rasool <mrasool@vmware.com>

Initial version of OSPF configuration Yang. Raised new PR with review comment fixes on top of PR FRRouting#6055 Co-authored-by : Santosh P K <sapk@vmware.com> Co-authored-by : Mobashshera Rasool <mrasool@vmware.com> Signed-off-by: Mobashshera Rasool <mrasool@vmware.com>

Spantik · 2020-06-19T10:08:05Z

A new PR has been raised with review comments addressed #6616. Closing this.

Initial version of OSPF configuration Yang. Raised new PR with review comment fixes on top of PR FRRouting#6055 Co-authored-by : Santosh P K <sapk@vmware.com> Co-authored-by : Mobashshera Rasool <mrasool@vmware.com> Signed-off-by: Mobashshera Rasool <mrasool@vmware.com>

Initial version of OSPF configuration Yang. Raised new PR with review comment fixes on top of PR FRRouting#6055 Revision History: 1. Fixed review comments. 2. Removed ospf list with id as key, name can be used as key 3. Corrected the alignment Co-authored-by : Santosh P K <sapk@vmware.com> Co-authored-by : Mobashshera Rasool <mrasool@vmware.com> Signed-off-by: Mobashshera Rasool <mrasool@vmware.com>

chiragshah6 and others added 28 commits December 9, 2019 14:20

yang: add vrf model

0693b0d

module: frr-vrf +--rw lib +--rw vrf* [name] +--rw name string +--ro id? uint32 +--ro active? boolean <false> +--rw netns {netns}? +--rw name? string Signed-off-by: Chirag Shah <chirag@cumulusnetworks.com>

*: add frr-vrf yang module in makefile

e095f16

lib: Adding frr-vrf yang module to common place so it can be accessed from all frr modules. Signed-off-by: Chirag Shah <chirag@cumulusnetworks.com>

Merge pull request FRRouting#5501 from chiragshah6/yang_nb1

7d75ef8

yang: add vrf model

yang: add vrf model

cf93250

module: frr-vrf +--rw lib +--rw vrf* [name] +--rw name string +--ro id? uint32 +--ro active? boolean <false> +--rw netns {netns}? +--rw name? string Signed-off-by: Chirag Shah <chirag@cumulusnetworks.com>

*: add frr-vrf yang module in makefile

245daf0

lib: Adding frr-vrf yang module to common place so it can be accessed from all frr modules. Signed-off-by: Chirag Shah <chirag@cumulusnetworks.com>

Merge branch 'nb_conversions' of https://github.com/FRRouting/frr int…

2d2d0ee

…o nb_conversions

yang: add vrf ref to interface model

87ee53f

module: frr-interface +--rw lib +--rw interface* [name vrf] +--rw name string +--rw vrf frr-vrf:vrf-ref +--rw description? string Signed-off-by: Chirag Shah <chirag@cumulusnetworks.com>

Merge pull request FRRouting#5751 from chiragshah6/yang_nb1

5dd164b

yang: add vrf ref to interface model

staticd: yang defination

95f1804

Yang files for staticd to use northbound APIs Co-authored-by: Santosh P K <sapk@vmware.com> Co-authored-by: vishaldhingra <vdhingra@vmware.com> Signed-off-by: vishaldhingra <vdhingra@vmware.com>

lib: yang defination for basic frr-routing

f5319ff

Yang files for basic frr-routing used by other daemons like staticd and pim Co-authored-by: Santosh P K <sapk@vmware.com> Co-authored-by: vishaldhingra <vdhingra@vmware.com> Signed-off-by: vishaldhingra <vdhingra@vmware.com>

lib: FRR next-hop yang data model.

a530bfe

A common nexthop and group nexthop yang data model for all protocols in FRR. Co-authored-by: Santosh P K <sapk@vmware.com> Co-authored-by: Vishaldhingra <vdhingra@vmware.com> Signed-off-by: Santosh P K <sapk@vmware.com>

Merge pull request FRRouting#5578 from Spantik/working_nb

db727fe

lib: FRR next-hop yang data model.

Merge pull request FRRouting#5460 from vishaldhingra/static_nb

2a9ca11

staticd: yang definition

Merge pull request FRRouting#5530 from vishaldhingra/common_nb

aa9935c

lib: yang defination for basic routing frr-routing

yang: add vrf model

6514ce8

module: frr-vrf +--rw lib +--rw vrf* [name] +--rw name string +--ro id? uint32 +--ro active? boolean <false> +--rw netns {netns}? +--rw name? string Signed-off-by: Chirag Shah <chirag@cumulusnetworks.com>

*: add frr-vrf yang module in makefile

5b15a51

lib: Adding frr-vrf yang module to common place so it can be accessed from all frr modules. Signed-off-by: Chirag Shah <chirag@cumulusnetworks.com>

yang: add vrf ref to interface model

ee8ac97

module: frr-interface +--rw lib +--rw interface* [name vrf] +--rw name string +--rw vrf frr-vrf:vrf-ref +--rw description? string Signed-off-by: Chirag Shah <chirag@cumulusnetworks.com>

lib: FRR next-hop yang data model.

97928ec

A common nexthop and group nexthop yang data model for all protocols in FRR. Co-authored-by: Santosh P K <sapk@vmware.com> Co-authored-by: Vishaldhingra <vdhingra@vmware.com> Signed-off-by: Santosh P K <sapk@vmware.com>

staticd: yang defination

8f8cac6

Yang files for staticd to use northbound APIs Co-authored-by: Santosh P K <sapk@vmware.com> Co-authored-by: vishaldhingra <vdhingra@vmware.com> Signed-off-by: vishaldhingra <vdhingra@vmware.com>

lib: yang defination for basic frr-routing

2aa6fcc

Yang files for basic frr-routing used by other daemons like staticd and pim Co-authored-by: Santosh P K <sapk@vmware.com> Co-authored-by: vishaldhingra <vdhingra@vmware.com> Signed-off-by: vishaldhingra <vdhingra@vmware.com>

Merge branch 'nb_conversions' of https://github.com/FRRouting/frr int…

3e31357

…o nb_conversions

yang: add vrf model

c590694

module: frr-vrf +--rw lib +--rw vrf* [name] +--rw name string +--ro id? uint32 +--ro active? boolean <false> +--rw netns {netns}? +--rw name? string Signed-off-by: Chirag Shah <chirag@cumulusnetworks.com>

*: add frr-vrf yang module in makefile

2884b53

lib: Adding frr-vrf yang module to common place so it can be accessed from all frr modules. Signed-off-by: Chirag Shah <chirag@cumulusnetworks.com>

yang: add vrf ref to interface model

745d694

module: frr-interface +--rw lib +--rw interface* [name vrf] +--rw name string +--rw vrf frr-vrf:vrf-ref +--rw description? string Signed-off-by: Chirag Shah <chirag@cumulusnetworks.com>

lib: FRR next-hop yang data model.

1dc094d

A common nexthop and group nexthop yang data model for all protocols in FRR. Co-authored-by: Santosh P K <sapk@vmware.com> Co-authored-by: Vishaldhingra <vdhingra@vmware.com> Signed-off-by: Santosh P K <sapk@vmware.com>

staticd: yang defination

3cd3efe

Yang files for staticd to use northbound APIs Co-authored-by: Santosh P K <sapk@vmware.com> Co-authored-by: vishaldhingra <vdhingra@vmware.com> Signed-off-by: vishaldhingra <vdhingra@vmware.com>

lib: yang defination for basic frr-routing

30144e1

Yang files for basic frr-routing used by other daemons like staticd and pim Co-authored-by: Santosh P K <sapk@vmware.com> Co-authored-by: vishaldhingra <vdhingra@vmware.com> Signed-off-by: vishaldhingra <vdhingra@vmware.com>

Merge branch 'nb_conversions' of https://github.com/FRRouting/frr int…

84b5d31

…o nb_conversions

polychaeta added the ospf label Mar 20, 2020