[yang-doctors] Yangdoctors early review of draft-ietf-i2rs-rib-data-model-09
Ebben Aries <exa@juniper.net> Thu, 18 January 2018 08:33 UTC
Return-Path: <exa@juniper.net>
X-Original-To: yang-doctors@ietf.org
Delivered-To: yang-doctors@ietfa.amsl.com
Received: from ietfa.amsl.com (localhost [IPv6:::1]) by ietfa.amsl.com (Postfix) with ESMTP id 2246E12EB1C; Thu, 18 Jan 2018 00:33:04 -0800 (PST)
MIME-Version: 1.0
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: 7bit
From: Ebben Aries <exa@juniper.net>
To: yang-doctors@ietf.org
Cc: i2rs@ietf.org, draft-ietf-i2rs-rib-data-model.all@ietf.org, ietf@ietf.org
X-Test-IDTracker: no
X-IETF-IDTracker: 6.69.0
Auto-Submitted: auto-generated
Precedence: bulk
Message-ID: <151626438402.10775.7250014155413667607@ietfa.amsl.com>
Date: Thu, 18 Jan 2018 00:33:04 -0800
Archived-At: <https://mailarchive.ietf.org/arch/msg/yang-doctors/VClU_kAndmgWlqQIiTyh56ORy6Y>
Subject: [yang-doctors] Yangdoctors early review of draft-ietf-i2rs-rib-data-model-09
X-BeenThere: yang-doctors@ietf.org
X-Mailman-Version: 2.1.22
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: Thu, 18 Jan 2018 08:33:04 -0000
Reviewer: Ebben Aries Review result: On the Right Track 1 module in this draft: - ietf-i2rs-rib@2017-12-05.yang No YANG validation errors or warnings (from pyang 1.7.3 and yanglint 0.14.59) 0 examples are provided in this draft (section 3.12 of draft-ietf-netmod-rfc6087bis-15) Module ietf-i2rs-rib@2017-12-05.yang: - yang-version statement missing - should be 1.1 - prefix 'iir' is recommended for this module, would 'rib' suffice better? - import "ietf-inet-types" should reference RFC 6991 per (not as a comment) https://tools.ietf.org/html/draft-ietf-netmod-rfc6087bis-15#section-4.7 - import "ietf-interfaces" should reference RFC 7223 per https://tools.ietf.org/html/draft-ietf-netmod-rfc6087bis-15#section-4.7 - import "ietf-yang-types" should reference RFC 6991 per https://tools.ietf.org/html/draft-ietf-netmod-rfc6087bis-15#section-4.7 - Since this module imports "ietf-interfaces", a normative references must be added per https://tools.ietf.org/html/draft-ietf-netmod-rfc6087bis-15#section-3.9 - prefix "if" in the import "ietf-interfaces" can remove quotes to remain consistent with other imports - Remove WG Chairs from contact information per https://tools.ietf.org/html/draft-ietf-netmod-rfc6087bis-15#appendix-C - Module description must contain most recent copyright notice per https://tools.ietf.org/html/draft-ietf-netmod-rfc6087bis-15#appendix-C - Module description should contain note to RFC Ed. and placeholder reference to RFC when assigned https://tools.ietf.org/html/draft-ietf-netmod-rfc6087bis-15#appendix-C - Add placeholder reference and note to RFC Ed. for RFC when assigned https://tools.ietf.org/html/draft-ietf-netmod-rfc6087bis-15#appendix-C - Security Considerations should be updated to reflect new template at https://trac.ietf.org/trac/ops/wiki/yang-security-guidelines - Section 1.2 should be replaced with reference to draft-ietf-netmod-yang-tree-diagrams-02 rather (as-is in other i2rs YANG drafts in progress) per https://tools.ietf.org/html/draft-ietf-netmod-rfc6087bis-15#section-2.5.1 - This module contains '12' features. While it is understood the purpose of these features in the module, take precaution as to complexity for clients if they need to understand >= quantity of features per module in use on a network-element. - A few comments exist that are either unecessary or redundant. Encode the comment intent rather in description fields if need be. - Per NMDA, which datastores are targeted for the module? Will all RPC operations be acting upon the dynamic/ephemeral datastore? It is not clear to me if the intention is to be persistent or ephemeral General comments/Nits: - references to 'def' could be expanded out to 'definition' - references to 'decap' could be expanded out to 'decapsulation' for readability (across definitions and descriptions) - Follow consistent capitalization of 'RIB' throughout document text. Mixed use of 'Rib' and 'rib' exists (Outside of YANG node lowercase definitions). - Is it necessary to prefix all nodes under the nexthop container with "nexthop-"? - Section 2.5 - route-add RPC - text mentions it is required that the nh-add RPC be called as a pre-requisite however if the nh already exists and the nexthop-id is known, this should not be necessary. In addition, the text reads 'or return' which should rather be a result of querying the appropriate node in the data tree. - In 'IANA Considerations' - s/This document requests to register/This document registers/
- [yang-doctors] Yangdoctors early review of draft-… Ebben Aries
- Re: [yang-doctors] Yangdoctors early review of dr… Amit Dass
- Re: [yang-doctors] Yangdoctors early review of dr… Susan Hares
- Re: [yang-doctors] Yangdoctors early review of dr… Amit Dass
- Re: [yang-doctors] Yangdoctors early review of dr… Amit Dass
- Re: [yang-doctors] Yangdoctors early review of dr… Mahesh Jethanandani
- Re: [yang-doctors] [i2rs] Yangdoctors early revie… t.petch
- Re: [yang-doctors] Yangdoctors early review of dr… Ebben Aries
- Re: [yang-doctors] Yangdoctors early review of dr… Ebben Aries
- Re: [yang-doctors] Yangdoctors early review of dr… Reshad Rahman (rrahman)