Re: [yang-doctors] Yangdoctors early review of draft-ietf-opsawg-mud-08
Eliot Lear <lear@cisco.com> Fri, 25 August 2017 10:26 UTC
Return-Path: <lear@cisco.com>
X-Original-To: yang-doctors@ietfa.amsl.com
Delivered-To: yang-doctors@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id AA982132924; Fri, 25 Aug 2017 03:26:19 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -14.519
X-Spam-Level:
X-Spam-Status: No, score=-14.519 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, HTML_MESSAGE=0.001, RCVD_IN_DNSWL_HI=-5, RCVD_IN_MSPIKE_H3=-0.01, RCVD_IN_MSPIKE_WL=-0.01, SPF_PASS=-0.001, URIBL_BLOCKED=0.001, USER_IN_DEF_DKIM_WL=-7.5] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (1024-bit key) header.d=cisco.com
Received: from mail.ietf.org ([4.31.198.44]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id keG3erw351nu; Fri, 25 Aug 2017 03:26:16 -0700 (PDT)
Received: from alln-iport-6.cisco.com (alln-iport-6.cisco.com [173.37.142.93]) (using TLSv1.2 with cipher DHE-RSA-SEED-SHA (128/128 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 8FBD712426E; Fri, 25 Aug 2017 03:26:16 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=cisco.com; i=@cisco.com; l=30459; q=dns/txt; s=iport; t=1503656776; x=1504866376; h=subject:to:cc:references:from:message-id:date: mime-version:in-reply-to; bh=04S8KpZaguaet6vtb/hJF0/034jP9Zk0HiKVCsXhtmA=; b=SnuHSPXTxohqmtQwVzzAKP+zYWsLpEPi6aSJ7To97DQjTJebtlnta43+ LDYShgqCUp4QA8ePGi1mRJaKfW4VavlhuLip8rq4cpoEpdMRwlD69cxeo caOIUb3D4z1U7h1IoWPcUcyr7EOPZEp8y2FEfFaAJZPjHGzNi2piTVRi+ o=;
X-Files: signature.asc : 481
X-IronPort-Anti-Spam-Filtered: true
X-IronPort-Anti-Spam-Result: A0D4AABC+p9Z/4sNJK0UBUMZAQEBAQEBAQEBAQEHAQEBAQGDWmSBFY4UkBiBcJYlghIHGgEKhRsCg3c/GAECAQEBAQEBAWsohRkBAQEDAQEhBEcLEAkCGCAHAwICJx8RBgEMBgIBAYotEIhbhnGdZoFtOieLOQEBAQEBAQEBAQEBAQEBAQEBAQEBAQ4KBYMqggKDMCuCfIROEYMpgkIfAQSHOIJVhxKPP4Q0giGEV4NVhUWCEoVkg1mHF4lyjEUfOEFMMiEIHBVJhF+CPj42h0yCQQEBAQ
X-IronPort-AV: E=Sophos;i="5.41,425,1498521600"; d="asc'?scan'208,217";a="476748933"
Received: from alln-core-6.cisco.com ([173.36.13.139]) by alln-iport-6.cisco.com with ESMTP/TLS/DHE-RSA-AES256-SHA; 25 Aug 2017 10:26:14 +0000
Received: from [10.82.222.249] (rtp-vpn3-1778.cisco.com [10.82.222.249]) by alln-core-6.cisco.com (8.14.5/8.14.5) with ESMTP id v7PAQC4L025473; Fri, 25 Aug 2017 10:26:13 GMT
To: Andy Bierman <andy@yumaworks.com>, Martin Bjorklund <mbj@tail-f.com>
Cc: YANG Doctors <yang-doctors@ietf.org>, draft-ietf-opsawg-mud.all@ietf.org
References: <150340909415.6001.14045177084948571272@ietfa.amsl.com> <20170823.100659.305891042923397070.mbj@tail-f.com> <CABCOCHQznpgCYssekPz+-EjST13tisrdeuv_k6PppW0XpONA0w@mail.gmail.com>
From: Eliot Lear <lear@cisco.com>
Message-ID: <76b23cb9-b174-c561-dee6-ad625e228fe8@cisco.com>
Date: Fri, 25 Aug 2017 12:26:19 +0200
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.12; rv:52.0) Gecko/20100101 Thunderbird/52.3.0
MIME-Version: 1.0
In-Reply-To: <CABCOCHQznpgCYssekPz+-EjST13tisrdeuv_k6PppW0XpONA0w@mail.gmail.com>
Content-Type: multipart/signed; micalg="pgp-sha256"; protocol="application/pgp-signature"; boundary="rNc8PE6k3sGMIIbJxVDvQ2DPnUwlUdrXH"
Archived-At: <https://mailarchive.ietf.org/arch/msg/yang-doctors/HyUhpSPde8W6q_OvGCn2w7Tj9_c>
Subject: Re: [yang-doctors] Yangdoctors early review of draft-ietf-opsawg-mud-08
X-BeenThere: yang-doctors@ietf.org
X-Mailman-Version: 2.1.22
Precedence: list
List-Id: Email list of the yang-doctors directorate <yang-doctors.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/yang-doctors>, <mailto:yang-doctors-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/yang-doctors/>
List-Post: <mailto:yang-doctors@ietf.org>
List-Help: <mailto:yang-doctors-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/yang-doctors>, <mailto:yang-doctors-request@ietf.org?subject=subscribe>
X-List-Received-Date: Fri, 25 Aug 2017 10:26:20 -0000
Hi Andy and other doctors, Following up on your note, I have been discussing with a few people how exactly to encode stuff. Below please find something of a strawman. As currently structured, in a MUD file there would be two root level objects: a mud-artifact and a list of access-lists. I have a few questions: 1. Can both of these two objects, one of them being defined within rc:yang-data and another not, be represented in the same JSON file as two root level objects? 2. In anticipation that someone might someday want to have this information expressed by a NETCONF server, I ponder still making the "mud" module below a presence container. Is that legal/advisable within the context of rc:yang-data? Thanks much, Eliot pyang --strict --lint --ietf --tree-print-yang-data -f tree ietf-mud.yang module: ietf-mud augment /acl:access-lists/acl:acl/acl:access-list-entries/acl:ace/acl:matches: +--rw mud-acl +--rw manufacturer? inet:host +--rw same-manufacturer? empty +--rw model? string +--rw local-networks? empty +--rw controller? inet:uri +--rw my-controller? empty augment /acl:access-lists/acl:acl/acl:access-list-entries/acl:ace/acl:matches/acl:tcp-acl: +--rw direction-initiated? direction yang-data: mud-artifact +---- mud +---- mud-url inet:uri +---- last-update yang:date-and-time +---- cache-validity? uint8 +---- masa-server? inet:uri +---- is-supported? boolean +---- systeminfo? inet:uri +---- extensions* string +---- from-device-policy | +---- access-lists | +---- access-list* [acl-name acl-type] | +---- acl-name -> /acl:access-lists/acl/acl-name | +---- acl-type identityref +---- to-device-policy +---- access-lists +---- access-list* [acl-name acl-type] +---- acl-name -> /acl:access-lists/acl/acl-name +---- acl-type identityref On 8/23/17 6:59 PM, Andy Bierman wrote: > > > On Wed, Aug 23, 2017 at 1:06 AM, Martin Bjorklund <mbj@tail-f.com > <mailto:mbj@tail-f.com>> wrote: > > Hi, > > I would like to direct the YANG doctors attention to one design choice > in this document: > > The document defines a normal "config true" data model, but this data > model is not intended to be implemented by a server, but rather it > defines the file format of a "MUD file". > > This idea is not new, it is used e.g. in the anima voucher document. > Normally, we would require that they use "rc:yang-data" to define such > a structure. > > However, the MUD file is supposed to contain some top-level nodes > defined in the MUD YANG module, and also some /acl:access-lists > nodes. So even if the MUD document could define a rc:yang-data > structure for the top-level nodes defined in the MUD document, it > cannot get the access lists into this rc:yang-data structure. > > So the question to the YANG doctors is if this is ok, or if there is a > better way to define this file format. > > > Why is it a problem to use a grouping in rc:yang-data? > This clearly needs to be rc:yang-data, not a real module with > config=true objects. > I think the artifact can contain data that matches the structure of > config data. > It is an implementation detail to convert the artifact to config data > in a datastore. > > > > > /martin > > > > Andy > > > > Martin Bjorklund <mbj@tail-f.com <mailto:mbj@tail-f.com>> wrote: > > Reviewer: Martin Bjorklund > > Review result: Ready with Issues > > > > Hi, > > > > I am the assigned YANG doctors reviewer for this document. Here are > > my comments: > > > > > > o Section 2 says: > > > > The MUD file is limited to the serialization of a > > small number of YANG schema, including the models specified > in the > > following documents: > > > > o [I-D.ietf-netmod-acl-model] > > > > o [RFC6991] > > > > Is the intention that *only* these models are included, or *at > > least* these models are included? > > > > RFC6991 doesn't define any data nodes, so I don't think it > needs to > > be listed. I suggest you are a bit more specific, and list: > > > > o ietf-access-control-list [I-D.ietf-netmod-acl-model] > > > > o ietf-mud [...] > > > > > > o Section 3 uses the term "element" (it is used in other places as > > well). YANG uses the term "data node" or "node". Or "YANG data > > node". I suggest you use one of these terms, and import the term > > in your Terminology section. > > > > Also, the YANG module uses the term "element" to refer to > "device": > > > > leaf is-supported { > > type boolean; > > description > > "The element is currently supported > > by the manufacturer."; > > } > > > > > > o In your Terminology section you introduce the term "Thing". But > > the text often use "device". Maybe use "device" consistently? > > > > > > o In order to get consistent indentation of the YANG modules, I > > suggest you run: > > > > pyang -f yang ietf-mud.yang > > > > (and same for ietf-acldns.yang) > > > > > > o Ensure that description statements contain proper sentences. > Also > > ensure that the descriptions are descriptive. As an example > of the > > latter, this is not a good description: > > > > description > > "Which way are we talking about?"; > > > > In general, I found that the main document had better > descriptions > > than the YANG module. Consider moving the text from the main > > document to the YANG module (this also reduces the risk of > > inconsistencies). If don't want to move text, I think you > need to > > spend some effort on almost all descriptions in the YANG module. > > > > > > o In both modules, make sure you have a single revision > > statement. Note that in IETF-terms, a revision statement is > added > > when a new version of the module is publsihed as an RFC (so the > > initial RFC would have one revision statement). > > > > > > o The "ietf-mud" module is a bit unorthodox; it defines > configuration > > data nodes, but it is not supposed to be implemented by a normal > > NETCONF/RESTCONF server. Rather, it will be instantiated in > a JSON > > file. I think this should be stated in the description of the > > module. > > > > > > o I don't think the feature "mud-acl" is necessary. It is only > used > > to make the acl augment conditional on the feature. I think that > > if this module is supported, the feature is also supported. > Or do > > you envision implementations of this module that would not > support > > this feature? If so, maybe you can explain that use case in the > > document. > > > > > > o leaf cache-validity could use a "units" statement: > > > > units "hours"; > > > > > > o I suggest you rename the grouping "access_lists" to > "access-lists" > > for consitency. > > > > > > o Should any of the leafs in "/metainfo" be mandatory? > > > > > > o The "extensions" leaf-list mentions an IANA registry for > > extensions. It would be usefule to mention this registry by > name. > > > > Also, shouldn't this registry be defined in the IANA > Considerations > > section? > > > > > > o Section 3.7 mentions a leaf "packet-direction". There is no such > > leaf in the YANG module. There is one called > "direction-initiated" > > though. > > > > But since the "/device" container contains two different ACL > sets, > > one for "to" and one for "from", is this augmentation really > > necessary? > > > > > > o The model has: > > > > leaf local-networks { > > type empty; > > description > > "this string is used to indicate networks > > considered local in a given environment."; > > > > This leaf is of type "empty", but the description says it is a > > string. > > > > Also, what is the format of this string? (Hmm, I think the > > description is wrong, this should indeed be type empty). > > > > > > o Would it be useful with an indication of the revision of > "ietf-mud" > > that is used as the schema for a MUD file? I.e., something > like a > > leaf "mud-module-revision" in the "metainfo" container. > > > > > > o The example in section 8 has some errors, e.g., it has some > > camelCase node names. > > > > > > _______________________________________________ > > yang-doctors mailing list > > yang-doctors@ietf.org <mailto:yang-doctors@ietf.org> > > https://www.ietf.org/mailman/listinfo/yang-doctors > <https://www.ietf.org/mailman/listinfo/yang-doctors> > > > > _______________________________________________ > yang-doctors mailing list > yang-doctors@ietf.org <mailto:yang-doctors@ietf.org> > https://www.ietf.org/mailman/listinfo/yang-doctors > <https://www.ietf.org/mailman/listinfo/yang-doctors> > >
- [yang-doctors] Yangdoctors early review of draft-… Martin Bjorklund
- Re: [yang-doctors] Yangdoctors early review of dr… Eliot Lear
- Re: [yang-doctors] Yangdoctors early review of dr… Martin Bjorklund
- Re: [yang-doctors] Yangdoctors early review of dr… Andy Bierman
- Re: [yang-doctors] Yangdoctors early review of dr… Eliot Lear
- Re: [yang-doctors] Yangdoctors early review of dr… Martin Bjorklund
- Re: [yang-doctors] Yangdoctors early review of dr… Eliot Lear
- Re: [yang-doctors] Yangdoctors early review of dr… Kent Watsen
- Re: [yang-doctors] Yangdoctors early review of dr… Eliot Lear
- Re: [yang-doctors] Yangdoctors early review of dr… Martin Bjorklund
- Re: [yang-doctors] Yangdoctors early review of dr… Eliot Lear