Re: [yang-doctors] Yangdoctors early review of draft-ietf-i2rs-rib-data-model-09

Amit Dass <amit.dass@ericsson.com> Thu, 18 January 2018 09:53 UTC

Return-Path: <amit.dass@ericsson.com>
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 45E9F1200C5; Thu, 18 Jan 2018 01:53:08 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -4.221
X-Spam-Level:
X-Spam-Status: No, score=-4.221 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, RCVD_IN_DNSWL_MED=-2.3, RCVD_IN_MSPIKE_H3=-0.01, RCVD_IN_MSPIKE_WL=-0.01, SPF_PASS=-0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (1024-bit key) header.d=ericsson.onmicrosoft.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 egUnLBlhOeyQ; Thu, 18 Jan 2018 01:53:01 -0800 (PST)
Received: from sesbmg22.ericsson.net (sesbmg22.ericsson.net [193.180.251.48]) (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 5423312EB20; Thu, 18 Jan 2018 01:52:57 -0800 (PST)
X-AuditID: c1b4fb30-d49ff70000006bc7-91-5a606e77209e
Received: from ESESSHC015.ericsson.se (Unknown_Domain [153.88.183.63]) by sesbmg22.ericsson.net (Symantec Mail Security) with SMTP id 7C.25.27591.77E606A5; Thu, 18 Jan 2018 10:52:55 +0100 (CET)
Received: from EUR01-VE1-obe.outbound.protection.outlook.com (153.88.183.145) by oa.msg.ericsson.com (153.88.183.63) with Microsoft SMTP Server (TLS) id 14.3.352.0; Thu, 18 Jan 2018 10:52:54 +0100
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ericsson.onmicrosoft.com; s=selector1-ericsson-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version; bh=ETkBUhbjfsTH/9SxNsBu9ZBkZFyfYSYbW0omYf1fTac=; b=d6l63P6x8bm4YPYDuu9VjhhPt36XvjkpRACttq1amaw/VlsMAa9IbcROjKXLQis5sC0VCcFD6mrn6HAHxPkLTin1N9Z784HM6vPQ3nNSq3GVFDOWURBh4DGxnr5UdCrEFZUSivM9S5VFpTMecfetZUMrG1fsOkT6kwSJJZZeHt4=
Received: from HE1PR0702MB3580.eurprd07.prod.outlook.com (52.133.6.15) by HE1PR0702MB3834.eurprd07.prod.outlook.com (52.133.7.30) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P256) id 15.20.428.9; Thu, 18 Jan 2018 09:52:53 +0000
Received: from HE1PR0702MB3580.eurprd07.prod.outlook.com ([fe80::40cf:6d37:eed9:864d]) by HE1PR0702MB3580.eurprd07.prod.outlook.com ([fe80::40cf:6d37:eed9:864d%13]) with mapi id 15.20.0428.014; Thu, 18 Jan 2018 09:52:53 +0000
From: Amit Dass <amit.dass@ericsson.com>
To: Ebben Aries <exa@juniper.net>, "yang-doctors@ietf.org" <yang-doctors@ietf.org>
CC: "i2rs@ietf.org" <i2rs@ietf.org>, "draft-ietf-i2rs-rib-data-model.all@ietf.org" <draft-ietf-i2rs-rib-data-model.all@ietf.org>, "ietf@ietf.org" <ietf@ietf.org>
Thread-Topic: Yangdoctors early review of draft-ietf-i2rs-rib-data-model-09
Thread-Index: AQHTkDcKZ8fIlvBx70ukLYUj3ljGR6N5YyEA
Date: Thu, 18 Jan 2018 09:52:53 +0000
Message-ID: <HE1PR0702MB35806D6985E0A7754F840EE193E80@HE1PR0702MB3580.eurprd07.prod.outlook.com>
References: <151626438402.10775.7250014155413667607@ietfa.amsl.com>
In-Reply-To: <151626438402.10775.7250014155413667607@ietfa.amsl.com>
Accept-Language: en-US
Content-Language: en-US
X-MS-Has-Attach:
X-MS-TNEF-Correlator:
x-originating-ip: [192.176.1.92]
x-ms-publictraffictype: Email
x-microsoft-exchange-diagnostics: 1; HE1PR0702MB3834; 7:nimEf1DwRc4w5PT1h35r4PuDsWzEIGTgi313uzgWv76UiIoDnzLzRvLBtD3hPp9+lU86amkOCccnaIFYZ1AAf/KcXZgeMBxfLUK+RzesKnb26spSmMQZluUWu31UP4LJ54GlFso12LKOvHO+xaoQoU9YRMPwZtpwi0eeVeI7tqwFlmc6Z9q31R0XH01Z3SH0zRd0hA6f9EosidNtSH0xqU35bqstGVcNGO/aIaKBWC14F4uU9+dgI4Hsz+HbuTpM
x-ms-exchange-antispam-srfa-diagnostics: SSOS;
x-ms-office365-filtering-correlation-id: 66b7a1b5-8d0e-47a9-2a53-08d55e593e60
x-microsoft-antispam: UriScan:; BCL:0; PCL:0; RULEID:(7020095)(4652020)(4534125)(4602075)(4627221)(201703031133081)(201702281549075)(5600026)(4604075)(3008032)(2017052603307)(7153060)(7193020); SRVR:HE1PR0702MB3834;
x-ms-traffictypediagnostic: HE1PR0702MB3834:
x-microsoft-antispam-prvs: <HE1PR0702MB3834DB9B26365E5B42B820F693E80@HE1PR0702MB3834.eurprd07.prod.outlook.com>
x-exchange-antispam-report-test: UriScan:(192374486261705)(138986009662008);
x-exchange-antispam-report-cfa-test: BCL:0; PCL:0; RULEID:(6040492)(2401047)(5005006)(8121501046)(3231046)(2400059)(944501161)(10201501046)(3002001)(93006095)(93001095)(6041279)(20161123564045)(20161123558120)(20161123560045)(20161123562045)(201703131423095)(201702281528075)(20161123555045)(201703061421075)(201703061406153)(6072148)(201708071742011); SRVR:HE1PR0702MB3834; BCL:0; PCL:0; RULEID:(100000803126)(100110400120); SRVR:HE1PR0702MB3834;
x-forefront-prvs: 05568D1FF7
x-forefront-antispam-report: SFV:NSPM; SFS:(10009020)(39860400002)(346002)(396003)(376002)(39380400002)(366004)(199004)(189003)(13464003)(14454004)(478600001)(9686003)(966005)(6436002)(6306002)(97736004)(55016002)(8666007)(81166006)(8936002)(53936002)(229853002)(8676002)(81156014)(68736007)(4326008)(66066001)(2900100001)(33656002)(2501003)(6246003)(25786009)(5250100002)(316002)(26005)(106356001)(3846002)(6116002)(2906002)(7696005)(6346003)(230783001)(1941001)(5660300001)(86362001)(105586002)(3660700001)(2950100002)(54906003)(3280700002)(74316002)(6506007)(102836004)(59450400001)(76176011)(305945005)(110136005)(53546011)(7736002)(99286004); DIR:OUT; SFP:1101; SCL:1; SRVR:HE1PR0702MB3834; H:HE1PR0702MB3580.eurprd07.prod.outlook.com; FPR:; SPF:None; PTR:InfoNoRecords; A:1; MX:1; LANG:en;
received-spf: None (protection.outlook.com: ericsson.com does not designate permitted sender hosts)
authentication-results: spf=none (sender IP is ) smtp.mailfrom=amit.dass@ericsson.com;
x-microsoft-antispam-message-info: BlblbwrRWWOkFupU88FuZMXTdB3TdDkth/Rn6nycVDnAxqIhw78W8F34g2fqoUm79m33+Bs5y+DJNuzb/yOXjA==
spamdiagnosticoutput: 1:99
spamdiagnosticmetadata: NSPM
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: base64
MIME-Version: 1.0
X-MS-Exchange-CrossTenant-Network-Message-Id: 66b7a1b5-8d0e-47a9-2a53-08d55e593e60
X-MS-Exchange-CrossTenant-originalarrivaltime: 18 Jan 2018 09:52:53.2976 (UTC)
X-MS-Exchange-CrossTenant-fromentityheader: Hosted
X-MS-Exchange-CrossTenant-id: 92e84ceb-fbfd-47ab-be52-080c6b87953f
X-MS-Exchange-Transport-CrossTenantHeadersStamped: HE1PR0702MB3834
X-OriginatorOrg: ericsson.com
X-Brightmail-Tracker: H4sIAAAAAAAAA+NgFprCKsWRmVeSWpSXmKPExsUyM2K7vW55XkKUwfMmQYtHKzcwWbxcvZXF Yt2MDywWzzbOZ7Ho23WA0YHVY8mSn0we15uusgcwRXHZpKTmZJalFunbJXBlnP50ir3gn1bF /+cnmBoYP2h2MXJySAiYSKzc0s4EYgsJHGaU2L9TuouRC8g+wShx6dQbVhCHRaCXWeJZ9x12 iMw0JomVi+awQTjPGSX+7VzFBtLPJqAhsXb5VpYuRg4OEYEQiZkXikBqmAWWM0p8OLOCBaRG WMBLonHnDDBbRMBb4sHH66wQtpHE0SmbwO5gEVCVmLftNFgNr0CCRMfHZlaI+5wlbj4+wgxi cwq4SLzt/AdmMwqISXw/tQasl1lAXOLWk/lMEL8JSCzZc54ZwhaVePn4HyuErSDx59IjNghb VuLS/G5GkEMlBLYxSTTs74Zq1pPYOvEtI4TtKzHp80EWiKLLjBLHu3uhJulILN0xFaohX+LD 4fuMIN9LCPhI7JlUAFG/g1niwJ02qG0yEo0XJ0IN6meT+Lb7AuMERv1ZSC6fBdTPLKApsX4X VFhRYkr3Q/ZZ4MAQlDg58wnLAkaWVYyixanFSbnpRkZ6qUWZycXF+Xl6eaklmxiBaeXglt8G OxhfPnc8xCjAwajEw/vCLyFKiDWxrLgy9xCjBAezkgjvO2+gEG9KYmVValF+fFFpTmrxIUZp DhYlcd6TnrxRQgLpiSWp2ampBalFMFkmDk6pBkbR7woKv4+5zi/QtJT4dpp/otlCOW6DsMdu rL5i/V8/PZy4Unmux6ESo869p9PqZnBtZNRdZLVIIkZ2cZTa/DDFvUXzlKbpJ4Uf/m7ukRWZ UKrgt93cXC9FQv/LRq/QfYmdYZOSlBgb9AU99p55bC8//9fhzynfV91Z4PvC+O9r2UcBqRYR CUosxRmJhlrMRcWJAD3Md0gnAwAA
Archived-At: <https://mailarchive.ietf.org/arch/msg/yang-doctors/445jHYa3e6sZURQ5zR8366DwJqE>
Subject: Re: [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
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: Thu, 18 Jan 2018 09:53:08 -0000

Thanks Ebben for reviewing the draft. I will update the same based on below comments and feedback.


Best regards,
Amit

-----Original Message-----
From: Ebben Aries [mailto:exa@juniper.net] 
Sent: Thursday, January 18, 2018 9:33 AM
To: yang-doctors@ietf.org
Cc: i2rs@ietf.org; draft-ietf-i2rs-rib-data-model.all@ietf.org; ietf@ietf.org
Subject: Yangdoctors early review of draft-ietf-i2rs-rib-data-model-09

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/