RESTCONF Client and Server Models
draft-ietf-netconf-restconf-client-server-38
Revision differences
Document history
Date | Rev. | By | Action |
---|---|---|---|
2024-10-04
|
38 | Mahesh Jethanandani | Changed action holders to Kent Watsen, Qiufang Ma |
2024-10-04
|
38 | Mahesh Jethanandani | Waiting for author(s) to update the Security Considerations section. |
2024-10-04
|
38 | (System) | Changed action holders to Kent Watsen (IESG state changed) |
2024-10-04
|
38 | Mahesh Jethanandani | IESG state changed to Waiting for AD Go-Ahead::Revised I-D Needed from Waiting for AD Go-Ahead |
2024-09-16
|
38 | Linda Dunbar | Request for Last Call review by GENART Completed: Ready with Nits. Reviewer: Linda Dunbar. Sent review to list. |
2024-09-13
|
38 | Joerg Ott | Request for Last Call review by TSVART Completed: Ready with Nits. Reviewer: Joerg Ott. Sent review to list. |
2024-09-13
|
38 | (System) | IESG state changed to Waiting for AD Go-Ahead from In Last Call |
2024-09-09
|
38 | (System) | IANA Review state changed to IANA OK - Actions Needed from IANA - Review Needed |
2024-09-09
|
38 | David Dong | (Via drafts-lastcall@iana.org): IESG/Authors/WG Chairs: IANA has completed its review of draft-ietf-netconf-restconf-client-server-38. If any part of this review is inaccurate, please let us know. IANA … (Via drafts-lastcall@iana.org): IESG/Authors/WG Chairs: IANA has completed its review of draft-ietf-netconf-restconf-client-server-38. If any part of this review is inaccurate, please let us know. IANA understands that, upon approval of this document, there are two actions which we must complete. First, in the ns registry in the IETF XML Registry group located at: https://www.iana.org/assignments/xml-registry/ two new namespaces will be registered as follows: ID: yang:ietf-restconf-client URI: urn:ietf:params:xml:ns:yang:ietf-restconf-client Filename: [ TBD-at-Registration ] Reference: [ RFC-to-be ] ID: yang:ietf-restconf-server URI: urn:ietf:params:xml:ns:yang:ietf-restconf-server Filename: [ TBD-at-Registration ] Reference: [ RFC-to-be ] As this document requests registrations in an Expert Review or Specification Required (see RFC 8126) registry, we have completed the required Expert Review via a separate request. Second, in the YANG Module Names registry in the YANG Parameters registry group located at: https://www.iana.org/assignments/yang-parameters/ two new YANG modules will be registered as follows: Name: ietf-restconf-client File: [ TBD-at-Registration ] Maintained by IANA? N Namespace: urn:ietf:params:xml:ns:yang:ietf-restconf-client Prefix: rcc Module: Reference: [ RFC-to-be ] Name: ietf-restconf-server File: [ TBD-at-Registration ] Maintained by IANA? N Namespace: urn:ietf:params:xml:ns:yang:ietf-restconf-server Prefix: rcs Module: Reference: [ RFC-to-be ] While the YANG module names will be registered after the IESG approves the document, the YANG module files will be posted after the RFC Editor notifies us that the document has been published. We understand that these are the only actions required to be completed upon approval of this document. NOTE: The actions requested in this document will not be completed until the document has been approved for publication as an RFC. This message is meant only to confirm the list of actions that will be performed. For definitions of IANA review states, please see: https://datatracker.ietf.org/help/state/draft/iana-review Thank you, David Dong IANA Services Sr. Specialist |
2024-09-05
|
38 | Jean Mahoney | Request for Last Call review by GENART is assigned to Linda Dunbar |
2024-09-03
|
38 | David Dong | IANA Experts State changed to Expert Reviews OK from Reviews assigned |
2024-09-03
|
38 | Magnus Westerlund | Request for Last Call review by TSVART is assigned to Joerg Ott |
2024-08-30
|
38 | David Dong | IANA Experts State changed to Reviews assigned |
2024-08-30
|
38 | Jenny Bui | IANA Review state changed to IANA - Review Needed |
2024-08-30
|
38 | Jenny Bui | The following Last Call announcement was sent out (ends 2024-09-13): From: The IESG To: IETF-Announce CC: draft-ietf-netconf-restconf-client-server@ietf.org, maqiufang1@huawei.com, mjethanandani@gmail.com, netconf-chairs@ietf.org, netconf@ietf.org … The following Last Call announcement was sent out (ends 2024-09-13): From: The IESG To: IETF-Announce CC: draft-ietf-netconf-restconf-client-server@ietf.org, maqiufang1@huawei.com, mjethanandani@gmail.com, netconf-chairs@ietf.org, netconf@ietf.org Reply-To: last-call@ietf.org Sender: Subject: Last Call: (RESTCONF Client and Server Models) to Proposed Standard The IESG has received a request from the Network Configuration WG (netconf) to consider the following document: - 'RESTCONF Client and Server Models' as Proposed Standard The IESG plans to make a decision in the next few weeks, and solicits final comments on this action. Please send substantive comments to the last-call@ietf.org mailing lists by 2024-09-13. Exceptionally, comments may be sent to iesg@ietf.org instead. In either case, please retain the beginning of the Subject line to allow automated sorting. Abstract This document presents two YANG modules, one module to configure a RESTCONF client and the other module to configure a RESTCONF server. Both modules support the TLS transport protocol with both standard RESTCONF and RESTCONF Call Home connections. Editorial Note (To be removed by RFC Editor) This draft contains placeholder values that need to be replaced with finalized values at the time of publication. This note summarizes all of the substitutions that are needed. No other RFC Editor instructions are specified elsewhere in this document. Artwork in this document contains shorthand references to drafts in progress. Please apply the following replacements (note: not all may be present): * AAAA --> the assigned RFC value for draft-ietf-netconf-crypto- types * BBBB --> the assigned RFC value for draft-ietf-netconf-trust- anchors * CCCC --> the assigned RFC value for draft-ietf-netconf-keystore * DDDD --> the assigned RFC value for draft-ietf-netconf-tcp-client- server * EEEE --> the assigned RFC value for draft-ietf-netconf-ssh-client- server * FFFF --> the assigned RFC value for draft-ietf-netconf-tls-client- server * GGGG --> the assigned RFC value for draft-ietf-netconf-http- client-server * HHHH --> the assigned RFC value for draft-ietf-netconf-netconf- client-server * IIII --> the assigned RFC value for this draft Artwork in this document contains placeholder values for the date of publication of this draft. Please apply the following replacement: * 2024-08-14 --> the publication date of this draft The "Relation to other RFCs" section Section 1.1 contains the text "one or more YANG modules" and, later, "modules". This text is sourced from a file in a context where it is unknown how many modules a draft defines. The text is not wrong as is, but it may be improved by stating more directly how many modules are defined. The "Relation to other RFCs" section Section 1.1 contains a self- reference to this draft, along with a corresponding reference in the Appendix. Please replace the self-reference in this section with "This RFC" (or similar) and remove the self-reference in the "Normative/Informative References" section, whichever it is in. Tree-diagrams in this draft may use the '\' line-folding mode defined in RFC 8792. However, nicer-to-the-eye is when the '\\' line-folding mode is used. The AD suggested suggested putting a request here for the RFC Editor to help convert "ugly" '\' folded examples to use the '\\' folding mode. "Help convert" may be interpreted as, identify what looks ugly and ask the authors to make the adjustment. The following Appendix section is to be removed prior to publication: * Appendix A. Change Log The file can be obtained via https://datatracker.ietf.org/doc/draft-ietf-netconf-restconf-client-server/ No IPR declarations have been submitted directly on this I-D. |
2024-08-30
|
38 | Jenny Bui | IESG state changed to In Last Call from Last Call Requested |
2024-08-30
|
38 | Mahesh Jethanandani | Last call was requested |
2024-08-30
|
38 | Mahesh Jethanandani | Last call announcement was generated |
2024-08-30
|
38 | Mahesh Jethanandani | Ballot approval text was generated |
2024-08-30
|
38 | Mahesh Jethanandani | Ballot writeup was generated |
2024-08-30
|
38 | Mahesh Jethanandani | While we wait for SECDIR review, which I hope comes in before the LC expires, YANG doctor and OPSDIR have given their approval of the … While we wait for SECDIR review, which I hope comes in before the LC expires, YANG doctor and OPSDIR have given their approval of the document. |
2024-08-30
|
38 | Mahesh Jethanandani | IESG state changed to Last Call Requested from AD Evaluation |
2024-08-28
|
38 | Jan Lindblad | Request for Last Call review by OPSDIR Completed: Ready. Reviewer: Jan Lindblad. Sent review to list. |
2024-08-27
|
38 | Mahesh Jethanandani | Changed action holders to Mahesh Jethanandani |
2024-08-26
|
38 | Andy Bierman | Request for Last Call review by YANGDOCTORS Completed: Ready. Reviewer: Andy Bierman. Sent review to list. |
2024-08-22
|
38 | Carlos Pignataro | Request for Last Call review by OPSDIR is assigned to Jan Lindblad |
2024-08-16
|
38 | Mehmet Ersue | Request for Last Call review by YANGDOCTORS is assigned to Andy Bierman |
2024-08-15
|
38 | Tero Kivinen | Request for Last Call review by SECDIR is assigned to Alexey Melnikov |
2024-08-15
|
38 | Mahesh Jethanandani | Requested Last Call review by YANGDOCTORS |
2024-08-15
|
38 | Mahesh Jethanandani | Requested Last Call review by OPSDIR |
2024-08-15
|
38 | Mahesh Jethanandani | Requested Last Call review by SECDIR |
2024-08-14
|
38 | Kent Watsen | New version available: draft-ietf-netconf-restconf-client-server-38.txt |
2024-08-14
|
38 | Kent Watsen | New version accepted (logged-in submitter: Kent Watsen) |
2024-08-14
|
38 | Kent Watsen | Uploaded new revision |
2024-07-08
|
37 | Kent Watsen | New version available: draft-ietf-netconf-restconf-client-server-37.txt |
2024-07-08
|
37 | Kent Watsen | New version accepted (logged-in submitter: Kent Watsen) |
2024-07-08
|
37 | Kent Watsen | Uploaded new revision |
2024-03-20
|
36 | Liz Flynn | Shepherding AD changed to Mahesh Jethanandani |
2024-03-16
|
36 | Kent Watsen | New version available: draft-ietf-netconf-restconf-client-server-36.txt |
2024-03-16
|
36 | Kent Watsen | New version accepted (logged-in submitter: Kent Watsen) |
2024-03-16
|
36 | Kent Watsen | Uploaded new revision |
2024-03-01
|
35 | Kent Watsen | New version available: draft-ietf-netconf-restconf-client-server-35.txt |
2024-03-01
|
35 | Kent Watsen | New version accepted (logged-in submitter: Kent Watsen) |
2024-03-01
|
35 | Kent Watsen | Uploaded new revision |
2024-02-22
|
34 | Kent Watsen | New version available: draft-ietf-netconf-restconf-client-server-34.txt |
2024-02-22
|
34 | Kent Watsen | New version accepted (logged-in submitter: Kent Watsen) |
2024-02-22
|
34 | Kent Watsen | Uploaded new revision |
2024-02-09
|
33 | Kent Watsen | New version available: draft-ietf-netconf-restconf-client-server-33.txt |
2024-02-09
|
33 | Kent Watsen | New version accepted (logged-in submitter: Kent Watsen) |
2024-02-09
|
33 | Kent Watsen | Uploaded new revision |
2024-02-04
|
32 | Kent Watsen | New version available: draft-ietf-netconf-restconf-client-server-32.txt |
2024-02-04
|
32 | Kent Watsen | New version accepted (logged-in submitter: Kent Watsen) |
2024-02-04
|
32 | Kent Watsen | Uploaded new revision |
2024-01-26
|
31 | Kent Watsen | New version available: draft-ietf-netconf-restconf-client-server-31.txt |
2024-01-26
|
31 | Kent Watsen | New version accepted (logged-in submitter: Kent Watsen) |
2024-01-26
|
31 | Kent Watsen | Uploaded new revision |
2023-12-28
|
30 | Kent Watsen | New version available: draft-ietf-netconf-restconf-client-server-30.txt |
2023-12-28
|
30 | Kent Watsen | New version accepted (logged-in submitter: Kent Watsen) |
2023-12-28
|
30 | Kent Watsen | Uploaded new revision |
2023-06-29
|
29 | (System) | Changed action holders to Robert Wilton (IESG state changed) |
2023-06-29
|
29 | Robert Wilton | IESG state changed to AD Evaluation from Publication Requested |
2023-04-17
|
29 | Kent Watsen | New version available: draft-ietf-netconf-restconf-client-server-29.txt |
2023-04-17
|
29 | Kent Watsen | New version accepted (logged-in submitter: Kent Watsen) |
2023-04-17
|
29 | Kent Watsen | Uploaded new revision |
2022-12-12
|
28 | Mahesh Jethanandani | # 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 … # 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? Shepherd: The document has only one author actively involved in the progression of the document. But this document has been progressed for more than 6 years and has been reviewed multiple times during their life time with 2 rounds of WGLC. That said, the shepherd thinks that this document has reached a broad agreement as this WG would be expected to reach. 2. Was there controversy about particular points, or were there decisions where the consensus was particularly rough? Shepherd: There was no controversy about particular points, and the shepherd doesn't notice any decisions where the consensus was particularly rough. This document has received enough review in both WG meeting and on the NETCONF WG mailing list, the authors and shepherd believe that all the comments and questions from that review have be incorporated into the document. 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 an appeal or otherwise 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 shepherd knows neither existing nor potential implementations of YANG models defined in this document. No existing implementations have been publicly reported. But client-server suites of documents have always been urged to move forward and the shepherd notices that this document is referenced by RFC 8783(https://datatracker.ietf.org/doc/rfc8783/) that could use YANG modules defined in this document for RESTCONF connection management between the DOTS client and server, both of which are very likely to lead to implementation. ## 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 shepherd doesn’t think the contents of this document closely interact with technologies in other IEF working groups or external organizations, and therefore the shepherd doesn’t believe this document needs review from other IETF working groups or external organizations. The shepherd doesn't see any public review from other IETF working groups or external organizations occurred before. 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: This document defines two YANG modules. It went through a YANG doctors last call review by Andy Bierman, and here is a direct link to that review: https://datatracker.ietf.org/doc/review-ietf-netconf-restconf-client-server-04-yangdoctors-lc-bierman-2017-07-28/ And here is the related discussion about the Yang doctor last call review on the NETCONF WG mailing list: https://mailarchive.ietf.org/arch/msg/netconf/AqFxL5A8lvLQYKzNv_ssi_y0THU/ 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: Yes, the document contains two YANG modules. Both have passed through `pyang` and `yanglint` validation, no errors or warnings have been flagged out. DataTracker’s YANG validator also reports 0 errors and 0 warnings. The shepherd has used the following command to check both YANG modules with no output: $ pyang --ietf ietf-restconf-client@2022-10-19.yang $yanglint ietf-restconf-client@2022-10-19.yang $pyang --ietf ietf-restconf-server@2022-10-19.yang $yanglint ietf-restconf-server@2022-10-19.yang The shepherd also tested the formatting using the command: $pyang -f yang --keep-comments --yang-line-length 69 ietf-restconf-client@2022-10-19.yang >test1.yang && diff ietf-restconf-client@2022-10-19.yang test1.yang The following results are returned which the shepherd thinks is innocuous: 110c104 < description --- > description 138d131 < 148,149c141,143 < must 'tls-client-parameters/client-identity < or http-client-parameters/client-identity'; --- > must > "tls-client-parameters/client-identity > or http-client-parameters/client-identity"; 254,255c248,250 < must 'tls-client-parameters/client-identity < or http-client-parameters/client-identity'; --- > must > "tls-client-parameters/client-identity > or http-client-parameters/client-identity"; 328d322 < 522c516 < if-feature central-restconf-client-supported; --- > if-feature "central-restconf-client-supported"; 528d521 < $pyang -f yang --keep-comments --yang-line-length 69 ietf-restconf-server@2022-10-19.yang >test2.yang && diff ietf-restconf-server@2022-10-19.yang test2.yang The following results are returned which the shepherd thinks is innocuous: 122c114 < description --- > description 149d140 < 191,195c182,185 < presence < "Identifies that an external endpoint has been < configured. This statement is present so the < mandatory descendant nodes do not imply that < this node must be configured."; --- > presence "Identifies that an external endpoint has been > configured. This statement is present so the > mandatory descendant nodes do not imply that > this node must be configured."; 562c549 < if-feature central-restconf-server-supported; --- > if-feature "central-restconf-server-supported"; 568d554 < Both of the YANG modules defined in this document comply with the Network Management Datastore Architecture (NMDA) as specified in [RFC 8342]. 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 Shepherd has read the document, tested it against "idnits", and validated the syntactical correctness of both modules defined in the document using "pyang" and "yanglint", with neither returning any errors or warnings. The shepherd also checked the XML code in the document using "yanglint" without returning any errors or warnings. ## 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: Yes. Based on the shepherd's review of the document, it is the shepherd's opinion that this document is needed, clearly written, Complete, correctly designed and ready to be handed off to the responsible Area Director. 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: The shepherd took a look at https://trac.ietf.org/trac/iesg/wiki/ExpertTopics but didn't find any issues that related to this document. There is nothing that would merit specific attention from subsequent reviews. 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? Shepherd: The intended RFC status is proposed standard. This is an appropriate type of RFC for YANG models that will be implemented and must interoperate. And Datatracker state attributes correctly reflect this intent (here is the direct link: https://datatracker.ietf.org/doc/draft-ietf-netconf-restconf-client-server/). 12. Have reasonable efforts been made to remind all authors of the intellectual property rights (IPR) disclosure obligations described in [BCP 79][8]? 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 has been filed that applies to this document. The chair has requested an IPR call on the list as part of WGLC process. The author confirmed that he is unaware of any IPR related to this document. Thus there is no IPR needs to be disclosed. Here is the directed link to the IPR call request: https://mailarchive.ietf.org/arch/msg/netconf/nCeZIQA91_cewM2D0xsHqe5dutY/ 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 is only one author listed on the front page who has always been actively involved in progressing this work without any other editor and contributor. 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.) Shepherd: I-D nits has been tested against v-27 (here is the direct link: https://author-tools.ietf.org/api/idnits?url=https://www.ietf.org/archive/id/draft-ietf-netconf-restconf-client-server-27.txt), and it reports 0 error (**), 0 flaws (~~), 10 warnings (==), 0 comment (--), which are innocuous. Manual check of content guidelines reveals no issues. 15. Should any informative references be normative or vice-versa? See the [IESG Statement on Normative and Informative References][16]. Shepherd: The shepherd has checked all the normative and informative references and thinks that all the 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 anyone. 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. Shepherd: There is 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: This document has normative references to other client-server and security suites of documents(I-D.ietf-netconf-http-client-server, I-D.ietf-netconf-keystore, I-D.ietf-netconf-tcp-client-server, I-D.ietf-netconf-tls-client-server). It has been planned to submit the set of drafts to the IESG for publication as a cluster. 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: No, 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][11]). Shepherd: The shepherd has reviewed the IANA consideration section and checked its consistency with the body of the document. The shepherd confirmed that all aspects of the document requiring IANA assignments are associated with the appropriate reservations in IANA registries and any referenced IANA registries have been clearly identified. There is no newly created IANA registry in this document. 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: There is no new IANA registries, thus this document doesn’t require Designated Expert Review for future allocations. [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://trac.ietf.org/trac/ops/wiki/yang-review-tools [5]: https://www.rfc-editor.org/rfc/rfc8342.html [6]: https://trac.ietf.org/trac/iesg/wiki/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/ |
2022-12-12
|
28 | Mahesh Jethanandani | Responsible AD changed to Robert Wilton |
2022-12-12
|
28 | Mahesh Jethanandani | IETF WG state changed to Submitted to IESG for Publication from WG Consensus: Waiting for Write-Up |
2022-12-12
|
28 | Mahesh Jethanandani | IESG state changed to Publication Requested from I-D Exists |
2022-12-12
|
28 | Mahesh Jethanandani | Document is now in IESG state Publication Requested |
2022-12-12
|
28 | Mahesh Jethanandani | Notification list changed to maqiufang1@huawei.com, mjethanandani@gmail.com from maqiufang1@huawei.com |
2022-12-12
|
28 | Kent Watsen | New version available: draft-ietf-netconf-restconf-client-server-28.txt |
2022-12-12
|
28 | Kent Watsen | New version accepted (logged-in submitter: Kent Watsen) |
2022-12-12
|
28 | Kent Watsen | Uploaded new revision |
2022-10-20
|
27 | Qiufang Ma | # 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 … # 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? Shepherd: The document has only one author actively involved in the progression of the document. But this document has been progressed for more than 6 years and has been reviewed multiple times during their life time with 2 rounds of WGLC. That said, the shepherd thinks that this document has reached a broad agreement as this WG would be expected to reach. 2. Was there controversy about particular points, or were there decisions where the consensus was particularly rough? Shepherd: There was no controversy about particular points, and the shepherd doesn't notice any decisions where the consensus was particularly rough. This document has received enough review in both WG meeting and on the NETCONF WG mailing list, the authors and shepherd believe that all the comments and questions from that review have be incorporated into the document. 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 an appeal or otherwise 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 shepherd knows neither existing nor potential implementations of YANG models defined in this document. No existing implementations have been publicly reported. But client-server suites of documents have always been urged to move forward and the shepherd notices that this document is referenced by RFC 8783(https://datatracker.ietf.org/doc/rfc8783/) that could use YANG modules defined in this document for RESTCONF connection management between the DOTS client and server, both of which are very likely to lead to implementation. ## 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 shepherd doesn’t think the contents of this document closely interact with technologies in other IEF working groups or external organizations, and therefore the shepherd doesn’t believe this document needs review from other IETF working groups or external organizations. The shepherd doesn't see any public review from other IETF working groups or external organizations occurred before. 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: This document defines two YANG modules. It went through a YANG doctors last call review by Andy Bierman, and here is a direct link to that review: https://datatracker.ietf.org/doc/review-ietf-netconf-restconf-client-server-04-yangdoctors-lc-bierman-2017-07-28/ And here is the related discussion about the Yang doctor last call review on the NETCONF WG mailing list: https://mailarchive.ietf.org/arch/msg/netconf/AqFxL5A8lvLQYKzNv_ssi_y0THU/ 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: Yes, the document contains two YANG modules. Both have passed through `pyang` and `yanglint` validation, no errors or warnings have been flagged out. DataTracker’s YANG validator also reports 0 errors and 0 warnings. The shepherd has used the following command to check both YANG modules with no output: $ pyang --ietf ietf-restconf-client@2022-10-19.yang $yanglint ietf-restconf-client@2022-10-19.yang $pyang --ietf ietf-restconf-server@2022-10-19.yang $yanglint ietf-restconf-server@2022-10-19.yang The shepherd also tested the formatting using the command: $pyang -f yang --keep-comments --yang-line-length 69 ietf-restconf-client@2022-10-19.yang >test1.yang && diff ietf-restconf-client@2022-10-19.yang test1.yang The following results are returned which the shepherd thinks is innocuous: 110c104 < description --- > description 138d131 < 148,149c141,143 < must 'tls-client-parameters/client-identity < or http-client-parameters/client-identity'; --- > must > "tls-client-parameters/client-identity > or http-client-parameters/client-identity"; 254,255c248,250 < must 'tls-client-parameters/client-identity < or http-client-parameters/client-identity'; --- > must > "tls-client-parameters/client-identity > or http-client-parameters/client-identity"; 328d322 < 522c516 < if-feature central-restconf-client-supported; --- > if-feature "central-restconf-client-supported"; 528d521 < $pyang -f yang --keep-comments --yang-line-length 69 ietf-restconf-server@2022-10-19.yang >test2.yang && diff ietf-restconf-server@2022-10-19.yang test2.yang The following results are returned which the shepherd thinks is innocuous: 122c114 < description --- > description 149d140 < 191,195c182,185 < presence < "Identifies that an external endpoint has been < configured. This statement is present so the < mandatory descendant nodes do not imply that < this node must be configured."; --- > presence "Identifies that an external endpoint has been > configured. This statement is present so the > mandatory descendant nodes do not imply that > this node must be configured."; 562c549 < if-feature central-restconf-server-supported; --- > if-feature "central-restconf-server-supported"; 568d554 < Both of the YANG modules defined in this document comply with the Network Management Datastore Architecture (NMDA) as specified in [RFC 8342]. 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 Shepherd has read the document, tested it against "idnits", and validated the syntactical correctness of both modules defined in the document using "pyang" and "yanglint", with neither returning any errors or warnings. The shepherd also checked the XML code in the document using "yanglint" without returning any errors or warnings. ## 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: Yes. Based on the shepherd's review of the document, it is the shepherd's opinion that this document is needed, clearly written, Complete, correctly designed and ready to be handed off to the responsible Area Director. 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: The shepherd took a look at https://trac.ietf.org/trac/iesg/wiki/ExpertTopics but didn't find any issues that related to this document. There is nothing that would merit specific attention from subsequent reviews. 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? Shepherd: The intended RFC status is proposed standard. This is an appropriate type of RFC for YANG models that will be implemented and must interoperate. And Datatracker state attributes correctly reflect this intent (here is the direct link: https://datatracker.ietf.org/doc/draft-ietf-netconf-restconf-client-server/). 12. Have reasonable efforts been made to remind all authors of the intellectual property rights (IPR) disclosure obligations described in [BCP 79][8]? 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 has been filed that applies to this document. The chair has requested an IPR call on the list as part of WGLC process. The author confirmed that he is unaware of any IPR related to this document. Thus there is no IPR needs to be disclosed. Here is the directed link to the IPR call request: https://mailarchive.ietf.org/arch/msg/netconf/nCeZIQA91_cewM2D0xsHqe5dutY/ 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 is only one author listed on the front page who has always been actively involved in progressing this work without any other editor and contributor. 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.) Shepherd: I-D nits has been tested against v-27 (here is the direct link: https://author-tools.ietf.org/api/idnits?url=https://www.ietf.org/archive/id/draft-ietf-netconf-restconf-client-server-27.txt), and it reports 0 error (**), 0 flaws (~~), 10 warnings (==), 0 comment (--), which are innocuous. Manual check of content guidelines reveals no issues. 15. Should any informative references be normative or vice-versa? See the [IESG Statement on Normative and Informative References][16]. Shepherd: The shepherd has checked all the normative and informative references and thinks that all the 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 anyone. 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. Shepherd: There is 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: This document has normative references to other client-server and security suites of documents(I-D.ietf-netconf-http-client-server, I-D.ietf-netconf-keystore, I-D.ietf-netconf-tcp-client-server, I-D.ietf-netconf-tls-client-server). It has been planned to submit the set of drafts to the IESG for publication as a cluster. 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: No, 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][11]). Shepherd: The shepherd has reviewed the IANA consideration section and checked its consistency with the body of the document. The shepherd confirmed that all aspects of the document requiring IANA assignments are associated with the appropriate reservations in IANA registries and any referenced IANA registries have been clearly identified. There is no newly created IANA registry in this document. 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: There is no new IANA registries, thus this document doesn’t require Designated Expert Review for future allocations. [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://trac.ietf.org/trac/ops/wiki/yang-review-tools [5]: https://www.rfc-editor.org/rfc/rfc8342.html [6]: https://trac.ietf.org/trac/iesg/wiki/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/ |
2022-10-19
|
27 | Kent Watsen | New version available: draft-ietf-netconf-restconf-client-server-27.txt |
2022-10-19
|
27 | Kent Watsen | New version accepted (logged-in submitter: Kent Watsen) |
2022-10-19
|
27 | Kent Watsen | Uploaded new revision |
2022-09-14
|
26 | Qiufang Ma | # 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 … # 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? Shepherd: The document has only one author with other WG members actively reviewing and commenting. This document has been progressed for more than 6 years and has been reviewed multiple times during their life time with 2 rounds of WGLC. That said, the shepherd thinks that this document has reached a broad agreement as this WG would be expected to reach. 2. Was there controversy about particular points, or were there decisions where the consensus was particularly rough? Shepherd: There was no controversy about particular points, and the shepherd doesn't notice any decisions where the consensus was particularly rough. This document has received enough review in both WG meeting and on the NETCONF WG mailing list, the authors and shepherd believe that all the comments and questions from that review have be incorporated into the document. 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 an appeal or otherwise 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 shepherd knows neither existing nor potential implementations of YANG models defined in this document. No existing implementations have been publicly reported. But client-server suites of documents have always been urged to move forward and the shepherd notices that this document is referenced by RFC 8783(https://datatracker.ietf.org/doc/rfc8783/) that could use YANG modules defined in this document for RESTCONF connection management between the DOTS client and server, both of which are very likely to lead to implementation. ## 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 shepherd doesn’t think the contents of this document closely interact with technologies in other IEF working groups or external organizations, and therefore the shepherd doesn’t believe this document needs review from other IETF working groups or external organizations. The shepherd doesn't see any public review from other IETF working groups or external organizations occurred before. 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: This document defines two YANG modules. It went through a YANG doctors last call review by Andy Bierman, and here is a direct link to that review: https://datatracker.ietf.org/doc/review-ietf-netconf-restconf-client-server-04-yangdoctors-lc-bierman-2017-07-28/ And here is the related discussion about the Yang doctor last call review on the NETCONF WG mailing list: https://mailarchive.ietf.org/arch/msg/netconf/AqFxL5A8lvLQYKzNv_ssi_y0THU/ 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: Yes, the document contains two YANG modules. Both have passed through `pyang` and `yanglint` validation, no errors or warnings have been flagged out. DataTracker’s YANG validator also reports 0 errors and 0 warnings. The shepherd has used the following command to check both YANG modules with no output: $ pyang --ietf ietf-restconf-client@2022-05-24.yang $yanglint ietf-restconf-client@2022-05-24.yang $pyang --ietf ietf-restconf-server@2022-05-24.yang $yanglint ietf-restconf-server@2022-05-24.yang The shepherd also tested the formatting using the command: $pyang -f yang --keep-comments --yang-line-length 69 ietf-restconf-client@2022-05-24.yang >test1.yang && diff ietf-restconf-client@2022-05-24.yang test1.yang The following results are returned which the shepherd thinks is innocuous: 110c104 < description --- > description 138d131 < 148,149c141,143 < must 'tls-client-parameters/client-identity < or http-client-parameters/client-identity'; --- > must > "tls-client-parameters/client-identity > or http-client-parameters/client-identity"; 254,255c248,250 < must 'tls-client-parameters/client-identity < or http-client-parameters/client-identity'; --- > must > "tls-client-parameters/client-identity > or http-client-parameters/client-identity"; 328d322 < 522c516 < if-feature central-restconf-client-supported; --- > if-feature "central-restconf-client-supported"; 528d521 < $pyang -f yang --keep-comments --yang-line-length 69 ietf-restconf-server@2022-05-24.yang >test2.yang && diff ietf-restconf-server@2022-05-24.yang test2.yang The following results are returned which the shepherd thinks is innocuous: 122c114 < description --- > description 149d140 < 191,195c182,185 < presence < "Identifies that an external endpoint has been < configured. This statement is present so the < mandatory descendant nodes do not imply that < this node must be configured."; --- > presence "Identifies that an external endpoint has been > configured. This statement is present so the > mandatory descendant nodes do not imply that > this node must be configured."; 562c549 < if-feature central-restconf-server-supported; --- > if-feature "central-restconf-server-supported"; 568d554 < Both of the YANG modules defined in this document comply with the Network Management Datastore Architecture (NMDA) as specified in [RFC 8342]. 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 Shepherd has read the document, tested it against "idnits", and validated the syntactical correctness of both modules defined in the document using "pyang" and "yanglint", with neither returning any errors or warnings. The shepherd also checked the XML code in the document using "yanglint" without returning any errors or warnings. ## 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: Yes. Based on the shepherd's review of the document, it is the shepherd's opinion that this document is needed, clearly written, Complete, correctly designed and ready to be handed off to the responsible Area Director. 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: The shepherd took a look at https://trac.ietf.org/trac/iesg/wiki/ExpertTopics but didn't find any issues that related to this document. There is nothing that would merit specific attention from subsequent reviews. 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? Shepherd: The intended RFC status is proposed standard. This is an appropriate type of RFC for YANG models that will be implemented and must interoperate. And Datatracker state attributes correctly reflect this intent (here is the direct link: https://datatracker.ietf.org/doc/draft-ietf-netconf-restconf-client-server/). 12. Have reasonable efforts been made to remind all authors of the intellectual property rights (IPR) disclosure obligations described in [BCP 79][8]? 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 has been filed that applies to this document. The chair has requested an IPR call on the list as part of WGLC process. The author confirmed that he is unaware of any IPR related to this document. Thus there is no IPR needs to be disclosed. Here is the directed link to the IPR call request: https://mailarchive.ietf.org/arch/msg/netconf/nCeZIQA91_cewM2D0xsHqe5dutY/ 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 is only one author listed on the front page who has always been actively involved in progressing this work without any other editor and contributor. 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.) Shepherd: I-D nits has been tested against v-26 (here is the direct link: https://author-tools.ietf.org/api/idnits?url=https://www.ietf.org/archive/id/draft-ietf-netconf-restconf-client-server-26.txt), and it reports 0 error (**), 0 flaws (~~), 10 warnings (==), 1 comment (--), which are innocuous. Manual check of content guidelines reveals no issues. 15. Should any informative references be normative or vice-versa? See the [IESG Statement on Normative and Informative References][16]. Shepherd: The shepherd has checked all the normative and informative references and thinks that all the 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 anyone. 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. Shepherd: There is 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: This document has normative references to other client-server and security suites of documents(I-D.ietf-netconf-http-client-server, I-D.ietf-netconf-keystore, I-D.ietf-netconf-tcp-client-server, I-D.ietf-netconf-tls-client-server). It has been planned to submit the set of drafts to the IESG for publication as a cluster. 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: No, 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][11]). Shepherd: The shepherd has reviewed the IANA consideration section and checked its consistency with the body of the document. The shepherd confirmed that all aspects of the document requiring IANA assignments are associated with the appropriate reservations in IANA registries and any referenced IANA registries have been clearly identified. There is no newly created IANA registry in this document. 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: There is no new IANA registries, thus this document doesn’t require Designated Expert Review for future allocations. [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://trac.ietf.org/trac/ops/wiki/yang-review-tools [5]: https://www.rfc-editor.org/rfc/rfc8342.html [6]: https://trac.ietf.org/trac/iesg/wiki/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/ |
2022-09-14
|
26 | Qiufang Ma | # 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 … # 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? Shepherd: The document has only one author with other WG members actively reviewing and commenting. This document has been progressed for more than 6 years and has been reviewed multiple times during their life time with 2 rounds of WGLC. That said, the shepherd thinks that this document has reached a broad agreement as this WG would be expected to reach. 2. Was there controversy about particular points, or were there decisions where the consensus was particularly rough? Shepherd: There was no controversy about particular points, and the shepherd doesn't notice any decisions where the consensus was particularly rough. This document has received enough review in both WG meeting and on the NETCONF WG mailing list, the authors and shepherd believe that all the comments and questions from that review have be incorporated into the document. 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 an appeal or otherwise 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 shepherd knows neither existing nor potential implementations of YANG models defined in this document. No existing implementations have been publicly reported. But client-server suites of documents have always been urged to move forward and the shepherd notices that this document is referenced by RFC 8783(https://datatracker.ietf.org/doc/rfc8783/) that could use YANG modules defined in this document for RESTCONF connection management between the DOTS client and server, both of which are very likely to lead to implementation. ## 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 shepherd doesn’t think the contents of this document closely interact with technologies in other IEF working groups or external organizations, and therefore the shepherd doesn’t believe this document needs review from other IETF working groups or external organizations. The shepherd doesn't see any public review from other IETF working groups or external organizations occurred before. 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: This document defines two YANG modules. It went through a YANG doctors last call review by Andy Bierman, and here is a direct link to that review: https://datatracker.ietf.org/doc/review-ietf-netconf-restconf-client-server-04-yangdoctors-lc-bierman-2017-07-28/ And here is the related discussion about the Yang doctor last call review on the NETCONF WG mailing list: https://mailarchive.ietf.org/arch/msg/netconf/AqFxL5A8lvLQYKzNv_ssi_y0THU/ 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: Yes, the document contains two YANG modules. Both have passed through `pyang` and `yanglint` validation, no errors or warnings have been flagged out. DataTracker’s YANG validator also reports 0 errors and 0 warnings. The shepherd has used the following command to check both YANG modules with no output: $ pyang --ietf ietf-restconf-client@2022-05-24.yang $yanglint ietf-restconf-client@2022-05-24.yang $pyang --ietf ietf-restconf-server@2022-05-24.yang $yanglint ietf-restconf-server@2022-05-24.yang The shepherd also tested the formatting using the command: $pyang -f yang --keep-comments --yang-line-length 69 ietf-restconf-client@2022-05-24.yang >test1.yang && diff ietf-restconf-client@2022-05-24.yang test1.yang The following results are returned which the shepherd thinks is innocuous: 110c104 < description --- > description 138d131 < 148,149c141,143 < must 'tls-client-parameters/client-identity < or http-client-parameters/client-identity'; --- > must > "tls-client-parameters/client-identity > or http-client-parameters/client-identity"; 254,255c248,250 < must 'tls-client-parameters/client-identity < or http-client-parameters/client-identity'; --- > must > "tls-client-parameters/client-identity > or http-client-parameters/client-identity"; 328d322 < 522c516 < if-feature central-restconf-client-supported; --- > if-feature "central-restconf-client-supported"; 528d521 < $pyang -f yang --keep-comments --yang-line-length 69 ietf-restconf-server@2022-05-24.yang >test2.yang && diff ietf-restconf-server@2022-05-24.yang test2.yang The following results are returned which the shepherd thinks is innocuous: 122c114 < description --- > description 149d140 < 191,195c182,185 < presence < "Identifies that an external endpoint has been < configured. This statement is present so the < mandatory descendant nodes do not imply that < this node must be configured."; --- > presence "Identifies that an external endpoint has been > configured. This statement is present so the > mandatory descendant nodes do not imply that > this node must be configured."; 562c549 < if-feature central-restconf-server-supported; --- > if-feature "central-restconf-server-supported"; 568d554 < Both of the YANG modules defined in this document comply with the Network Management Datastore Architecture (NMDA) as specified in [RFC 8342]. 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 Shepherd has read the document, tested it against "idnits", and validated the syntactical correctness of both modules defined in the document using "pyang" and "yanglint", with neither returning any errors or warnings. The shepherd also checked the XML code in the document using "yanglint" without returning any errors or warnings. ## 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: Yes. Based on the shepherd's review of the document, it is the shepherd's opinion that this document is needed, clearly written, Complete, correctly designed and ready to be handed off to the responsible Area Director. 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: The shepherd took a look at https://trac.ietf.org/trac/iesg/wiki/ExpertTopics but didn't find any issues that related to this document. There is nothing that would merit specific attention from subsequent reviews. 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? Shepherd: The intended RFC status is proposed standard. This is an appropriate type of RFC for YANG models that will be implemented and must interoperate. And Datatracker state attributes correctly reflect this intent (here is the direct link: https://datatracker.ietf.org/doc/draft-ietf-netconf-restconf-client-server/). 12. Have reasonable efforts been made to remind all authors of the intellectual property rights (IPR) disclosure obligations described in [BCP 79][8]? 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 has been filed that applies to this document. The chair has requested an IPR call on the list as part of WGLC process. The author confirmed that he is unaware of any IPR related to this document. Thus there is no IPR needs to be disclosed. Here is the directed link to the IPR call request: https://mailarchive.ietf.org/arch/msg/netconf/nCeZIQA91_cewM2D0xsHqe5dutY/ 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 is only one author listed on the front page who has always been actively involved in progressing this work without any other editor and contributor. 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.) Shepherd: I-D nits has been tested against v-26 (here is the direct link: https://author-tools.ietf.org/api/idnits?url=https://www.ietf.org/archive/id/draft-ietf-netconf-restconf-client-server-26.txt), and it reports 0 error (**), 0 flaws (~~), 10 warnings (==), 1 comment (--), which are innocuous. Manual check of content guidelines reveals no issues. 15. Should any informative references be normative or vice-versa? See the [IESG Statement on Normative and Informative References][16]. Shepherd: The shepherd has checked all the normative and informative references and thinks that all the 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 anyone. 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. Shepherd: There is 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: This document has normative references to other client-server and security suites of documents(I-D.ietf-netconf-http-client-server, I-D.ietf-netconf-keystore, I-D.ietf-netconf-tcp-client-server, I-D.ietf-netconf-tls-client-server). It has been planned to submit the set of drafts to the IESG for publication as a cluster. 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: No, 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][11]). Shepherd: The shepherd has reviewed the IANA consideration section and checked its consistency with the body of the document. The shepherd confirmed that all aspects of the document requiring IANA assignments are associated with the appropriate reservations in IANA registries and any referenced IANA registries have been clearly identified. There is no newly created IANA registry in this document. 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: There is no new IANA registries, thus this document doesn’t require Designated Expert Review for future allocations. [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://trac.ietf.org/trac/ops/wiki/yang-review-tools [5]: https://www.rfc-editor.org/rfc/rfc8342.html [6]: https://trac.ietf.org/trac/iesg/wiki/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/ |
2022-09-14
|
26 | Qiufang Ma | # 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 … # 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? Shepherd: The document has only one author with other WG members actively reviewing and commenting. This document has been progressed for more than 6 years and has been reviewed multiple times during their life time with 2 rounds of WGLC. That said, the shepherd thinks that this document has reached a broad agreement as this WG would be expected to reach. 2. Was there controversy about particular points, or were there decisions where the consensus was particularly rough? Shepherd: There was no controversy about particular points, and the shepherd doesn't notice any decisions where the consensus was particularly rough. This document has received enough review in both WG meeting and on the NETCONF WG mailing list, the authors and shepherd believe that all the comments and questions from that review have be incorporated into the document. 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 an appeal or otherwise 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 shepherd knows neither existing nor potential implementations of YANG models defined in this document. No existing implementations have been publicly reported. But client-server suites of documents have always been urged to move forward and the shepherd notices that this document is referenced by RFC 8783(https://datatracker.ietf.org/doc/rfc8783/) that could use YANG modules defined in this document for RESTCONF connection management between the DOTS client and server, both of which are very likely to lead to implementation. ## 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 shepherd doesn’t think the contents of this document closely interact with technologies in other IEF working groups or external organizations, and therefore the shepherd doesn’t believe this document needs review from other IETF working groups or external organizations. The shepherd doesn't see any public review from other IETF working groups or external organizations occurred before. 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: This document defines two YANG modules. It went through a YANG doctors last call review by Andy Bierman, and here is a direct link to that review: https://datatracker.ietf.org/doc/review-ietf-netconf-restconf-client-server-04-yangdoctors-lc-bierman-2017-07-28/ And here is the related discussion about the Yang doctor last call review on the NETCONF WG mailing list: https://mailarchive.ietf.org/arch/msg/netconf/AqFxL5A8lvLQYKzNv_ssi_y0THU/ 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: Yes, the document contains two YANG modules. Both have passed through `pyang` and `yanglint` validation, no errors or warnings have been flagged out. DataTracker’s YANG validator also reports 0 errors and 0 warnings. The shepherd has used the following command to check both YANG modules with no output: $ pyang --ietf ietf-restconf-client@2022-05-24.yang $yanglint ietf-restconf-client@2022-05-24.yang $pyang --ietf ietf-restconf-server@2022-05-24.yang $yanglint ietf-restconf-server@2022-05-24.yang The shepherd also tested the formatting using the command: $pyang -f yang --keep-comments --yang-line-length 69 ietf-restconf-client@2022-05-24.yang >test1.yang && diff ietf-restconf-client@2022-05-24.yang test1.yang The following results are returned which the shepherd thinks is innocuous: 110c104 < description --- > description 138d131 < 148,149c141,143 < must 'tls-client-parameters/client-identity < or http-client-parameters/client-identity'; --- > must > "tls-client-parameters/client-identity > or http-client-parameters/client-identity"; 254,255c248,250 < must 'tls-client-parameters/client-identity < or http-client-parameters/client-identity'; --- > must > "tls-client-parameters/client-identity > or http-client-parameters/client-identity"; 328d322 < 522c516 < if-feature central-restconf-client-supported; --- > if-feature "central-restconf-client-supported"; 528d521 < $pyang -f yang --keep-comments --yang-line-length 69 ietf-restconf-server@2022-05-24.yang >test2.yang && diff ietf-restconf-server@2022-05-24.yang test2.yang The following results are returned which the shepherd thinks is innocuous: 122c114 < description --- > description 149d140 < 191,195c182,185 < presence < "Identifies that an external endpoint has been < configured. This statement is present so the < mandatory descendant nodes do not imply that < this node must be configured."; --- > presence "Identifies that an external endpoint has been > configured. This statement is present so the > mandatory descendant nodes do not imply that > this node must be configured."; 562c549 < if-feature central-restconf-server-supported; --- > if-feature "central-restconf-server-supported"; 568d554 < Both of the YANG modules defined in this document comply with the Network Management Datastore Architecture (NMDA) as specified in [RFC 8342]. 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 Shepherd has read the document, tested it against "idnits", and validated the syntactical correctness of both modules defined in the document using "pyang" and "yanglint", with neither returning any errors or warnings. The shepherd also checked the XML code in the document using "yanglint" without returning any errors or warnings. ## 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: Yes. Based on the shepherd's review of the document, it is the shepherd's opinion that this document is needed, clearly written, Complete, correctly designed and ready to be handed off to the responsible Area Director. 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: The shepherd took a look at https://trac.ietf.org/trac/iesg/wiki/ExpertTopics but didn't find any issues that related to this document. There is nothing that would merit specific attention from subsequent reviews. 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? Shepherd: The intended RFC status is proposed standard. This is an appropriate type of RFC for YANG models that will be implemented and must interoperate. And Datatracker state attributes correctly reflect this intent (here is the direct link: https://datatracker.ietf.org/doc/draft-ietf-netconf-restconf-client-server/). 12. Have reasonable efforts been made to remind all authors of the intellectual property rights (IPR) disclosure obligations described in [BCP 79][8]? 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 has been filed that applies to this document. The chair has requested an IPR call on the list as part of WGLC process. The author confirmed that he is unaware of any IPR related to this document. Thus there is no IPR needs to be disclosed. Here is the directed link to the IPR call request: https://mailarchive.ietf.org/arch/msg/netconf/nCeZIQA91_cewM2D0xsHqe5dutY/ 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 is only one author listed on the front page who has always been actively involved in progressing this work without any other editor and contributor. 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.) Shepherd: I-D nits has been tested against v-26 (here is the direct link: https://author-tools.ietf.org/api/idnits?url=https://www.ietf.org/archive/id/draft-ietf-netconf-restconf-client-server-26.txt), and it reports 0 error (**), 0 flaws (~~), 10 warnings (==), 1 comment (--), which are innocuous. Manual check of content guidelines reveals no issues. 15. Should any informative references be normative or vice-versa? See the [IESG Statement on Normative and Informative References][16]. Shepherd: The shepherd has checked all the normative and informative references and thinks that all the 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 anyone. 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. Shepherd: There is 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: This document has normative references to other client-server and security suites of documents(I-D.ietf-netconf-http-client-server, I-D.ietf-netconf-keystore, I-D.ietf-netconf-tcp-client-server, I-D.ietf-netconf-tls-client-server). It has been planned to submit the set of drafts to the IESG for publication as a cluster. 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: No, 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][11]). Shepherd: The shepherd has reviewed the IANA consideration section and checked its consistency with the body of the document. The shepherd confirmed that all aspects of the document requiring IANA assignments are associated with the appropriate reservations in IANA registries and any referenced IANA registries have been clearly identified. There is no newly created IANA registry in this document. 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: There is no new IANA registries, thus this document doesn’t require Designated Expert Review for future allocations. [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://trac.ietf.org/trac/ops/wiki/yang-review-tools [5]: https://www.rfc-editor.org/rfc/rfc8342.html [6]: https://trac.ietf.org/trac/iesg/wiki/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/ |
2022-09-14
|
26 | Qiufang Ma | # 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 … # 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? Shepherd: The document has only one author actively involved in the progression of the document. But this document has been progressed for more than 6 years and has been reviewed multiple times during their life time with 2 rounds of WGLC. That said, the shepherd thinks that this document has reached a broad agreement as this WG would be expected to reach. 2. Was there controversy about particular points, or were there decisions where the consensus was particularly rough? Shepherd: There was no controversy about particular points, and the shepherd doesn't notice any decisions where the consensus was particularly rough. This document has received enough review in both WG meeting and on the NETCONF WG mailing list, the authors and shepherd believe that all the comments and questions from that review have be incorporated into the document. 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 an appeal or otherwise 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 shepherd knows neither existing nor potential implementations of YANG models defined in this document. No existing implementations have been publicly reported. But client-server suites of documents have always been urged to move forward and the shepherd notices that this document is referenced by RFC 8783(https://datatracker.ietf.org/doc/rfc8783/) that could use YANG modules defined in this document for RESTCONF connection management between the DOTS client and server, both of which are very likely to lead to implementation. ## 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 shepherd doesn’t think the contents of this document closely interact with technologies in other IEF working groups or external organizations, and therefore the shepherd doesn’t believe this document needs review from other IETF working groups or external organizations. The shepherd doesn't see any public review from other IETF working groups or external organizations occurred before. 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: This document defines two YANG modules. It went through a YANG doctors last call review by Andy Bierman, and here is a direct link to that review: https://datatracker.ietf.org/doc/review-ietf-netconf-restconf-client-server-04-yangdoctors-lc-bierman-2017-07-28/ And here is the related discussion about the Yang doctor last call review on the NETCONF WG mailing list: https://mailarchive.ietf.org/arch/msg/netconf/AqFxL5A8lvLQYKzNv_ssi_y0THU/ 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: Yes, the document contains two YANG modules. Both have passed through `pyang` and `yanglint` validation, no errors or warnings have been flagged out. DataTracker’s YANG validator also reports 0 errors and 0 warnings. The shepherd has used the following command to check both YANG modules with no output: $ pyang --ietf ietf-restconf-client@2022-05-24.yang $yanglint ietf-restconf-client@2022-05-24.yang $pyang --ietf ietf-restconf-server@2022-05-24.yang $yanglint ietf-restconf-server@2022-05-24.yang The shepherd also tested the formatting using the command: $pyang -f yang --keep-comments --yang-line-length 69 ietf-restconf-client@2022-05-24.yang >test1.yang && diff ietf-restconf-client@2022-05-24.yang test1.yang The following results are returned which the shepherd thinks is innocuous: 110c104 < description --- > description 138d131 < 148,149c141,143 < must 'tls-client-parameters/client-identity < or http-client-parameters/client-identity'; --- > must > "tls-client-parameters/client-identity > or http-client-parameters/client-identity"; 254,255c248,250 < must 'tls-client-parameters/client-identity < or http-client-parameters/client-identity'; --- > must > "tls-client-parameters/client-identity > or http-client-parameters/client-identity"; 328d322 < 522c516 < if-feature central-restconf-client-supported; --- > if-feature "central-restconf-client-supported"; 528d521 < $pyang -f yang --keep-comments --yang-line-length 69 ietf-restconf-server@2022-05-24.yang >test2.yang && diff ietf-restconf-server@2022-05-24.yang test2.yang The following results are returned which the shepherd thinks is innocuous: 122c114 < description --- > description 149d140 < 191,195c182,185 < presence < "Identifies that an external endpoint has been < configured. This statement is present so the < mandatory descendant nodes do not imply that < this node must be configured."; --- > presence "Identifies that an external endpoint has been > configured. This statement is present so the > mandatory descendant nodes do not imply that > this node must be configured."; 562c549 < if-feature central-restconf-server-supported; --- > if-feature "central-restconf-server-supported"; 568d554 < Both of the YANG modules defined in this document comply with the Network Management Datastore Architecture (NMDA) as specified in [RFC 8342]. 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 Shepherd has read the document, tested it against "idnits", and validated the syntactical correctness of both modules defined in the document using "pyang" and "yanglint", with neither returning any errors or warnings. The shepherd also checked the XML code in the document using "yanglint" without returning any errors or warnings. ## 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: Yes. Based on the shepherd's review of the document, it is the shepherd's opinion that this document is needed, clearly written, Complete, correctly designed and ready to be handed off to the responsible Area Director. 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: The shepherd took a look at https://trac.ietf.org/trac/iesg/wiki/ExpertTopics but didn't find any issues that related to this document. There is nothing that would merit specific attention from subsequent reviews. 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? Shepherd: The intended RFC status is proposed standard. This is an appropriate type of RFC for YANG models that will be implemented and must interoperate. And Datatracker state attributes correctly reflect this intent (here is the direct link: https://datatracker.ietf.org/doc/draft-ietf-netconf-restconf-client-server/). 12. Have reasonable efforts been made to remind all authors of the intellectual property rights (IPR) disclosure obligations described in [BCP 79][8]? 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 has been filed that applies to this document. The chair has requested an IPR call on the list as part of WGLC process. The author confirmed that he is unaware of any IPR related to this document. Thus there is no IPR needs to be disclosed. Here is the directed link to the IPR call request: https://mailarchive.ietf.org/arch/msg/netconf/nCeZIQA91_cewM2D0xsHqe5dutY/ 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 is only one author listed on the front page who has always been actively involved in progressing this work without any other editor and contributor. 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.) Shepherd: I-D nits has been tested against v-26 (here is the direct link: https://author-tools.ietf.org/api/idnits?url=https://www.ietf.org/archive/id/draft-ietf-netconf-restconf-client-server-26.txt), and it reports 0 error (**), 0 flaws (~~), 10 warnings (==), 1 comment (--), which are innocuous. Manual check of content guidelines reveals no issues. 15. Should any informative references be normative or vice-versa? See the [IESG Statement on Normative and Informative References][16]. Shepherd: The shepherd has checked all the normative and informative references and thinks that all the 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 anyone. 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. Shepherd: There is 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: This document has normative references to other client-server and security suites of documents(I-D.ietf-netconf-http-client-server, I-D.ietf-netconf-keystore, I-D.ietf-netconf-tcp-client-server, I-D.ietf-netconf-tls-client-server). It has been planned to submit the set of drafts to the IESG for publication as a cluster. 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: No, 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][11]). Shepherd: The shepherd has reviewed the IANA consideration section and checked its consistency with the body of the document. The shepherd confirmed that all aspects of the document requiring IANA assignments are associated with the appropriate reservations in IANA registries and any referenced IANA registries have been clearly identified. There is no newly created IANA registry in this document. 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: There is no new IANA registries, thus this document doesn’t require Designated Expert Review for future allocations. [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://trac.ietf.org/trac/ops/wiki/yang-review-tools [5]: https://www.rfc-editor.org/rfc/rfc8342.html [6]: https://trac.ietf.org/trac/iesg/wiki/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/ |
2022-08-30
|
26 | Mahesh Jethanandani | Notification list changed to maqiufang1@huawei.com because the document shepherd was set |
2022-08-30
|
26 | Mahesh Jethanandani | Document shepherd changed to Qiufang Ma |
2022-07-18
|
26 | Kent Watsen | IETF WG state changed to WG Consensus: Waiting for Write-Up from In WG Last Call |
2022-05-24
|
26 | Kent Watsen | New version available: draft-ietf-netconf-restconf-client-server-26.txt |
2022-05-24
|
26 | Kent Watsen | New version accepted (logged-in submitter: Kent Watsen) |
2022-05-24
|
26 | Kent Watsen | Uploaded new revision |
2022-03-07
|
25 | Kent Watsen | New version available: draft-ietf-netconf-restconf-client-server-25.txt |
2022-03-07
|
25 | (System) | New version accepted (logged-in submitter: Kent Watsen) |
2022-03-07
|
25 | Kent Watsen | Uploaded new revision |
2021-12-17
|
24 | Kent Watsen | Changed consensus to Yes from Unknown |
2021-12-17
|
24 | Kent Watsen | Intended Status changed to Proposed Standard from None |
2021-12-14
|
24 | Kent Watsen | New version available: draft-ietf-netconf-restconf-client-server-24.txt |
2021-12-14
|
24 | (System) | New version accepted (logged-in submitter: Kent Watsen) |
2021-12-14
|
24 | Kent Watsen | Uploaded new revision |
2021-11-19
|
23 | (System) | Document has expired |
2021-08-25
|
23 | Mahesh Jethanandani | IETF WG state changed to In WG Last Call from WG Document |
2021-05-18
|
23 | Kent Watsen | New version available: draft-ietf-netconf-restconf-client-server-23.txt |
2021-05-18
|
23 | (System) | New version accepted (logged-in submitter: Kent Watsen) |
2021-05-18
|
23 | Kent Watsen | Uploaded new revision |
2021-02-10
|
22 | Kent Watsen | New version available: draft-ietf-netconf-restconf-client-server-22.txt |
2021-02-10
|
22 | (System) | New version accepted (logged-in submitter: Kent Watsen) |
2021-02-10
|
22 | Kent Watsen | Uploaded new revision |
2020-08-20
|
21 | Kent Watsen | New version available: draft-ietf-netconf-restconf-client-server-21.txt |
2020-08-20
|
21 | (System) | New version accepted (logged-in submitter: Kent Watsen) |
2020-08-20
|
21 | Kent Watsen | Uploaded new revision |
2020-07-20
|
20 | Kent Watsen | Added to session: IETF-108: netconf Tue-1100 |
2020-07-08
|
20 | Kent Watsen | New version available: draft-ietf-netconf-restconf-client-server-20.txt |
2020-07-08
|
20 | (System) | New version accepted (logged-in submitter: Kent Watsen) |
2020-07-08
|
20 | Kent Watsen | Uploaded new revision |
2020-05-20
|
19 | Kent Watsen | New version available: draft-ietf-netconf-restconf-client-server-19.txt |
2020-05-20
|
19 | (System) | New version accepted (logged-in submitter: Kent Watsen) |
2020-05-20
|
19 | Kent Watsen | Uploaded new revision |
2020-03-08
|
18 | Kent Watsen | New version available: draft-ietf-netconf-restconf-client-server-18.txt |
2020-03-08
|
18 | (System) | New version accepted (logged-in submitter: Kent Watsen) |
2020-03-08
|
18 | Kent Watsen | Uploaded new revision |
2019-11-20
|
17 | Kent Watsen | New version available: draft-ietf-netconf-restconf-client-server-17.txt |
2019-11-20
|
17 | (System) | New version accepted (logged-in submitter: Kent Watsen) |
2019-11-20
|
17 | Kent Watsen | Uploaded new revision |
2019-11-02
|
16 | Kent Watsen | New version available: draft-ietf-netconf-restconf-client-server-16.txt |
2019-11-02
|
16 | (System) | New version accepted (logged-in submitter: Kent Watsen) |
2019-11-02
|
16 | Kent Watsen | Uploaded new revision |
2019-10-18
|
15 | Kent Watsen | New version available: draft-ietf-netconf-restconf-client-server-15.txt |
2019-10-18
|
15 | (System) | New version approved |
2019-10-18
|
15 | (System) | Request for posting confirmation emailed to previous authors: Kent Watsen |
2019-10-18
|
15 | Kent Watsen | Uploaded new revision |
2019-07-02
|
14 | Kent Watsen | New version available: draft-ietf-netconf-restconf-client-server-14.txt |
2019-07-02
|
14 | (System) | New version approved |
2019-07-02
|
14 | (System) | Request for posting confirmation emailed to previous authors: Kent Watsen |
2019-07-02
|
14 | Kent Watsen | Uploaded new revision |
2019-06-07
|
13 | Kent Watsen | New version available: draft-ietf-netconf-restconf-client-server-13.txt |
2019-06-07
|
13 | (System) | New version approved |
2019-06-07
|
13 | (System) | Request for posting confirmation emailed to previous authors: Kent Watsen |
2019-06-07
|
13 | Kent Watsen | Uploaded new revision |
2019-04-29
|
12 | Kent Watsen | New version available: draft-ietf-netconf-restconf-client-server-12.txt |
2019-04-29
|
12 | (System) | New version approved |
2019-04-29
|
12 | (System) | Request for posting confirmation emailed to previous authors: Kent Watsen |
2019-04-29
|
12 | Kent Watsen | Uploaded new revision |
2019-04-07
|
11 | Kent Watsen | New version available: draft-ietf-netconf-restconf-client-server-11.txt |
2019-04-07
|
11 | (System) | New version approved |
2019-04-07
|
11 | (System) | Request for posting confirmation emailed to previous authors: Kent Watsen |
2019-04-07
|
11 | Kent Watsen | Uploaded new revision |
2019-03-09
|
10 | Kent Watsen | New version available: draft-ietf-netconf-restconf-client-server-10.txt |
2019-03-09
|
10 | (System) | New version approved |
2019-03-09
|
10 | (System) | Request for posting confirmation emailed to previous authors: Kent Watsen |
2019-03-09
|
10 | Kent Watsen | Uploaded new revision |
2019-03-09
|
09 | Kent Watsen | New version available: draft-ietf-netconf-restconf-client-server-09.txt |
2019-03-09
|
09 | (System) | New version approved |
2019-03-09
|
09 | (System) | Request for posting confirmation emailed to previous authors: Kent Watsen , netconf-chairs@ietf.org |
2019-03-09
|
09 | Kent Watsen | Uploaded new revision |
2018-10-22
|
08 | Kent Watsen | New version available: draft-ietf-netconf-restconf-client-server-08.txt |
2018-10-22
|
08 | (System) | New version approved |
2018-10-22
|
08 | (System) | Request for posting confirmation emailed to previous authors: Kent Watsen |
2018-10-22
|
08 | Kent Watsen | Uploaded new revision |
2018-09-20
|
07 | Kent Watsen | New version available: draft-ietf-netconf-restconf-client-server-07.txt |
2018-09-20
|
07 | (System) | New version approved |
2018-09-20
|
07 | (System) | Request for posting confirmation emailed to previous authors: Kent Watsen , netconf-chairs@ietf.org, Gary Wu |
2018-09-20
|
07 | Kent Watsen | Uploaded new revision |
2018-06-04
|
06 | Kent Watsen | New version available: draft-ietf-netconf-restconf-client-server-06.txt |
2018-06-04
|
06 | (System) | New version approved |
2018-06-04
|
06 | (System) | Request for posting confirmation emailed to previous authors: Kent Watsen , Gary Wu |
2018-06-04
|
06 | Kent Watsen | Uploaded new revision |
2018-05-03
|
05 | (System) | Document has expired |
2017-10-30
|
05 | Kent Watsen | New version available: draft-ietf-netconf-restconf-client-server-05.txt |
2017-10-30
|
05 | (System) | New version approved |
2017-10-30
|
05 | (System) | Request for posting confirmation emailed to previous authors: Kent Watsen , netconf-chairs@ietf.org, Juergen Schoenwaelder |
2017-10-30
|
05 | Kent Watsen | Uploaded new revision |
2017-07-28
|
04 | Andy Bierman | Request for Last Call review by YANGDOCTORS Completed: Ready with Nits. Reviewer: Andy Bierman. Sent review to list. |
2017-07-10
|
04 | Mehmet Ersue | Request for Last Call review by YANGDOCTORS is assigned to Andy Bierman |
2017-07-10
|
04 | Mehmet Ersue | Request for Last Call review by YANGDOCTORS is assigned to Andy Bierman |
2017-07-10
|
04 | Mehmet Ersue | Requested Last Call review by YANGDOCTORS |
2017-07-03
|
04 | Kent Watsen | New version available: draft-ietf-netconf-restconf-client-server-04.txt |
2017-07-03
|
04 | (System) | New version approved |
2017-07-03
|
04 | (System) | Request for posting confirmation emailed to previous authors: Kent Watsen , Juergen Schoenwaelder |
2017-07-03
|
04 | Kent Watsen | Uploaded new revision |
2017-06-13
|
03 | Kent Watsen | New version available: draft-ietf-netconf-restconf-client-server-03.txt |
2017-06-13
|
03 | (System) | New version approved |
2017-06-13
|
03 | (System) | Request for posting confirmation emailed to previous authors: Kent Watsen , Juergen Schoenwaelder |
2017-06-13
|
03 | Kent Watsen | Uploaded new revision |
2017-03-15
|
02 | Mahesh Jethanandani | Added to session: IETF-98: netconf Tue-1640 |
2017-03-13
|
02 | Kent Watsen | New version available: draft-ietf-netconf-restconf-client-server-02.txt |
2017-03-13
|
02 | (System) | New version approved |
2017-03-13
|
02 | (System) | Request for posting confirmation emailed to previous authors: Kent Watsen , netconf-chairs@ietf.org, =?utf-8?b?SsO8cmdlbiBTY2jDtm53w6RsZGVy?= |
2017-03-13
|
02 | Kent Watsen | Uploaded new revision |
2016-11-03
|
01 | Cindy Morgan | New version available: draft-ietf-netconf-restconf-client-server-01.txt |
2016-11-03
|
01 | (System) | Secretariat manually posting. Approvals already received |
2016-11-03
|
01 | Cindy Morgan | Uploaded new revision |
2016-07-08
|
00 | Kent Watsen | New version available: draft-ietf-netconf-restconf-client-server-00.txt |