[Last-Call] draft-ietf-ccamp-dwdm-if-param-yang-13 ietf last call Opsdir review

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Document: draft-ietf-ccamp-dwdm-if-param-yang
Title: A YANG data model to manage configurable DWDM optical interfaces
Reviewer: Joe Clarke
Review result: Not Ready

I have been asked to provide a last call review for this draft on behalf of the
OPS DIR.  This document defines a YANG module characterizing coherent optical
transceivers for 100 Gbps+ interfaces.  The attention to configurable
parameters, selectable modes, and various operational parameters (with alert
thresholds) is appreciated from an operational standpoint.  However, as it
stands, this document is NOT READY for publication.  I have found some
substantial issues as well as several nits.

Major Issues:

"YANG" is canonically spelled out in all capital letters.  The spelling is
mixed throughout the document as both "Yang" and "YANG".  This must be
normalized to YANG.

In the abstract, you have cross-references ([ITU-T_G.698.2] and [RFC7698]). 
The "xref" tag must not be used in abstracts.

The copyright in this document is still 2024 (and in the YANG module).  That
needs to be updated.

In Section 3.3, there is still an editor placeholder to define all of the
optical parameters.  For a last call, editor notes like this should be
resolved.  That said, IMHO it's better to make sure the YANG nodes are properly
fleshed out and documented than to ensure the same text exists in the draft. 
It is the YANG module that is of primary value.

In the module, you call out that wdm-if-tca-types may be incomplete.  If that
is the case, an enumeration may be the wrong type here.  Use of identities or a
union of identities/enums and a string for vendor-supplied experimental types
would be better.

The IANA considerations is wrong.  Your XML namespace is
urn:ietf:params:xml:ns:yang:ietf-interfaces:ietf-wdm-interface where it should
be urn:ietf:params:xml:ns:yang:ietf-wdm-interface.

In grouping wdm-if-statistics, the cur-osnr leaf has the description "OSNR
margin to FEC threshold". This description is incorrect.  It belongs to
min-osnr-margin. The description for cur-osnr should be something like "Current
Optical Signal to Noise Ratio (OSNR)".

In typedef wdm-if-tca-types, the rx-power-tca description is "The tx power
TCA". This should be "The RX power TCA" or "The receive power TCA".

Appendix D has another editor note which hints the example may be wrong or
incomplete.

Overall, I think this document would benefit from a terminology section to
expand acronyms and abbreviations.  There is also a mix of case with things
like TX, Tx, tx, RX, Rx, rx, etc.  Those should be normalized.

Nits:

Abstract: "mean to provision" should be "means to provision".

Introduction: "current-wdm-if-parameters provide" should be
"current-wdm-if-parameters provides" (as "current-wdm-if-parameters" is a
container, thus singular).

Figure 1 Caption: "netwoks" should be "networks".

Section 3.1: "This document introduce the ietf-wdm-interface model" should be
"This document introduces...".

Section 3.3: "media channels are managed" should be "media channels is managed"
since you're describing the link.

In the YANG modules itself:

pol-power-diff-tca description: "The power difference between polarization TCA"
should be "polarizations" or maybe "TCAs"???

pol-skew-diff-tca description: "The skew between the two polarization TCA"
should be "polarizations" or maybe "TCAs"???

q-factor-tca description: "Q Factor TCA" should be "Q-Factor TCA" for
consistency.

The commented-out line // uses wdm-if-fec-tca-thresholds; in the
wdm-if-mode-params grouping should be removed before publication.

Appendix D: "the way and OpenROADM" should be "the way an OpenROADM"; "in thei
draft" should be "in this draft".


-- 
last-call mailing list -- last-call@xxxxxxxx
To unsubscribe send an email to last-call-leave@xxxxxxxx




[Index of Archives]     [IETF Annoucements]     [IETF]     [IP Storage]     [Yosemite News]     [Linux SCTP]     [Linux Newbies]     [Mhonarc]     [Fedora Users]

  Powered by Linux