[yang-doctors] YANG Doctor Review of draft-ietf-i2rs-yang-network-topo-03

Kent Watsen <kwatsen@juniper.net> Tue, 05 July 2016 18:54 UTC

Return-Path: <kwatsen@juniper.net>
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 9F7EA12D533; Tue, 5 Jul 2016 11:54:52 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.921
X-Spam-Level:
X-Spam-Status: No, score=-1.921 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, HTML_MESSAGE=0.001, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H3=-0.01, RCVD_IN_MSPIKE_WL=-0.01, SPF_HELO_PASS=-0.001, SPF_PASS=-0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (1024-bit key) header.d=junipernetworks.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 yg90Bhdwxvrp; Tue, 5 Jul 2016 11:54:50 -0700 (PDT)
Received: from NAM01-BN3-obe.outbound.protection.outlook.com (mail-bn3nam01on0136.outbound.protection.outlook.com [104.47.33.136]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id A396812D1ED; Tue, 5 Jul 2016 11:54:46 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=junipernetworks.onmicrosoft.com; s=selector1-juniper-net; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version; bh=wtMRbpsoNwBuiUO3Z+Poz5Av4JpyDlWMbTiWG1Eqmjw=; b=cTwuasApNHzYkIoXgOH+0Kyresk0I7vCrippq0voNy6lUdsbriJR2dZevh62OBdb414INztfIDvE/kp8RgpWeYM1ZPhLvpqBMGhUqpnGv9dky9H62OKqJMg+QdrFUOBCz4OLRF+EpnJQQD5otPzsfPFXX7cadenhnEcPUcKKhGY=
Received: from CY1PR0501MB1450.namprd05.prod.outlook.com (10.160.149.11) by CY1PR0501MB1452.namprd05.prod.outlook.com (10.160.149.13) with Microsoft SMTP Server (TLS) id 15.1.528.16; Tue, 5 Jul 2016 18:54:44 +0000
Received: from CY1PR0501MB1450.namprd05.prod.outlook.com ([10.160.149.11]) by CY1PR0501MB1450.namprd05.prod.outlook.com ([10.160.149.11]) with mapi id 15.01.0528.022; Tue, 5 Jul 2016 18:54:44 +0000
From: Kent Watsen <kwatsen@juniper.net>
To: "draft-ietf-i2rs-yang-network-topo.all@ietf.org" <draft-ietf-i2rs-yang-network-topo.all@ietf.org>
Thread-Topic: YANG Doctor Review of draft-ietf-i2rs-yang-network-topo-03
Thread-Index: AQHR0wjlQKb0p9i/B0yZ+nXU1OPubA==
Date: Tue, 5 Jul 2016 18:54:44 +0000
Message-ID: <330E8448-FBA4-44C4-BD99-CBE9E50D6E33@juniper.net>
Accept-Language: en-US
Content-Language: en-US
X-MS-Has-Attach:
X-MS-TNEF-Correlator:
user-agent: Microsoft-MacOutlook/f.17.0.160611
authentication-results: spf=none (sender IP is ) smtp.mailfrom=kwatsen@juniper.net;
x-ms-exchange-messagesentrepresentingtype: 1
x-originating-ip: [66.129.241.13]
x-ms-office365-filtering-correlation-id: fa8875bd-a825-4575-eff6-08d3a505d492
x-microsoft-exchange-diagnostics: 1; CY1PR0501MB1452; 6:5SfS0ZzXdqYL41wsIN4KgvLT+kaboAM3j96s/4VLt2qZzVTE2AM9fohdOavUupIpnk2QticUbZNhhSUruOwSrdLMth8okv5ezUgMM7uqwj4YFsPVsrGfIgk9kCTN7BZOL9Qq2XavSfN3RbOCWsh09kq6ku5x37ZGLOB7av93UokzsdGoUT0xh+kcARYAKVSDb1DwvvNwmP7PjdzE6yMCs1zhpAMyAOrn4YWSSzXmT2+auycFDhihfeW5YLRMg2nI2frw6W4LgLnVfrlaMkxEZnx4pqiOVZtMrS1xFL+Jdop9AvmlmfYEQFAihVMc143lA1L4xnSFeBF+YqKXLEkb4A==; 5:Juktn4K5UpBFend3NYepBRZj85+YnW1UA8m6ZIFvRy62vL1PZ2/YjKIUErp+FrVeRmdckDF5py/lk+/hFzIjxmf/VjXM1u9ChMXDYUAnBDH5J4w5MiDpRrTjHsK5q63P1eAkpocRTY8PMHU4ZPBXlA==; 24:y/bZ2I1zv/qc+9IizSh3TdnY5CHCHNStAmwrXasgPP9X2lE+1XoDnasJ09G83AaCIybOmvqO2ZwCE2qcTT6d25b+W2m3U1hh8XaZ7+9gnPo=; 7:1yf8xcrhCbAQsq88uEoU31tqLELh0BhtIX+rJ41ExWK6YBQL6c9OV1/GV/rSOCs+YJs0sorLR5v1meDEmxdo5/y71IzXDsnUBiDKgNx8h7fM/OwFwu3EMxLH6HWvhjqcJ9OTQcbd65e4hoQjLfkB5GZDPPOEP2YeIBFo1CKnpFMoyCnab1Iogq/PZ9kTBXn8hFgh18o5HbG9kNCxtRN5KL7JP+4Ht5beHs2JcH1yQ2Z2h5xaDrbpAg4oWNh46ijk
x-microsoft-antispam: UriScan:;BCL:0;PCL:0;RULEID:;SRVR:CY1PR0501MB1452;
x-microsoft-antispam-prvs: <CY1PR0501MB1452EDBBB3D0D7515E40461CA5390@CY1PR0501MB1452.namprd05.prod.outlook.com>
x-exchange-antispam-report-test: UriScan:(21748063052155);
x-exchange-antispam-report-cfa-test: BCL:0; PCL:0; RULEID:(601004)(2401047)(5005006)(8121501046)(10201501046)(3002001)(6055026); SRVR:CY1PR0501MB1452; BCL:0; PCL:0; RULEID:; SRVR:CY1PR0501MB1452;
x-forefront-prvs: 0994F5E0C5
x-forefront-antispam-report: SFV:NSPM; SFS:(10019020)(6009001)(7916002)(189002)(199003)(106356001)(19625215002)(66066001)(68736007)(2501003)(2900100001)(110136002)(99286002)(11100500001)(2906002)(122556002)(82746002)(105586002)(101416001)(15975445007)(4326007)(230783001)(106116001)(33656002)(10400500002)(3660700001)(83506001)(189998001)(77096005)(81156014)(4001350100001)(7846002)(5640700001)(87936001)(450100001)(16236675004)(586003)(19300405004)(9326002)(3280700002)(102836003)(6116002)(3846002)(5002640100001)(92566002)(83716003)(81166006)(19580395003)(7736002)(97736004)(54356999)(50986999)(2351001)(229853001)(86362001)(8676002)(8936002)(36756003)(104396002)(554374003); DIR:OUT; SFP:1102; SCL:1; SRVR:CY1PR0501MB1452; H:CY1PR0501MB1450.namprd05.prod.outlook.com; FPR:; SPF:None; PTR:InfoNoRecords; MX:1; A:1; LANG:en;
received-spf: None (protection.outlook.com: juniper.net does not designate permitted sender hosts)
spamdiagnosticoutput: 1:99
spamdiagnosticmetadata: NSPM
Content-Type: multipart/alternative; boundary="_000_330E8448FBA444C4BD99CBE9E50D6E33junipernet_"
MIME-Version: 1.0
X-OriginatorOrg: juniper.net
X-MS-Exchange-CrossTenant-originalarrivaltime: 05 Jul 2016 18:54:44.7779 (UTC)
X-MS-Exchange-CrossTenant-fromentityheader: Hosted
X-MS-Exchange-CrossTenant-id: bea78b3c-4cdb-4130-854a-1d193232e5f4
X-MS-Exchange-Transport-CrossTenantHeadersStamped: CY1PR0501MB1452
Archived-At: <https://mailarchive.ietf.org/arch/msg/yang-doctors/z0GSAzMO3vNCCRFe38g2ZGLDXZo>
Cc: YANG Doctors <yang-doctors@ietf.org>
Subject: [yang-doctors] YANG Doctor Review of draft-ietf-i2rs-yang-network-topo-03
X-BeenThere: yang-doctors@ietf.org
X-Mailman-Version: 2.1.17
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: Tue, 05 Jul 2016 18:54:52 -0000

Hi,

I am the assigned YANG doctor for this individual submission document.  This review regards the YANG modules alone.  While I did read the draft, I only did so to better understand the modules.   Note: I was hoping the draft would contain examples, but alas it does not.

This draft contains two yang modules: ietf-network and ietf-network-topology
    - ietf-network-topology imports and augments ietf-network
    - both yang modules pass `pyang --ietf` testing.

These modules are relatively small and straightforward, which makes reviewing them easy.  Below are some detailed comments on these two modules.

ietf-network
==========

·         grouping “node-ref” is defined but not used in this module, though it is used by the ietf-network-topology module.  Should the “node-ref” grouping should be moved to the ietf-network-topology module?

·         Why have top-level container “networks-state”?   Why not have the “server-provided” config false leaf in /nd:networks/nd:network/ instead?

·         Is there a need to define any notifications in this module?  - or is the plan to leverage yang-push?

ietf-network-topology
==================

·         The description statements for “link-id” and “tp-id” were not helpful.  The node is a URI, so I expect the description statement to be mostly about setting the URI value.  Example URI values would be helpful.

·         Watch capitalization on the “link” description statement: “A Network Link connects a by Local (Source) node and a Remote (Destination) Network Nodes.”

·         The sentence structure of the first sentence in the “link” description statement needs fixing.

·         Using uncommon acronyms is discouraged.  Recommend replacing “tp” with “termination-point” throughout.

·         Is the description statement for the grouping link-ref missing the word “to”?

·         The description for “supporting-termination-point” says “leaf list”, though it’s actually just a list...

·         I notice that ‘require-instance false’ is used on all leafrefs except source/dest-node and source/desy-tp, is this intentional?


Kent