[netmod] AD review of draft-ietf-netmod-rfc6087bis-16 Part 1
Benoit Claise <bclaise@cisco.com> Thu, 25 January 2018 11:20 UTC
Return-Path: <bclaise@cisco.com>
X-Original-To: netmod@ietfa.amsl.com
Delivered-To: netmod@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id D1D2A12DA1A for <netmod@ietfa.amsl.com>; Thu, 25 Jan 2018 03:20:19 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -14.508
X-Spam-Level:
X-Spam-Status: No, score=-14.508 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DC_PNG_UNO_LARGO=0.001, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, HTML_MESSAGE=0.001, RCVD_IN_DNSWL_HI=-5, SPF_PASS=-0.001, T_RP_MATCHES_RCVD=-0.01, URIBL_BLOCKED=0.001, USER_IN_DEF_DKIM_WL=-7.5] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (1024-bit key) header.d=cisco.com
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 tgVmvLEdY30n for <netmod@ietfa.amsl.com>; Thu, 25 Jan 2018 03:20:15 -0800 (PST)
Received: from aer-iport-3.cisco.com (aer-iport-3.cisco.com [173.38.203.53]) (using TLSv1.2 with cipher DHE-RSA-SEED-SHA (128/128 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 7C94E12DA16 for <netmod@ietf.org>; Thu, 25 Jan 2018 03:20:14 -0800 (PST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=cisco.com; i=@cisco.com; l=44432; q=dns/txt; s=iport; t=1516879214; x=1518088814; h=subject:references:from:to:message-id:date:mime-version: in-reply-to; bh=yORDjG0ZEZWMjIpsYKmuU5X1pkSpNGzFXeCIDD/GrPw=; b=OHd+MnrR9vrDeE+Z0hMw6yQNmdJ4DlMuQ79UPHmvLdbnqDcC/9Y+hEcs ZDX+7JaWxEHmP0huApV88UI01EZgsbtUfAg1/K36GS2OdyL1SjpuYGSzY 0to8fLTVbFJIbUb15k6OMY27oPR9kQXcGMRFnzHbzxuJ2slFe4+ZLqjsD w=;
X-Files: bkkgoabpbicgbeom.png : 14007
X-IronPort-Anti-Spam-Filtered: true
X-IronPort-Anti-Spam-Result: A0DyAQCqomla/xbLJq1UCRkBAQEBAQEBAQEBAQEHAQEBAQGDEYEXdCeDXYsYj0+DLZRSggIHAQIlhRYChTQVAQEBAQEBAQECayiFJAYFHksbHQsBAQEiAgICFQEOIw4GDQUBAgEBAoovELUggicmijoBAQEBAQEBAwEBAQEBAQEBAQEBDgoFhFGDbIFoKQyGKAEBAgEBgTUOFIMtgmUFimmHUJAsgSSHEAGBBI1NjCuHeo1agWuEXoM1gTw1I4FQMxoIGxWCZ4RYQDcBjAEsgh0BAQE
X-IronPort-AV: E=Sophos;i="5.46,411,1511827200"; d="png'150?scan'150,208,217,150";a="1598191"
Received: from aer-iport-nat.cisco.com (HELO aer-core-3.cisco.com) ([173.38.203.22]) by aer-iport-3.cisco.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 25 Jan 2018 11:20:12 +0000
Received: from [10.55.221.36] (ams-bclaise-nitro3.cisco.com [10.55.221.36]) by aer-core-3.cisco.com (8.14.5/8.14.5) with ESMTP id w0PBKCKg023857 for <netmod@ietf.org>; Thu, 25 Jan 2018 11:20:12 GMT
References: <e1f4f27a-d982-b248-f0e1-7093dc2f63e8@cisco.com>
From: Benoit Claise <bclaise@cisco.com>
To: NETMOD Working Group <netmod@ietf.org>
X-Forwarded-Message-Id: <e1f4f27a-d982-b248-f0e1-7093dc2f63e8@cisco.com>
Message-ID: <6f96ec70-1532-5d99-97d1-5d5531e7865e@cisco.com>
Date: Thu, 25 Jan 2018 12:20:11 +0100
User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64; rv:52.0) Gecko/20100101 Thunderbird/52.5.2
MIME-Version: 1.0
In-Reply-To: <e1f4f27a-d982-b248-f0e1-7093dc2f63e8@cisco.com>
Content-Type: multipart/alternative; boundary="------------6F096081234516D0BFD2715F"
Content-Language: en-US
Archived-At: <https://mailarchive.ietf.org/arch/msg/netmod/B4TUQZf7jud5wqrBwzEqEND6-rw>
Subject: [netmod] AD review of draft-ietf-netmod-rfc6087bis-16 Part 1
X-BeenThere: netmod@ietf.org
X-Mailman-Version: 2.1.22
Precedence: list
List-Id: NETMOD WG list <netmod.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/netmod>, <mailto:netmod-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/netmod/>
List-Post: <mailto:netmod@ietf.org>
List-Help: <mailto:netmod-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/netmod>, <mailto:netmod-request@ietf.org?subject=subscribe>
X-List-Received-Date: Thu, 25 Jan 2018 11:20:20 -0000
Dear all, Thank you for this important document. I've been spending quite some time trying to relay feedback seen on multiple fronts. This is part 1 of the review, till section 4.21 - This document defines a set of usage guidelines for Standards Track documents containing [RFC7950 <https://tools.ietf.org/html/rfc7950>] data models. This is not inline with: This section contains the module(s) defined by the specification. These modules SHOULD be written using the YANG 1.1 [RFC7950 <https://tools.ietf.org/html/rfc7950>] syntax. YANG 1.0 [RFC6020 <https://tools.ietf.org/html/rfc6020>] syntax MAY be used if no YANG 1.1 constructs or semantics are needed in the module. So it should be changed to This document defines a set of usage guidelines for Standards Track documents containing YANG 1.1 [RFC7950 <https://tools.ietf.org/html/rfc7950>] and YANG 1.0 [RFC6020] data models. Similarly in section 4 OLD: Modules in IETF Standards Track specifications MUST comply with all syntactic and semantic requirements of YANG [RFC7950 <https://tools.ietf.org/html/rfc7950>]. NEW: Modules in IETF Standards Track specifications MUST comply with all syntactic and semantic requirements of YANG 1.1 [RFC7950 <https://tools.ietf.org/html/rfc7950>]. See the exception for YANG 1.0 in section 3.6 Note that I tried to add some new text around the following sentence but that paragraph became clumsy. Alternatively, if YANG 1.0 is used, then Modules in IETF Standards Track specifications MUST comply with all syntactic and semantic requirements of YANG 1.0 [RFC6020]. Finally, in section 3.6, I would add a sentence to this paragraph This section contains the module(s) defined by the specification. These modules SHOULD be written using the YANG 1.1 [RFC7950 <https://tools.ietf.org/html/rfc7950>] syntax. YANG 1.0 [RFC6020 <https://tools.ietf.org/html/rfc6020>] syntax MAY be used if no YANG 1.1 constructs or semantics are needed in the module. The sentence such as: if any the imported YANG modules is based on YANG 1.1, the main YANG module MUST also be written in YANG 1.1. - section 3, editorial: There are three usage scenarios for YANG that can appear in an Internet-Draft or RFC: o normative module or submodule o example module or submodule o example YANG fragment not part of any module or submodule The guidelines in this document refer mainly to a normative_complete_ module or submodule, but may be applicable to example modules and YANG fragments as well. Either add "complete" to "o normative module or submodule)" and be consistent throughout the document, or remove it from the last sentence. - section 3.2 The "<CODE BEGINS>" tag SHOULD be followed by a string identifying the file name specified inSection 5.2 of [RFC7950] <https://tools.ietf.org/html/rfc7950#section-5.2>. The name string form that includes the revision-date SHOULD be used. The following example is for the '2010-01-18' revision of the 'ietf-foo' module: <CODE BEGINS> file "ietf-foo@2016-03-20.yang" I would add that both revision versions (on the <CODE BEGINS> and in the module) MUST match. I ran into all sort of tooling issues because of such discrepancies. - section 3.2.1 Add "see section 4.9 regarding the namespace guidelines for example modules" - The following in paragraph in section 3.3 seems misplaced. If YANG tree diagrams are used, then a normative reference to the YANG tree diagrams specification MUST be provided for each diagram. (Refer to the example in the next section.) It should be in section 3.4. Btw, no need to have the specifications for each diagram! Also, we want to add some guidelines on how to reference the tree diagram convention For ex: no need to copy over the conventions Basically, we just need: https://tools.ietf.org/html/draft-ietf-netmod-rfc7223bis-03#section-1.3 PROPOSAL (replacing the previous paragraph) If YANG tree diagrams are used, then a normative reference to the YANG tree diagrams specification MUST be provided. As an example guideline (from https://tools.ietf.org/html/draft-ietf-netmod-rfc7223bis-03#section-1.3), here is a subsection in the terminology section Tree Diagrams Tree diagrams used in this document follow the notation defined in [I-D.ietf-netmod-yang-tree-diagrams <https://tools.ietf.org/html/draft-ietf-netmod-rfc7223bis-03#ref-I-D.ietf-netmod-yang-tree-diagrams>]. - section 3.5 You should add a good example to illustrate the second paragraph (Based on some previous feedback, YANG module designer wants to work from examples) I would suggest to add https://tools.ietf.org/html/draft-ietf-netmod-rfc8022bis-09#section-2.3 - section 3.6, editorial OLD: Note that all YANG statements within a YANG module are considered normative, if the module itself is considered normative, and not an example module. NEW: Note that all YANG statements within a YANG module are considered normative, if the module itself is considered normative, and not an example module or a example YANG fragment. - section 3.6 Example YANG modules MUST NOT contain any normative text, including any reserved words from [RFC2119 <https://tools.ietf.org/html/rfc2119>]. I guess it applies also to the "example YANG fragments" - section 3.10 Mention yanglint. yanglint validates xpath, while pyang doesn't. - section 3.11 You might consider the addition of xym https://github.com/xym-tool/xym - section 3.12 mention that the examples MUST be validated. Pointing to the tool would be a welcome addition. - section 4.6.x You should really mention a common mistake about the missing derived-from-or-self(), flagged in many YANG doctor reviews:: You should explain the applicability: identity augmentation. - section 4.7 "Lifecycle Management" The status statement MUST be present if its value is 'deprecated' or 'obsolete'. I've been confused for a little, thinking this section was about the IETF document lifecyle management and the obsolete document tag. Proposal: "Objects Lifecycle Management" or "YANG Objects Lifecycle Management" The YANG objects status statement MUST be present if its value is 'deprecated' or 'obsolete'. - section 4.8 The contact statement MUST be present. If the module is contained in a document intended for Standards Track status, then the working group web and mailing information MUST be present, and the main document author or editor contact information SHOULD be present. If additional authors or editors exist, their contact information MAY be present. I would add: No need to include the WG chair contacts. - section 4.10 The separation of configuration data and operational state SHOULD be considered carefully. It is sometimes useful to define separate top- level containers for configuration and non-configuration data. For some existing top-level data nodes, configuration data was not in scope, so only one container representing operational state was created. What about NMDA? This section is not inline with 4.23.3 Btw, in case a YANG supports NMDA , RFC6087bis should include the guideline is that it must be clearly mentioned. The example of the abstract in https://tools.ietf.org/html/draft-ietf-netmod-rfc7223bis-03 could be mentioned. The YANG model in this document conforms to the Network Management Datastore Architecture defined in I-D.ietf-netmod-revised-datastores. In the same section about "top-level data definitions", any guidelines in connection with https://datatracker.ietf.org/doc/draft-ietf-rtgwg-lne-model/ and schema mount? Too early? In section 4.23, add the [I-D.ietf-netmod-revised-datastores <https://tools.ietf.org/html/draft-ietf-netmod-rfc6087bis-16#ref-I-D.ietf-netmod-revised-datastores>] reference next to NMDA In section 4.23.3 OLD: (b) For published models, the model should be republished with an NMDA-compatible structure, deprecating non-NMDA constructs. For example, the "ietf-interfaces" model in [RFC7223 <https://tools.ietf.org/html/rfc7223>] will be restructured as an NMDA-compatible model. NEW: (b) For published models, the model should be republished with an NMDA-compatible structure, deprecating non-NMDA constructs. For example, the "ietf-interfaces" model in [RFC7223 <https://tools.ietf.org/html/rfc7223>] has been restructured as an NMDA-compatible model in [RFC7223bis]. I believe [I-D.ietf-netmod-revised-datastores] should a normative reference - section 4.14.2 Something wrong with: -top-level siblings are not ordered -top-level siblings not are not static, and depends on the modules that are loaded - section 4.17 Discussing with YANG doctors that a feature-per-leaf is most likely the wrong approach, Jürgen came up with this. OLD The YANG "feature" statement is used to define a label for a set of optional functionality within a module. The "if-feature" statement is used in the YANG statements associated with a feature. The set of YANG features available in a module should be considered carefully. The description-stmt within a feature-stmt MUST specify any interactions with other features. If there is a large set of objects... NEW The YANG "feature" statement is used to define a label for a set of optional functionality within a module. The "if-feature" statement is used in the YANG statements associated with a feature. The description-stmt within a feature-stmt MUST specify any interactions with other features. The set of YANG features defined in a module should be considered carefully. Very fine granular features increase interoperability complexity and should be avoided. A likely misuse of the feature mechanism is the tagging of individual leafs (e.g., counters) with separate features. If there is a large set of objects... back to section 4.5 If a data definition is optional, depending on server support for a NETCONF or RESTCONF protocol capability, then a YANG 'feature' statement SHOULD be defined to indicate that the NETCONF or RESTCONF capability is supported within the data model. NEW: If a data definition is optional which depends on server support then a YANG 'feature' statement SHOULD be defined. The defined 'feature' SHOULD then be used in the conditional 'if-feature' statement referencing the optional data definition. This is currently under discussion with the YANG doctors. Regards, Benoit
- [netmod] AD review of draft-ietf-netmod-rfc6087bi… Benoit Claise
- Re: [netmod] AD review of draft-ietf-netmod-rfc60… Juergen Schoenwaelder
- Re: [netmod] AD review of draft-ietf-netmod-rfc60… Benoit Claise
- Re: [netmod] AD review of draft-ietf-netmod-rfc60… Kent Watsen
- Re: [netmod] AD review of draft-ietf-netmod-rfc60… Benoit Claise
- [netmod] draft-ietf-netmod-rfc6087bis-16 t.petch
- Re: [netmod] draft-ietf-netmod-rfc6087bis-16 Andy Bierman
- Re: [netmod] draft-ietf-netmod-rfc6087bis-16 t.petch
- Re: [netmod] draft-ietf-netmod-rfc6087bis-16 Kent Watsen