Re: [netmod] Yangdoctors last call review of draft-ietf-netmod-yang-instance-file-format-04
Hi Balazs,
I think this satisfies all my comments. Please upload the -05 version and I
will complete the YANG doctors review.
Thanks,
Acee
On 11/6/19, 11:23 AM, "Balázs Lengyel" wrote:
Hello,
Thanks for the comments and the updated file accordingly. See below.
Regards Balazs
-Original Message-
From: Acee Lindem via Datatracker
Sent: 2019. október 30., szerda 13:59
To: yang-doct...@ietf.org
Cc: draft-ietf-netmod-yang-instance-file-format@ietf.org;
last-c...@ietf.org; netmod@ietf.org
Subject: Yangdoctors last call review of
draft-ietf-netmod-yang-instance-file-format-04
Reviewer: Acee Lindem
Review result: Ready with Issues
Document: draft-ietf-netmod-yang-instance-file-format-04.txt
Reviewer: Acee Lindem
Review Date: Oct 30st, 2019
Review Type: Working Group Last Call
Intended Status: Standards Track
Summary: Ready with Issues
Modules: "ietf-yang-instance-d...@2019-07-04.yang"
Tech Summary: The model describes mechanisms and statically specifying
instance data (XML or JSON) for YANG models. Use cases are
also discussed although not in normative text. The document
is relatively straight forward but could benefit from some
editorial cleanup.
Major Comments:
None
Minor Comments:
1. The "Security Considerations" in section 8 do not conform to the
recommended template in
https://trac.ietf.org/trac/ops/wiki/yang-security-
guidelines>. The considerations may be completely dependent on the
included
instance Data Set or some of the information in the model may also be
sensitive. However, it needs to be better described.
BALAZS: Updated security considerations, tried to make it more detailed.
However the template is mostly
not applicable to this draft. This draft contains very little own data,
most of
the instance data is as you sad completely dependent on the included
instance Data Set.
It is also planned to be accessed as a file, not via Netconf/Restconf.
2. I feel it would be helpful to explicitly state that the both read-only
and read-write instance data may be included in the instance data set.
BALAZS: OK. Chapter 3. Instance Data File Format will include the
following:
" Config=true and config=false data MAY be mixed in the instance data
file."
3. The document could requires some editorial cleanup. For example, use
complete sentenses for principles in section 2.1 and punctuate. Do not
begin sentenses with "E.g. ...".
BALAZS: Principles reworded.
Nits:
See diff below.
*** draft-ietf-netmod-yang-instance-file-format-04.txt.orig 2019-10-29
16:36:22.0 -0400
--- draft-ietf-netmod-yang-instance-file-format-04.txt
2019-10-29 21:40:06.0 -0400
***
*** 20,26
running server available. This document specifies a standard file
format for YANG instance data (which follows the syntax and semantic
from existing YANG models, re-using the same format as the reply to a
! operation/request) and decorates it with metadata.
Status of This Memo
--- 20,26
running server available. This document specifies a standard file
format for YANG instance data (which follows the syntax and semantic
from existing YANG models, re-using the same format as the reply to a
! operation/request) and annotates it with metadata.
BALAZS: OK
Status of This Memo
***
*** 114,127
Internet-Draft YANG Instance DataAugust 2019
!Instance Data Set: A named set of data items decorated with metadata
that can be used as instance data in a YANG data tree.
Instance Data File: A file containing an instance data set formatted
according to the rules described in this document.
!Content-schema: A set of YANG modules with their revision,suupported
!features and deviations for which the instance data set contains
instance data
Content defining Yang module(s): YANG module(s) that make up the
--- 114,127
Internet-Draft YANG Instance DataAugust 2019
!Instance Data Set: A named set of data items annotated with metadata
BALAZS: OK
that can be used as instance data in a YANG data tree.
Instance Data File: A file containing an instance data set formatted
according to the rules described in this document.
!Content-schema: A set of YANG modules with their revision, supported
B
Re: [netmod] Yangdoctors last call review of draft-ietf-netmod-yang-instance-file-format-04
Hello, Thanks for the comments and the updated file accordingly. See below. Regards Balazs -Original Message- From: Acee Lindem via Datatracker Sent: 2019. október 30., szerda 13:59 To: yang-doct...@ietf.org Cc: draft-ietf-netmod-yang-instance-file-format@ietf.org; last-c...@ietf.org; netmod@ietf.org Subject: Yangdoctors last call review of draft-ietf-netmod-yang-instance-file-format-04 Reviewer: Acee Lindem Review result: Ready with Issues Document: draft-ietf-netmod-yang-instance-file-format-04.txt Reviewer: Acee Lindem Review Date: Oct 30st, 2019 Review Type: Working Group Last Call Intended Status: Standards Track Summary: Ready with Issues Modules: "ietf-yang-instance-d...@2019-07-04.yang" Tech Summary: The model describes mechanisms and statically specifying instance data (XML or JSON) for YANG models. Use cases are also discussed although not in normative text. The document is relatively straight forward but could benefit from some editorial cleanup. Major Comments: None Minor Comments: 1. The "Security Considerations" in section 8 do not conform to the recommended template in https://trac.ietf.org/trac/ops/wiki/yang-security- guidelines>. The considerations may be completely dependent on the included instance Data Set or some of the information in the model may also be sensitive. However, it needs to be better described. BALAZS: Updated security considerations, tried to make it more detailed. However the template is mostly not applicable to this draft. This draft contains very little own data, most of the instance data is as you sad completely dependent on the included instance Data Set. It is also planned to be accessed as a file, not via Netconf/Restconf. 2. I feel it would be helpful to explicitly state that the both read-only and read-write instance data may be included in the instance data set. BALAZS: OK. Chapter 3. Instance Data File Format will include the following: " Config=true and config=false data MAY be mixed in the instance data file." 3. The document could requires some editorial cleanup. For example, use complete sentenses for principles in section 2.1 and punctuate. Do not begin sentenses with "E.g. ...". BALAZS: Principles reworded. Nits: See diff below. *** draft-ietf-netmod-yang-instance-file-format-04.txt.orig 2019-10-29 16:36:22.0 -0400 --- draft-ietf-netmod-yang-instance-file-format-04.txt 2019-10-29 21:40:06.0 -0400 *** *** 20,26 running server available. This document specifies a standard file format for YANG instance data (which follows the syntax and semantic from existing YANG models, re-using the same format as the reply to a ! operation/request) and decorates it with metadata. Status of This Memo --- 20,26 running server available. This document specifies a standard file format for YANG instance data (which follows the syntax and semantic from existing YANG models, re-using the same format as the reply to a ! operation/request) and annotates it with metadata. BALAZS: OK Status of This Memo *** *** 114,127 Internet-Draft YANG Instance DataAugust 2019 !Instance Data Set: A named set of data items decorated with metadata that can be used as instance data in a YANG data tree. Instance Data File: A file containing an instance data set formatted according to the rules described in this document. !Content-schema: A set of YANG modules with their revision,suupported !features and deviations for which the instance data set contains instance data Content defining Yang module(s): YANG module(s) that make up the --- 114,127 Internet-Draft YANG Instance DataAugust 2019 !Instance Data Set: A named set of data items annotated with metadata BALAZS: OK that can be used as instance data in a YANG data tree. Instance Data File: A file containing an instance data set formatted according to the rules described in this document. !Content-schema: A set of YANG modules with their revision, supported BALAZS: OK !features, and deviations for which the instance data set contains BALAZS: OK instance data Content defining Yang module(s): YANG module(s) that make up the *** *** 138,145 There is a need to document data defined in YANG models when a live server is not available. Data is often needed already at design or implementation time or needed by groups that do not have a live !running server available. To facilitate this off-line delivery of !data this document specifies a standard format for YANG instance data sets and YANG instance data files. The following is a li
[netmod] Yangdoctors last call review of draft-ietf-netmod-yang-instance-file-format-04
Reviewer: Acee Lindem Review result: Ready with Issues Document: draft-ietf-netmod-yang-instance-file-format-04.txt Reviewer: Acee Lindem Review Date: Oct 30st, 2019 Review Type: Working Group Last Call Intended Status: Standards Track Summary: Ready with Issues Modules: "ietf-yang-instance-d...@2019-07-04.yang" Tech Summary: The model describes mechanisms and statically specifying instance data (XML or JSON) for YANG models. Use cases are also discussed although not in normative text. The document is relatively straight forward but could benefit from some editorial cleanup. Major Comments: None Minor Comments: 1. The "Security Considerations" in section 8 do not conform to the recommended template in https://trac.ietf.org/trac/ops/wiki/yang-security- guidelines>. The considerations may be completely dependent on the included instance Data Set or some of the information in the model may also be sensitive. However, it needs to be better described. 2. I feel it would be helpful to explicitly state that the both read-only and read-write instance data may be included in the instance data set. 3. The document could requires some editorial cleanup. For example, use complete sentenses for principles in section 2.1 and punctuate. Do not begin sentenses with "E.g. ...". Nits: See diff below. *** draft-ietf-netmod-yang-instance-file-format-04.txt.orig 2019-10-29 16:36:22.0 -0400 --- draft-ietf-netmod-yang-instance-file-format-04.txt 2019-10-29 21:40:06.0 -0400 *** *** 20,26 running server available. This document specifies a standard file format for YANG instance data (which follows the syntax and semantic from existing YANG models, re-using the same format as the reply to a ! operation/request) and decorates it with metadata. Status of This Memo --- 20,26 running server available. This document specifies a standard file format for YANG instance data (which follows the syntax and semantic from existing YANG models, re-using the same format as the reply to a ! operation/request) and annotates it with metadata. Status of This Memo *** *** 114,127 Internet-Draft YANG Instance DataAugust 2019 !Instance Data Set: A named set of data items decorated with metadata that can be used as instance data in a YANG data tree. Instance Data File: A file containing an instance data set formatted according to the rules described in this document. !Content-schema: A set of YANG modules with their revision,suupported !features and deviations for which the instance data set contains instance data Content defining Yang module(s): YANG module(s) that make up the --- 114,127 Internet-Draft YANG Instance DataAugust 2019 !Instance Data Set: A named set of data items annotated with metadata that can be used as instance data in a YANG data tree. Instance Data File: A file containing an instance data set formatted according to the rules described in this document. !Content-schema: A set of YANG modules with their revision, supported !features, and deviations for which the instance data set contains instance data Content defining Yang module(s): YANG module(s) that make up the *** *** 138,145 There is a need to document data defined in YANG models when a live server is not available. Data is often needed already at design or implementation time or needed by groups that do not have a live !running server available. To facilitate this off-line delivery of !data this document specifies a standard format for YANG instance data sets and YANG instance data files. The following is a list of already implemented and potential use --- 138,145 There is a need to document data defined in YANG models when a live server is not available. Data is often needed already at design or implementation time or needed by groups that do not have a live !running server available. To facilitate this offline delivery of !data, this document specifies a standard format for YANG instance data sets and YANG instance data files. The following is a list of already implemented and potential use *** *** 153,159 UC4 Instance data used as backup !UC5 Storing the configuration of a device, e.g. for archive or audit purposes UC6 Storing diagnostics data --- 153,159 UC4 Instance data used as backup !UC5 Storing the configuration of a device, e.g., for archive or audit purposes UC6 Storing diagnostics data *** *** 186,201 The following is a list of the basic principles of the
