Re: [yang-doctors] Yangdoctors last call review of draft-ietf-ospf-yang-09
Ladislav Lhotka <lhotka@nic.cz> Wed, 06 December 2017 12:26 UTC
Return-Path: <lhotka@nic.cz>
X-Original-To: yang-doctors@ietfa.amsl.com
Delivered-To: yang-doctors@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id 57784126C22; Wed, 6 Dec 2017 04:26:51 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -7
X-Spam-Level:
X-Spam-Status: No, score=-7 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, RCVD_IN_DNSWL_HI=-5] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (1024-bit key) header.d=nic.cz
Received: from mail.ietf.org ([4.31.198.44]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id WI15mEJFgz9v; Wed, 6 Dec 2017 04:26:48 -0800 (PST)
Received: from mail.nic.cz (mail.nic.cz [217.31.204.67]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 26E9912426E; Wed, 6 Dec 2017 04:26:48 -0800 (PST)
Received: from birdie1784 (unknown [IPv6:2001:718:1a02:1::380]) by mail.nic.cz (Postfix) with ESMTPSA id 44CB264330; Wed, 6 Dec 2017 13:26:46 +0100 (CET)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=nic.cz; s=default; t=1512563206; bh=/5/ShxDCCAreUBWxDtJzFY458gMaJ4by4aA4vQXE8CQ=; h=From:To:Date; b=qMlku96jQS/mSjftb8DIJil3xYXeEEijKK68XBrb489PviytPpOwKALcoQ6k2S9IH Fri/inRs8l5b/XHmQ2Q5+fmlID16/mpW/5IRCUK8D3QN9KtDisoMoDWnWE1T2z6oiB AAU6JPgRzfMNaLPekMUYEBFtcz8jJUYvYFVXuEl4=
Message-ID: <1512563206.2653.32.camel@nic.cz>
From: Ladislav Lhotka <lhotka@nic.cz>
To: Martin Bjorklund <mbj@tail-f.com>
Cc: yang-doctors@ietf.org, draft-ietf-ospf-yang.all@ietf.org
Date: Wed, 06 Dec 2017 13:26:46 +0100
In-Reply-To: <20171206.124611.1073986528289329597.mbj@tail-f.com>
References: <151255960762.30655.17225294251460480729@ietfa.amsl.com> <20171206.124611.1073986528289329597.mbj@tail-f.com>
Organization: CZ.NIC
Content-Type: text/plain; charset="UTF-8"
X-Mailer: Evolution 3.26.2
Mime-Version: 1.0
Content-Transfer-Encoding: 7bit
X-Virus-Scanned: clamav-milter 0.99.2 at mail
X-Virus-Status: Clean
Archived-At: <https://mailarchive.ietf.org/arch/msg/yang-doctors/qROANh9rsjOP4RTBTCVBmCuoYDk>
Subject: Re: [yang-doctors] Yangdoctors last call review of draft-ietf-ospf-yang-09
X-BeenThere: yang-doctors@ietf.org
X-Mailman-Version: 2.1.22
Precedence: list
List-Id: Email list of the yang-doctors directorate <yang-doctors.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/yang-doctors>, <mailto:yang-doctors-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/yang-doctors/>
List-Post: <mailto:yang-doctors@ietf.org>
List-Help: <mailto:yang-doctors-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/yang-doctors>, <mailto:yang-doctors-request@ietf.org?subject=subscribe>
X-List-Received-Date: Wed, 06 Dec 2017 12:26:51 -0000
On Wed, 2017-12-06 at 12:46 +0100, Martin Bjorklund wrote: > Ladislav Lhotka <lhotka@nic.cz> wrote: > > Reviewer: Ladislav Lhotka > > Review result: Ready with Issues > > > > The data model defined in this document is a massive piece of work: it > > consists of 11 YANG modules and defines around 1200 schema nodes. The > > 11 YANG modules? Isn't there just one? Yes, but I meant the complete data model including the existing modules that must be implemented along with "ietf-ospf", such as "ietf-interface", "ietf- routing" and "ietf-keychain". I think it is a higher league of data modelling compared to a stand-alone module - kudos to the authors. > > > > I would like to add two quick comments to Lada's review. > > o Remove all "revision" statements except the one that says "initial > revision". The idea is to have one revision statement per > published version (i.e., RFC). Right, the revisions make the module excessively long. > > > o Many of the nodes have quite rudimentary descriptions, and the > "reference" statement is rarely used. For example: > > leaf lsa-id { > type yang:dotted-quad; > mandatory true; > description "LSA ID."; > } > > It seems as the description is put there just to keep the tools > quiet. I know that it is painful to write good descriptions, but > it does help the consumer of the data model. Agreed. Thanks, Lada > > > /martin > > > > "ietf-ospf@2017-10-30" module is compatible with the NMDA architecture. > > > > **** Comments > > > > 1. Unless there is a really compelling reason not to do so, the > > "ietf-ospf" should declare YANG version 1.1. For one, > > "ietf-routing" that is being augmented by "ietf-ospf" already > > declares this version. Some of my suggestions below also assume > > version 1.1. > > > > 2. The "ietf-ospf" can work only with the new NMDA-compatible > > revisions of some modules, such as "ietf-interfaces" and > > "ietf-routing". I understand it is not desirable to import such > > modules by revision, but at least it should be mentioned in a > > description attached to every such import. > > > > 3. Maybe the draft could mention that implementations should supply a > > default routing domain as a system-controlled resource. > > > > 4. In "when" expressions, the module uses literal strings for > > identities. This is known to be problematic, the XPath functions > > derived-from() or derived-from-or-self() should be used instead. > > > > 5. Some enumerations, such as "packet-type" and "if-state-type" > > define enum identifiers with uppercase letters and/or underscores, > > for example "Database-Description" or "LONG_WAIT". RFC6087bis > > recommends that only lowercase letters, numbers and dashes. I think > > this convention should be observed despite the fact that the > > current names are traditionally used in OSPF specs. The > > "ietf-routing" module also defines "router-id" even though the > > documents use "Router ID". > > > > 6. The types of LSA headers are modelled as integers. While OSPF gurus > > probably know these numbers by heart, it is not very > > reader-frienly. So at least some references to documents defining > > these numbers should be provided, but my suggestion is to consider > > implementing them with identities. It seems it might also be useful > > to define some "abstract" identities for these types. For example, > > if "opaque-lsa" is defined, then the definition of container > > "opaque" could simply use > > > > when "derived-from(../../header/type, 'ospf:opaque-lsa')"; > > > > instead of > > > > when "../../header/type = 9 or " > > + "../../header/type = 10 or " > > + "../../header/type = 11"; > > > > 7. The title of sec. 2.9 should be "OSPF Notifications" rather than > > "OSPF notification". > > > > > > _______________________________________________ > > yang-doctors mailing list > > yang-doctors@ietf.org > > https://www.ietf.org/mailman/listinfo/yang-doctors > > -- Ladislav Lhotka Head, CZ.NIC Labs PGP Key ID: 0xB8F92B08A9F76C67
- [yang-doctors] Yangdoctors last call review of dr… Ladislav Lhotka
- Re: [yang-doctors] Yangdoctors last call review o… Martin Bjorklund
- Re: [yang-doctors] Yangdoctors last call review o… Ladislav Lhotka
- Re: [yang-doctors] Yangdoctors last call review o… Acee Lindem (acee)
- Re: [yang-doctors] Yangdoctors last call review o… Acee Lindem (acee)
- Re: [yang-doctors] Yangdoctors last call review o… Ladislav Lhotka
- Re: [yang-doctors] Yangdoctors last call review o… Martin Bjorklund
- Re: [yang-doctors] Yangdoctors last call review o… Ladislav Lhotka
- Re: [yang-doctors] Yangdoctors last call review o… Ladislav Lhotka
- Re: [yang-doctors] Yangdoctors last call review o… Martin Bjorklund
- Re: [yang-doctors] Yangdoctors last call review o… Ladislav Lhotka
- Re: [yang-doctors] Yangdoctors last call review o… Martin Bjorklund
- Re: [yang-doctors] Yangdoctors last call review o… Martin Bjorklund
- Re: [yang-doctors] Yangdoctors last call review o… Ladislav Lhotka
- Re: [yang-doctors] Yangdoctors last call review o… Martin Bjorklund
- Re: [yang-doctors] Yangdoctors last call review o… Ladislav Lhotka
- Re: [yang-doctors] Yangdoctors last call review o… Martin Bjorklund
- Re: [yang-doctors] Yangdoctors last call review o… Ladislav Lhotka
- Re: [yang-doctors] Yangdoctors last call review o… Andy Bierman
- Re: [yang-doctors] Yangdoctors last call review o… Ladislav Lhotka
- Re: [yang-doctors] Yangdoctors last call review o… Ladislav Lhotka
- Re: [yang-doctors] Yangdoctors last call review o… Martin Bjorklund
- Re: [yang-doctors] Yangdoctors last call review o… Juergen Schoenwaelder
- Re: [yang-doctors] Yangdoctors last call review o… Ladislav Lhotka
- Re: [yang-doctors] Yangdoctors last call review o… Juergen Schoenwaelder
- Re: [yang-doctors] Yangdoctors last call review o… Ladislav Lhotka
- Re: [yang-doctors] Yangdoctors last call review o… Andy Bierman
- Re: [yang-doctors] Yangdoctors last call review o… Ladislav Lhotka
- Re: [yang-doctors] Yangdoctors last call review o… Andy Bierman
- Re: [yang-doctors] Yangdoctors last call review o… Acee Lindem (acee)
- Re: [yang-doctors] Yangdoctors last call review o… Acee Lindem (acee)
- Re: [yang-doctors] Yangdoctors last call review o… Acee Lindem (acee)
- Re: [yang-doctors] Yangdoctors last call review o… Martin Bjorklund
- Re: [yang-doctors] Yangdoctors last call review o… Acee Lindem (acee)
- Re: [yang-doctors] Yangdoctors last call review o… Acee Lindem (acee)
- Re: [yang-doctors] Yangdoctors last call review o… Acee Lindem (acee)
- Re: [yang-doctors] Yangdoctors last call review o… Acee Lindem (acee)
- Re: [yang-doctors] Yangdoctors last call review o… Acee Lindem (acee)
- Re: [yang-doctors] Yangdoctors last call review o… Martin Bjorklund
- Re: [yang-doctors] Yangdoctors last call review o… Acee Lindem (acee)
- Re: [yang-doctors] [Lsr] Yangdoctors last call re… Rob Shakir
- Re: [yang-doctors] [Lsr] Yangdoctors last call re… Acee Lindem (acee)
- Re: [yang-doctors] Yangdoctors last call review o… Christian Hopps