Early Review of draft-ietf-netmod-sub-intf-vlan-model-14
review-ietf-netmod-sub-intf-vlan-model-14-yangdoctors-early-andersson-2025-04-08-00

Hi!

This is my Early Review of draft-ietf-netmod-sub-intf-vlan-model-14.
My conclusion is that the two modules are in good shape but need updates
before publication.

Result: Ready with Nits


Note, I am not an expert on IEEE 802.1Q. My review below is regarding
the YANG modules. The document and mechanisms described are possible to
understand the document as a non-expert as well, they seem reasonable to
me during a read through.


Medium issues:

The security considerations need to be updated and mention RESTCONF as
well. Suggest to use the Security Considerations template from
rfc8407bis.

Excellent partitioning and presentation of sensitive data nodes per YANG
module!


Validating the YANG modules

ietf-if-flexible-encapsulation@2025-01-29.yang:

There are only whitespace and formatting issues with the models, all of
which are harmless

pyang ok
yanglint ok

pyang -f yang --keep-comments --yang-line-length 69 \
    ietf-if-flexible-encapsulation@2025-01-29.yang > new.yang \
&& diff ietf-if-flexible-encapsulation@2025-01-29.yang new.yang

(Omitting empty line removal differences.)

325,328c279,281
<
<         description
<           "Applies only to Ethernet-like interfaces and
<            sub-interfaces.";
---
>       description
>         "Applies only to Ethernet-like interfaces and
>          sub-interfaces.";



ietf-if-vlan-encapsulation@2025-01-29.yang:

There are only whitespace and formatting issues with the models, all of
which are harmless

pyang ok
yanglint ok

pyang -f yang --keep-comments --yang-line-length 69 \
    ietf-if-vlan-encapsulation@2025-01-29.yang > new.yang \
&& diff ietf-if-vlan-encapsulation@2025-01-29.yang new.yang

(Omitting empty line removal differences.)

81,83c76,78
<         description
<           "Applies only to Ethernet-like interfaces and
<            sub-interfaces.";
---
>       description
>         "Applies only to Ethernet-like interfaces and
>          sub-interfaces.";


Nits:

The year in the copyright stanza for ietf-if-flexible-encapsulation
needs to be updated.


Perhaps Scott Mansfield should be added to the YANG modules as an
author/editor?


RFC XXXX is referenced in both ietf-if-flexible-encapsulation and
ietf-if-vlan-encapsulation for ietf-if-extensions. However, in the
descriptions and revision references it says that
ietf-if-flexible-encapsulation is part of RFC XXXX.

The YANG module ietf-if-extensions is part of
I-D.draft-ietf-netmod-intf-ext-yang and should be referenced as such.


The YANG trees don't have they types aligned on column, it is slightly
easier on the eyes if they are. (When I emitted the trees with pyang,
the types were aligned; perhaps update the tooling to generate the
trees?)



Abstract

orignating -> originating


ietf-if-vlan-encapsulations.yang revision description

encapulations -> encapsulations


Section 10.2 Last paragraph

    are added, modified or deleted.

Oxford comma is used everywhere else in the document, change to

    are added, modified, or deleted.


Out of scope for this review but worth mentioning: The use of the
"-grouping" suffix in grouping identifiers is recommended to be avoided.
The YANG modules in this document does not do this, but the imported
IEEE 802.1Q YANG module does. If, by any chance, there is collaboration
on YANG modules, or liaisons participating in both IETF and IEEE: Please
forward this recommendation for future YANG modules. :)


--
Per