Shepherd write-up for draft-ietf-netconf-tcp-client-server-13.
Review done 2022-09-30
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?
Shepherd:
The broader set of related drafts have been discussed extensively.
The draft-ietf-netconf-tcp-client-server draft has had a small gathering
discussing with contributions from a few other individuals. There has
also been reviews from TCPM WG, see questions 2 and 5.
No objections for publication or other comments were raised for the
WGLC, hence the conclusion is that the WG has reached consensus.
Direct link to the NETCONF WGLC:
https://mailarchive.ietf.org/arch/msg/netconf/Ov3obic-u-d0xYE581Qnd474SW8/
Direct link to the TCPM WG announcement of the above WGLC:
https://mailarchive.ietf.org/arch/msg/tcpm/6cVZTDh1QB0cxBMN1-nai6fjEok/
2. Was there controversy about particular points, or were there
decisions where the consensus was particularly rough?
Shepherd:
The draft adoption was objected because the work should be done in
TCPM WG instead. This was resolved and the objectee got involved as
co-author.
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.)
Shepherd:
No one threatened appeal or indicated extreme discontent.
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)?
Shepherd:
The following existing implementations are known
https://github.com/BroadbandForum/obbaa-polt-simulatorhttps://github.com/CESNET/netopeer2
Other implementations or implementation plans are unknown at this point.
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.
Shepherd:
The TCPM WG has been continuously reviewing the document since it was
adopted in the NETCONF WG.
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.
Shepherd:
The document went through a YANG Doctor review as part of the Last Call
process. Direct link to the review:
https://datatracker.ietf.org/doc/review-ietf-netconf-tcp-client-server-09-yangdoctors-lc-lhotka-2021-04-09/
After brief discussions between reviewer and author the raised issues
were resolved by either changing or including draft content according to
YANG Doctor review. Direct link to the discussion:
https://mailarchive.ietf.org/arch/msg/netconf/BbH3yOm2xJDUfv1jN5-CvYwt88A/
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]?
Shepherd:
The document contains three YANG modules which are well written and
follow good YANG style. All three modules have passed validation with
pyang 2.5.3 and yanglint 2.0.112.
There are only whitespace and formatting issues with the models, all of
which are harmless.
pyang --ietf ietf-tcp-client@2022-09-16.yang
yanglint ietf-tcp-server@2022-09-16.yang
pyang -f yang --keep-comments --yang-line-length 69 \
ietf-tcp-client@2022-09-16.yang > new.yang \
&& diff ietf-tcp-client@2022-09-16.yang new.yang
11d10
<
17d15
<
27d24
<
36d32
<
114c110
< Note that this grouping uses fairly typical descendant
---
> Note that this grouping uses fairly typical descendant
122d117
<
237,241c232,235
< presence
< "Indicates that an authentication mechanism
< has been configured. Present so that the
< mandatory descendant nodes do not imply that
< this node must be configured.";
---
> presence "Indicates that an authentication mechanism
> has been configured. Present so that the
> mandatory descendant nodes do not imply that
> this node must be configured.";
306d299
<
pyang --ietf ietf-tcp-common@2022-09-16.yang
yanglint ietf-tcp-common@2022-09-16.yang
pyang -f yang --keep-comments --yang-line-length 69 \
ietf-tcp-common@2022-09-16.yang > new.yang \
&& diff ietf-tcp-common@2022-09-16.yang new.yang
9d8
<
18d16
<
pyang --ietf ietf-tcp-server@2022-09-16.yang
yanglint ietf-tcp-server@2022-09-16.yang
pyang -f yang --keep-comments --yang-line-length 69 \
ietf-tcp-server@2022-09-16.yang > new.yang \
&& diff ietf-tcp-server@2022-09-16.yang new.yang
11d10
<
21d19
<
30d27
<
The document and the three YANG models defined within comply with NMDA.
No protocol accessible "config false" nodes are defined.
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.
Shepherd:
The document's XML snippets have been validated with yanglint 2.0.112.
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?
Shepherd:
The document is needed, clearly written, complete, and correctly
designed.
However, a few comments need to be addressed before it is handed off to
the responsible Area director. See question 14 below.
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?
Shepherd:
No common issues have been identified, thus no further detailed review
is needed.
11. What type of RFC publication is being requested on the IETF stream
(Best Current Practice [7], Proposed Standard, Internet Standard [8],
Informational, Experimental or Historic [9])? Why is this the proper
type of RFC? Do all Datatracker state attributes correctly reflect
this intent?
Shepherd:
The RFC status requested is Proposed Standard.
This is the correct RFC status because it is a standardization of the
configuration of, and configuration parameters needed for, TCP clients
and servers
The Datatracker correctly reflects the requested RFC status:
https://datatracker.ietf.org/doc/draft-ietf-netconf-tcp-client-server/
12. Have reasonable efforts been made to remind all authors of the
intellectual property rights (IPR) disclosure obligations described
in BCP 79 [10]? 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.
Shepherd:
No IPR disclosure have been raised in reference to this document.
The WG chair requested an IPR poll. Both authors confirmed that they are
not aware of any IPR related to this document. All responses indicated
that no IPR needs to be disclosed.
Direct link to the IPR call request:
https://mailarchive.ietf.org/arch/msg/netconf/e4mExMU1gEFTf39FjuxrrZ4xFIo/
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.
Shepherd:
There are two authours for this draft and no editors or contributors.
The authors have not explicitly confirmed willingness to be listed as
authors but both have been listed as draft authors since the working
group adoption and also referenced themselves as draft
authors/co-authors in discussions. Thus, they are assumed to willingly
be listed as authors.
Both authors have been actively involved draft discussions on WG list
and both also responded to the IPR poll during WGLC (direct link to the
IPR poll
https://mailarchive.ietf.org/arch/msg/netconf/e4mExMU1gEFTf39FjuxrrZ4xFIo/).
This further implies that both authors are willingly listed as such on
this draft.
14. Document any remaining I-D nits in this document. Simply running the
idnits tool [11] is not enough; please review the "Content
Guidelines" [12] on authors.ietf.org. (Also note that the current
idnits tool generates some incorrect warnings; a rewrite is
underway.)
Shepherd:
I-D nits was tested against version 13 of the draft.
Summary: 0 errors (**), 0 flaws (~~), 12 warnings (==), 2 comments (--).
-- Obsolete informational reference (is this intentional?): RFC 793
(Obsoleted by RFC 9293)
-- The document date (24 May 2022) is 121 days in the past. Is this
intentional?
Three warnings target whitespace formatting of YANG tree diagrams
following the format from RFC 8340. The formatting is intentional and
can the warnings can be ignored.
The remaining warnings target old draft versions, one comment
mentions an old document date. All these are assumed to be fixed as part
of the standardization process.
Since RFC 793 was recently obsoleted by RFC 9293, this reference should
be updated.
Further manual review revealed that the document is in need of
corrections. Suggestions presented below.
Section 1.4
This section can be completely removed since no examples contain any
base64 encoded values.
Section 3.2
The value for /tcp-client/proxy-server/socks5-parameters/remote-address
is set to "proxy.my-domain.com". The domain "my-domain.com" is
registered and in use currently. Suggest to use a reserved domain, as
per RFC 6761, e.g. "proxy.example.net" to indicate that the proxy is
separate from the example.com remote-address defined in the tcp-client
container/grouping.
Section 6.1
This document registers two URIs (...)
-> This document registers three URIs (...)
Section 6.2
This document registers two YANG (...)
-> This document registers three YANG (...)
Section 7
List informative references related to SOCKS4 and SOCKS5 protocols, i.e.
https://www.openssh.com/txt/socks4.protocol,
https://www.openssh.com/txt/socks4a.protocol, RFC 1928, RFC 1929, and
RFC 2743.
15. Should any informative references be normative or vice-versa? See the
IESG Statement on Normative and Informative References [13].
Shepherd:
The references have been reviewed and all the document's references have
identified as either informative or normative.
Since ietf-crypto-types is imported by ietf-tcp-client, this reference
should be classified as normative and not informative.
All other references are correctly classified.
16. List any normative references that are not freely available to
anyone. Did the community have sufficient access to review any such
normative references?
Shepherd:
All normative references are freely available to the public.
17. Are there any normative downward references (see RFC 3967 [14] and
BCP 97 [15]) that are not already listed in the DOWNREF
registry [16]? If so, list them.
Shepherd:
There are no normative downward references.
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?
Shepherd:
The ietf-crypto-types draft will be submitted to IESG for review
simultaneously as this document.
Otherwise, all normative references are published.
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.
Shepherd:
The publication of this document will not change the status of any
existing RFCs.
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 [17]).
Shepherd:
The IANA Considerations section has been reviewed. The document
registers three URIs and three YANG models. (As per question 14 above,
the document at version 13 states, wrongly, that two (2) URIs and two
(2) YANG models are registered.)
All aspects of the document requiring IANA Considerations are associated
with appropriate reservations in the IANA registries.
Any referenced IANA registries are clearly identified.
Each newly created IANA registry specifies its initial contents,
allocations procedures, and reasonable names.
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.
Shepherd:
The new IANA registries will not require Designated Expert review for
future allocations.
References
[1] https://www.ietf.org/about/groups/iesg/
[2] https://datatracker.ietf.org/doc/rfc4858/
[3] https://datatracker.ietf.org/doc/rfc7942/
[4] https://trac.ietf.org/trac/ops/wiki/yang-review-tools
[5] https://datatracker.ietf.org/doc/rfc8342/
[6] https://trac.ietf.org/trac/iesg/wiki/ExpertTopics
[7] https://www.rfc-editor.org/rfc/rfc2026.html#section-5
[8] https://www.rfc-editor.org/rfc/rfc2026.html#section-4.1
[9] https://www.rfc-editor.org/rfc/rfc2026.html#section-4.2
[10] https://datatracker.ietf.org/doc/bcp79/
[11] https://www.ietf.org/tools/idnits/
[12] https://authors.ietf.org/en/content-guidelines-overview
[13] https://www.ietf.org/about/groups/iesg/statements/normative-informative-references/
[14] https://datatracker.ietf.org/doc/rfc3967/
[15] https://www.rfc-editor.org/info/bcp97
[16] https://datatracker.ietf.org/doc/downref/
[17] https://datatracker.ietf.org/doc/rfc8126/