Early Review of draft-ietf-ippm-alt-mark-yang-02
review-ietf-ippm-alt-mark-yang-02-yangdoctors-early-lindem-2026-06-01-00

Document: draft-ietf-ippm-alt-mark-yang-02
Reviewer: Acee Lindem
Review Date: 2026-06-05
IETF LC End Date: N/A
Intended Status: Proposed Standard.

This is YANG doctor early review on the YANG data module
ietf-ippm-alt-mark.yang. The YANG model is simple and straight-forward but
really needs a LOT of work.

The following issues have to be addressed:

 1. The container identifier AltMark doesn't follow the naming convention
    of hyphen separated lower-case, e.g., alt-mark or <alternate-mark>.
 2. The tree diagram in section 2 doesn't match the current YANG model.
 3. The identities measurement-period, flow-mon-id, enable-loss-measurement,
    and enable-delay-measurement are defined but not used.
 4. The XML example in Appendix A wouldn't compile.
     - <alt-mark profiles> should be <alt-mark-profiles>
     - <profile> should be <alt-mark-profile>
     - <hbh-measurement-mode> should be <hbh-measurement>
     - <altmark> is inconsistent with the ill-chosen <AltMark>.
 5. The use of "if-feature altmark" is should be at the AltMark
    container level - not at the "altmark-profile" list level.
 6. The "altmark-prifle" list should be qualified with a YANG
    must clause ensuring that the feature is enabled or change
    the statement, "It MUST be true before anything in the
    /altmark/altmark-profile can be edited." You may want to allow
    configuration without having alternate marking enabled.
 7. How did you come up with a profile name limit of 300?
 8. Since flow-mon-id is a 20-bit value, you should limit the
    uint32 with a range of 0..1048575.
 9. The IANA and Security considerations do not conform to the
    RFC 9907 template.
10. The YANG model is not indented correctly. Use
    "pyang -f yang ietf-altmark.yang" to reformat it.
11. The measurement-period is a uint64 with no explaination
    on the units or when it starts and stops.
12. Explain why there is no protocol identity for "ipv4". Also
    consider renaming this identity to "altmark-protocol" and
    the leaf to simply "protocol" rather than "protocol-type".
13. Qualify identity for "action-read" with with module prefix, i.e.,
    "altmark:action-read".
14. Check draft references for latest versions.

Consider:

Editorial suggestions:

  1. Change "It indicates" to "Indicates" in all YANG descriptions.
  2. Change "It specifies" to "Specifies" in all YANG descriptions.

MacBook-Pro-10:Desktop acee$ diff -w draft-ietf-ippm-alt-mark-yang-02-orig.txt
draft-ietf-ippm-alt-mark-yang-02.txt 183c183 <   
[I-D.ietf-ippm-alt-mark-deployment] The "protocol-type" is used to
---
>    [I-D.ietf-ippm-alt-mark-deployment]. The "protocol-type" is used to
201c201
<       marking, double marking.
---
>       marking or double marking.
206c206
<    *  node-action: indicates the operation applied to the flow (e.g.
---
>    *  node-action: indicates the operation applied to the flow (e.g.,
291c291
<         Copyright (c) 2024 IETF Trust and the persons identified as
---
>         Copyright (c) 2026 IETF Trust and the persons identified as
314,315c314
<      feature altmark
<      {
---
>      feature altmark {
317c316
<          "This feature indicated that the Alternate-Marking Method is
---
>          "This feature indicates that the Alternate-Marking Method is
382c381,382
<          "The AltMark method is applied to SRH.";
---
>          "The AltMark method is applied to Segmeent Routing Header
>           (SRH).";
416c416
<          RFC 9342";
---
>          RFC 9342.";
424c424
<          RFC 9342";
---
>          RFC 9342.";
432c432
<          RFC 9342";
---
>          RFC 9342.";
551c551,552
<          description "The Access Control Entry name is used to
---
>          description
>            "The Access Control Entry name is used to
594c595
<             take, i.e. marking/read/unmarking.";
---
>             take, i.e., marking/read/unmarking.";
606,607c607,608
<          "It specifies the FlowMonID.
<          A 20-bit flow identifier. The field is set at the marking node.
---
>          "It specifies the FlowMonID, i.e., A 20-bit flow identifier.
>           The field is set at the marking node.