# Document Shepherd Write-Up for Group Documents
*This version is dated 4 July 2022.*
Thank you for your service as a document shepherd. Among the responsibilities is
answering the questions in this write-up to give helpful context to Last Call
and Internet Engineering Steering Group ([IESG][1]) reviewers, and your
diligence in completing it is appreciated. The full role of the shepherd is
further described in [RFC 4858][2]. You will need the cooperation of the authors
and editors to complete these checks.
Note that some numbered items contain multiple related questions; please be sure
to answer all of them.
## Document History
1. Does the working group (WG) consensus represent the strong concurrence of a
few individuals, with others being silent, or did it reach broad agreement?
It represents a broad agreement from the subset of the working group concerned
with IOAM.
2. Was there controversy about particular points, or were there decisions where
the consensus was particularly rough?
No.
3. Has anyone threatened an appeal or otherwise indicated extreme discontent? If
so, please summarize the areas of conflict in separate email messages to the
responsible Area Director. (It should be in a separate email because this
questionnaire is publicly available.)
No.
4. For protocol documents, are there existing implementations of the contents of
the document? Have a significant number of potential implementers indicated
plans to implement? Are any existing implementations reported somewhere,
either in the document itself (as [RFC 7942][3] recommends) or elsewhere
(where)?
There are no current implementations of this document to the knowledge of the
shepherd.
## Additional Reviews
5. Do the contents of this document closely interact with technologies in other
IETF working groups or external organizations, and would it therefore benefit
from their review? Have those reviews occurred? If yes, describe which
reviews took place.
IOAM is largely defined in the IPPM wg and this is where the expertise resides.
There has been an early YANG Doctor review.
6. Describe how the document meets any required formal expert review criteria,
such as the MIB Doctor, YANG Doctor, media type, and URI type reviews.
The document contains a YANG module and must therefore receive a YANG Doctor
review.
A Yang Doctor review was performed on version 03 of the draft. The result was:
Ready with issues. A number of minor issues were identified and addressed in
subsequent revisions. Since there will be an additional YANG Doctor review later
in the process the WG chairs did not see the need for requesting a new review in
conjunction with the working group last call.
7. If the document contains a YANG module, has the final version of the module
been checked with any of the [recommended validation tools][4] for syntax and
formatting validation? If there are any resulting errors or warnings, what is
the justification for not fixing them at this time? Does the YANG module
comply with the Network Management Datastore Architecture (NMDA) as specified
in [RFC 8342][5]?
Using the online YANG Validator the tools listed below all reported No warnings or
errors:
* ***confd:** confd-8.0
* **pyang:** 2.5.3
* **xym:** 0.7.0
* **yangdump:** 21.10-12
* **yanglint:** 2.1.111
8. Describe reviews and automated checks performed to validate sections of the
final version of the document written in a formal language, such as XML code,
BNF rules, MIB definitions, CBOR's CDDL, etc.
n/a
## Document Shepherd Checks
9. Based on the shepherd's review of the document, is it their opinion that this
document is needed, clearly written, complete, correctly designed, and ready
to be handed off to the responsible Area Director?
Yes, this document adds on to the largely mature suite of documents describing
IOAM. It has been discussed and reviewed by the community and there is a
clearly stated need for it. The nits observed below have been addressed, an
early YANG doctors review has been performed.
10. Several IETF Areas have assembled [lists of common issues that their
reviewers encounter][6]. For which areas have such issues been identified
and addressed? For which does this still need to happen in subsequent
reviews?
The document contains a YANG model. It has received a YANG doctors review.
11. What type of RFC publication is being requested on the IETF stream ([Best
Current Practice][12], [Proposed Standard, Internet Standard][13],
[Informational, Experimental or Historic][14])? Why is this the proper type
of RFC? Do all Datatracker state attributes correctly reflect this intent?
Proposed Standard. This is an addition to the set of RFCs that describe IOAM.
This document describes how to configure IOAM nodes. Proposed Standard is
a reasonable RFC type.
12. Have reasonable efforts been made to remind all authors of the intellectual
property rights (IPR) disclosure obligations described in [BCP 79][7]? To
the best of your knowledge, have all required disclosures been filed? If
not, explain why. If yes, summarize any relevant discussion, including links
to publicly-available messages when applicable.
To my knowledge all required disclosures have been filed. The authors have all
indicated that they are not aware of any further IPRs that require declaration
against this document.
13. Has each author, editor, and contributor shown their willingness to be
listed as such? If the total number of authors and editors on the front page
is greater than five, please provide a justification.
Yes
14. Document any remaining I-D nits in this document. Simply running the [idnits
tool][8] is not enough; please review the ["Content Guidelines" on
authors.ietf.org][15]. (Also note that the current idnits tool generates
some incorrect warnings; a rewrite is underway.)
Update: The observed nits were fixed in revision 10 of the document.
Two references are outdated:
* draft-ietf-ippm-ioam-ipv6-options -> RFC 9486
* draft-ietf-sfc-ioam-nsh -> RFC 9452
Two references in the Normative references section are defined but not used in the
document:
* RFC 8343
* RFC 8532
Additional nits:
YANG model:
The associated description to "grouping ioam-preallocated-tracing-profile"
looks like a copy paste error:
"A grouping for incremental tracing profile."
15. Should any informative references be normative or vice-versa? See the [IESG
Statement on Normative and Informative References][16].
No.
16. List any normative references that are not freely available to anyone. Did
the community have sufficient access to review any such normative
references?
n/a
17. Are there any normative downward references (see [RFC 3967][9] and [BCP
97][10]) that are not already listed in the [DOWNREF registry][17]? If so,
list them.
n/a
18. Are there normative references to documents that are not ready to be
submitted to the IESG for publication or are otherwise in an unclear state?
If so, what is the plan for their completion?
No.
19. Will publication of this document change the status of any existing RFCs? If
so, does the Datatracker metadata correctly reflect this and are those RFCs
listed on the title page, in the abstract, and discussed in the
introduction? If not, explain why and point to the part of the document
where the relationship of this document to these other RFCs is discussed.
No.
20. Describe the document shepherd's review of the IANA considerations section,
especially with regard to its consistency with the body of the document.
Confirm that all aspects of the document requiring IANA assignments are
associated with the appropriate reservations in IANA registries. Confirm
that any referenced IANA registries have been clearly identified. Confirm
that each newly created IANA registry specifies its initial contents,
allocations procedures, and a reasonable name (see [RFC 8126][11]).
The document requests IANA to assign an XML URI and a YANG model name.
The registries are clearly identified.
The respective registration procedures are followed correctly.
21. List any new IANA registries that require Designated Expert Review for
future allocations. Are the instructions to the Designated Expert clear?
Please include suggestions of designated experts, if appropriate.
[1]: https://www.ietf.org/about/groups/iesg/
[2]: https://www.rfc-editor.org/rfc/rfc4858.html
[3]: https://www.rfc-editor.org/rfc/rfc7942.html
[4]: https://wiki.ietf.org/group/ops/yang-review-tools
[5]: https://www.rfc-editor.org/rfc/rfc8342.html
[6]: https://wiki.ietf.org/group/iesg/ExpertTopics
[7]: https://www.rfc-editor.org/info/bcp79
[8]: https://www.ietf.org/tools/idnits/
[9]: https://www.rfc-editor.org/rfc/rfc3967.html
[10]: https://www.rfc-editor.org/info/bcp97
[11]: https://www.rfc-editor.org/rfc/rfc8126.html
[12]: https://www.rfc-editor.org/rfc/rfc2026.html#section-5
[13]: https://www.rfc-editor.org/rfc/rfc2026.html#section-4.1
[14]: https://www.rfc-editor.org/rfc/rfc2026.html#section-4.2
[15]: https://authors.ietf.org/en/content-guidelines-overview
[16]: https://www.ietf.org/about/groups/iesg/statements/normative-informative-references/
[17]: https://datatracker.ietf.org/doc/downref/