Re: [core] CBOR Encoding of Data Modeled with YANG

Andy Bierman <andy@yumaworks.com> Tue, 08 December 2015 15:02 UTC

Return-Path: <andy@yumaworks.com>
X-Original-To: core@ietfa.amsl.com
Delivered-To: core@ietfa.amsl.com
Received: from localhost (ietfa.amsl.com [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id B6D5A1B2ED6 for <core@ietfa.amsl.com>; Tue, 8 Dec 2015 07:02:32 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: 0.876
X-Spam-Level:
X-Spam-Status: No, score=0.876 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, FM_FORGED_GMAIL=0.622, FRT_BELOW2=2.154, HTML_MESSAGE=0.001, SPF_PASS=-0.001] autolearn=no
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 u1u3j16LjJOH for <core@ietfa.amsl.com>; Tue, 8 Dec 2015 07:02:30 -0800 (PST)
Received: from mail-lf0-x236.google.com (mail-lf0-x236.google.com [IPv6:2a00:1450:4010:c07::236]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 9CD221B2ECE for <core@ietf.org>; Tue, 8 Dec 2015 07:02:29 -0800 (PST)
Received: by lffu14 with SMTP id u14so14407083lff.1 for <core@ietf.org>; Tue, 08 Dec 2015 07:02:27 -0800 (PST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=yumaworks-com.20150623.gappssmtp.com; s=20150623; h=mime-version:in-reply-to:references:date:message-id:subject:from:to :cc:content-type; bh=hc3M4X77aKMb0mHcRytzCc2IFgZve25jXuNgUCRG3+w=; b=DqIC6NjasVsGhxUEQuoTB81RbJpu4xX0+hpOBDEFss2BbpNujsv4kDFeiZp6MTOcPb SvpoMRx/e/NItr3d08kexraVntzW76fCkAFyTIRuKakKnPDNoGvhxVa3j/i0JXq91//H xZcp8AgINc38U43IqBnY3ewCloBJRV3p1DNf6tXVdA8hovcYV/NUdFUcS6BQx4Bn+pNO 2bn3WIDMBL7EqpNpTfS8XUTz6wyG/uFLAT+uhNqQgI4s5hamjdBVfxnuKHZIaEfcdCve hKFrknDQlVXqn3VEHp27b8Iyr+GGkIasQAljCbQ2PZMLKJzM7VOjDT2ChhLEOFc3/yDW l3bg==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:mime-version:in-reply-to:references:date :message-id:subject:from:to:cc:content-type; bh=hc3M4X77aKMb0mHcRytzCc2IFgZve25jXuNgUCRG3+w=; b=ihdKGc4n696UT8xmUxSFqBc7xYuNqIPyJeYjPyLx/FEpBGdcmcDbdYDEHo7fEEr9fB AsAxEl2Ww2ybsgJKiutxVGz4VCrTqoIIvsyqp4VSFWTkC8CuEX/4GWe9V1xJTh8cAz3n z348uKb0BUGDnyuSAjOJipPxQ/yNvp0UBx22QERlKNflZBke/R0UZF2FjHpei2+mqIK/ ao7sGWttkF0OOl0z7iR+PMU5xqb9ppAOueuj8UYWYV2Ctc6Vbnqblht2VytLyCjfbzfA LaIcSydBc1Pl7ZodJ7kH7tKhtkTjbQUe2jAngfx5iZr9Zuq+bMWiF/tyghqorTx2xuxX iQmg==
X-Gm-Message-State: ALoCoQnZ/Bon5lPGhjMph/HaQs82GypCVGF3uINCmK3J/L5eiYY3ZHTKSgoSDMC6Wmjk3M0/P7tty1Ojn44tgicdnZxK0CRflA==
MIME-Version: 1.0
X-Received: by 10.25.18.92 with SMTP id h89mr1509lfi.54.1449586947730; Tue, 08 Dec 2015 07:02:27 -0800 (PST)
Received: by 10.112.144.36 with HTTP; Tue, 8 Dec 2015 07:02:27 -0800 (PST)
In-Reply-To: <5666AE1A.2040908@ackl.io>
References: <BLUPR06MB176391F16B5E9D6CCC531771FE0E0@BLUPR06MB1763.namprd06.prod.outlook.com> <20151207091044.GA59864@elstar.local> <BLUPR06MB1763ABFE8DE1E0E18F5F06A5FE090@BLUPR06MB1763.namprd06.prod.outlook.com> <20151207194229.GA61491@elstar.local> <BLUPR06MB1763B7F9EBF812C06DB04252FE090@BLUPR06MB1763.namprd06.prod.outlook.com> <20151207203826.GA61647@elstar.local> <BLUPR06MB1763E9AB0D1E4A0478D47C05FE090@BLUPR06MB1763.namprd06.prod.outlook.com> <20151208093350.GA62650@elstar.local> <5666AE1A.2040908@ackl.io>
Date: Tue, 08 Dec 2015 07:02:27 -0800
Message-ID: <CABCOCHQuLGcpXAa-sVswCAnqLCO==fS8DWBSJ232wwrAofD13g@mail.gmail.com>
From: Andy Bierman <andy@yumaworks.com>
To: Alexander Pelov <a@ackl.io>
Content-Type: multipart/alternative; boundary="001a113fb2a4174fd80526644366"
Archived-At: <http://mailarchive.ietf.org/arch/msg/core/7I_sJVc-LVu4k-vvlWiPqe5Jt_k>
Cc: Core <core@ietf.org>
Subject: Re: [core] CBOR Encoding of Data Modeled with YANG
X-BeenThere: core@ietf.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: "Constrained RESTful Environments \(CoRE\) Working Group list" <core.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/core>, <mailto:core-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/core/>
List-Post: <mailto:core@ietf.org>
List-Help: <mailto:core-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/core>, <mailto:core-request@ietf.org?subject=subscribe>
X-List-Received-Date: Tue, 08 Dec 2015 15:02:32 -0000

On Tue, Dec 8, 2015 at 2:16 AM, Alexander Pelov <a@ackl.io> wrote:

> Dear Juergen,
>
> The algorithm is straightforward - assign in increasing order a data node
> ID to each element on the schema tree. If you have a revision of a module,
> you do the diff between the old and the new tree, and add the new data node
> IDs at the end of the numbering.
>
> If you want a short version that would allow you to play with this
> numbering, try the following:
>
> Data Node ID generation for a module YANG_MODULE:
>
>
> *# pyang -f tree YANG_MODULE.yang | grep '+' | grep -n '+' *pyang -f tree
> YANG_MODULE-OLD-VERSION.yang >> OLD-VERSION.tree
> pyang -f tree YANG_MODULE-NEW-VERSION.yang >> NEW-VERSION.tree
> *# ( cat **OLD-VERSION.tree ; diff **OLD-VERSION.tree **NEW-VERSION.tree
> ) | grep '+' | grep -n '+'*
>
>

You realize this does not work at all if a "uses" expands differently from
1 revision to the next, right?
You have to make manual assignments at the end and remember them going
forward
for all new revisions.




> I'm currently working on a pyang version of the algorithm. There is no
> problem on that point. We cannot produce all documents in the same time,
> and the starting point is YANG-CBOR mapping.
>
> Best,
> Alexander
>
>
Andy



>
> Le 08/12/2015 10:33, Juergen Schoenwaelder a écrit :
>
> Hi Michel,
>
> I am looking for a precise description of the _algorithm_, I am not so
> much looking for an example. Has someone implemented this numbering
> algorithm in pyang and verified that the algorithm always produces the
> same data node ids for all the possible changes I can make to a YANG
> model? See section 10 of RFC 6020 as a starting point what is allowed
> to change in module revisions. See also section 11 of
> draft-ietf-netmod-rfc6020bis-08.txt.
>
> /js
>
> On Mon, Dec 07, 2015 at 09:31:37PM +0000, Michel Veillette wrote:
>
> Hi Juergen
>
> The algorithm proposed to generate IDs  is described inhttps://tools.ietf.org/html/draft-veillette-core-cool-00#section-6.
>
> - IDs are assigned based on there location in the schema tree.
>
> - Each type of object (Data node IDs, Notification IDs, Notification parameter IDs,
>    Protocol Operation IDs, Input parameter IDs, Output parameter IDs)
>    have a different namespace.
>
>    This approach help keeping the same IDs  when updating a module.
>    New objects can be added at the end of each list without affecting the existing IDs.
>
> - When an object is added within a list or within the schema tree, its ID can be
>    manually assigned using a YANG extension to avoid braking backward compatibility.
>    Alternatively, data nodes can be added using the augment statement.
>    In this case, IDs are associated to a different module ID.
>
>   https://tools.ietf.org/html/draft-veillette-core-cool-00#section-7.3 show an
>   example of use of the augment statement, see data node ID 68620 bellow.
>
>    CoAP response:
>      2.05 Content Content-Format(application/cbor)
>      {
>        66560 : {
>          1 : {
>            2 : [
>              {
>                3 : "eth0",
>                4 : "Ethernet adapter Local Area Connection",
>                5 : "ethernetCsmacd",
>                6 : true,
>                68620 : {
>                  13 : true,
>                  14 : true,
>                  15 : 1280,
>                  16 : [
>                    {
>                      17 : "fe80::200:f8ff:fe21:67cf",
>                      18 : 10
>                    }
>                  ]
>                }
>              }
>            ]
>          }
>        }
>      }
>
>
> -----Original Message-----
> From: Juergen Schoenwaelder [mailto:j.schoenwaelder@jacobs-university.de <j.schoenwaelder@jacobs-university.de>]
> Sent: December-07-15 3:38 PM
> To: Michel Veillette <Michel.Veillette@trilliantinc.com> <Michel.Veillette@trilliantinc.com>
> Cc: Core <core@ietf.org> <core@ietf.org>
> Subject: Re: [core] CBOR Encoding of Data Modeled with YANG
>
> On Mon, Dec 07, 2015 at 08:31:03PM +0000, Michel Veillette wrote:
>
> Hi Juergen
>
> My "smart" quote are now disabled.
> Thanks to motivate me to turn off this nonsense.
>
> About the format/assignment of the numeric data node IDs, the consensus is to keep them out of the YANG to CBOR mapping draft in order to make progress.
>
>
> But this does not make sense. The naming must be settled, even if it is painful.
>
>
> Peoples agree that names encoded as string represents too much overhead to address the needs of constrained devices and constrained networks as defined by RFC 7228. However, there are lots of discussions about how those names can be associated with small IDs encoded as integers and how small those integers need to be.
>
> The CoOL draft proposes structured IDs based on the following concept:
>
>    Only IDs  associated with module names are registered, IDs associated to data node identifiers are automatically generated.
>
>    e.g. draft-ietf-netmod-yang-json-06 page 5
>    for the member-name "foomod:top"
>    the ID associated with the name of the module "foomod" is registered,
>    the ID associated with the data node identifier "top" is auto-generated.
>
> How do you auto-generate data node identifiers? Does the algorithm work with module revisions, augmentations, features, ...?
>
>
> To simplify scaling of the registered module names, different approaches have been proposed:
> - Possibility to allocation ranges of IDs (bundle) to developers and SDOs for distributed assignment.
> - Possibility to define a range of private IDs (IDs locally assigned
> and used, not globally unique, same concept as IPv4 10.x.x.x)
> - Possible to define disjoint registries, implemented using a
> different resource type & default URI path
>
> I need to understand the algorithm for assigning data node identifiers first to see whether this approach makes sense.
>
> /js
>
> --
> Juergen Schoenwaelder           Jacobs University Bremen gGmbH
> Phone: +49 421 200 3587         Campus Ring 1 | 28759 Bremen | Germany
> Fax:   +49 421 200 3103         <http://www.jacobs-university.de/> <http://www.jacobs-university.de/>
>
>
>
> _______________________________________________
> core mailing list
> core@ietf.org
> https://www.ietf.org/mailman/listinfo/core
>
>