[Int-dir] draft-ietf-ivy-network-inventory-yang-19 telechat Intdir review

[Haoyu Song via Datatracker <[e-mail]>]

Document: draft-ietf-ivy-network-inventory-yang
Title: A Base YANG Data Model for Network Inventory
Reviewer: Haoyu Song
Review result: Ready with Nits

I am an assigned INT directorate reviewer for
draft-ietf-ivy-network-inventory-yang-19. These comments were written primarily
for the benefit of the Internet Area Directors. Document editors and
shepherd(s) should treat these comments just like they would treat comments
from any other IETF contributors and resolve them along with any other Last
Call comments that have been received. For more details on the INT Directorate,
see https://datatracker.ietf.org/group/intdir/about/

This document defines a base YANG data model for reporting network inventory
across a network domain. The data model is application- and technology-
agnostic. The model is a read-only network model intended for northbound
controller-to-OSS or controller-to-controller interfaces. It offers a
network-wide view of discovered physical network elements and their
hardware/software components. The document has limited Internet Area impact.
The comments below list a few potential issues and some nits I noticed during
the review.

My review conclusion is: Ready with Minor Issues / Nits

------------------------------------------------
Potential issues that SHOULD be addressed.
-----------------------------------------------

1. Possible identity name mismatch? Section 3 says the document defines the
"physical-network-element" identity and a "non-hardware" identity. In Section
5, the module defines "ne-physical" and "non-hardware-component-class". Please
align the names for consistency.

2. mfg-date type uses yang:date-and-time.  Time of day is meaningless for
manufacturing date. Is yang:date a more proper type?

3. Possible errors in the Appendix E.1 JSON.
   - transceiver-module-2-1: description says "first stack port of the first
   switch"; it should be the second switch. - transceiver-module-2-2: same
   issue. description should be the second switch.

4. Appendix A, Table 2 mappings.
   - "location -> location": the base module has no location node; it is
   defined in I-D.ietf-ivy-network-inventory-location. Please say so in the
   Remark column. - "id -> uuid": the OpenConfig "id" is a vendor/device
   identifier, not necessarily a UUID. Mapping it to uuid seems wrong. -
   "subcomponents" has an empty Remark. Presumably it maps to the inverse of
   "parent"; please state that if so.

-------------------------------------------
Nits
-------------------------------------------

- Section 2.4: "Table 1 list" -> "Table 1 lists".
- Section 3.3: the attribute list omits uri, parent, parent-rel-pos, and
is-main, which are in the tree/module. - Section 3.3.1: "This model, likewise
[RFC8348]," -> "This model, like [RFC8348],". - Section 5, revision reference
and ne-type reference: "A YANG Data Model for Network Inventory" vs. the
document title "A Base YANG  Data Model for Network Inventory". - Section 5,
contact: Peruzzini's address (telecomitalia.it) and Belotti's address
(nokia.com) differ from the Authors' Addresses (fibercop.com, gmail.com) -
Section 5, name description: "The The network operator". - Section 5, is-main
description: "which can can take". - Section 6: "reports what it is actually
installed" -> "reports what is actually installed". - Appendix B: "an hardware"
-> "a hardware"; "capabable" ->  "capable". - Appendix C: "documento" ->
"document". - Appendix E: "Figure 7 describe" -> "Figure 7 describes". -
Appendix F: "cannot take any non-field replaceable modules other than pluggable
ports" is hard to parse.  Do you mean field-replaceable modules? -
Acknowledgments: "YANG Doctor eview" -> "review"; "Valery Smyslov, Samier
Barguil, and for their" a name is missing after "and"?