Re: [yang-doctors] Modeling of protocol message structures

Andy Bierman <andy@yumaworks.com> Thu, 24 September 2020 19:46 UTC

Return-Path: <andy@yumaworks.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 8A4F23A1258 for <yang-doctors@ietfa.amsl.com>; Thu, 24 Sep 2020 12:46:06 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.887
X-Spam-Level:
X-Spam-Status: No, score=-1.887 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, HTML_MESSAGE=0.001, SPF_HELO_NONE=0.001, T_SPF_PERMERROR=0.01, URIBL_BLOCKED=0.001] autolearn=unavailable autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (2048-bit key) header.d=yumaworks-com.20150623.gappssmtp.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 1Q_KhHywZn_i for <yang-doctors@ietfa.amsl.com>; Thu, 24 Sep 2020 12:46:02 -0700 (PDT)
Received: from mail-lj1-x22a.google.com (mail-lj1-x22a.google.com [IPv6:2a00:1450:4864:20::22a]) (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 1FF9E3A1226 for <yang-doctors@ietf.org>; Thu, 24 Sep 2020 12:46:02 -0700 (PDT)
Received: by mail-lj1-x22a.google.com with SMTP id a15so452950ljk.2 for <yang-doctors@ietf.org>; Thu, 24 Sep 2020 12:46:01 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=yumaworks-com.20150623.gappssmtp.com; s=20150623; h=mime-version:references:in-reply-to:from:date:message-id:subject:to :cc; bh=dl4VlsLqh155ubBc2hvEOcqOGIBgAm/B3N4iWudBuo4=; b=ZjM3rzs+162YxGewShyxOCwZlgjV23ss+qb8Baq2FZ0z9ClFXf6U43vTIiUYVM8maL pM0RxWkQZ7OFjoHd2ugMHcWSM6iswgFhGlF7x0By2iX++jdSJKilXUwJTG/6h0hH4kPB Ea5xbnYNEhUnOCyUOjbIBAos5+9oSbDI++y6E2QMFCgSDYKZrRTIc2sraVg+m5cq0aVG Iy4Ta+/fr+YmfejviRpsFhdH7F8T3nYrFx9qHragmdkwh9XztcuDekNldMsVQSkfbDT7 QG3T3jXqMvx6GKsV54mZ8al40gQTvOxfbD9w3qWdcCgoAt+CHihii97VO+2LIC8qKU/g DpAw==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=dl4VlsLqh155ubBc2hvEOcqOGIBgAm/B3N4iWudBuo4=; b=Wi13QMeZJu63u0yKOKTwHxrFEg9/2rQF6CDEcMwfYeZsFeSgK4uF0C+1R0Rqv4pluf uvI/3ormg1/HdIvynFfTPx4TFjdQWt6YJFEnf8F9XZWXdoPMwNZUCcTqEIVsmcDidWXz Vw9geqRUQMMtn4BFjh1HdfmW1N/8pWaMdVP120AphFHP1WSFwdPzWi5b7n4bPQ7tdY/r NRxgjhJSEEb0xBcC5LVRnPfkKO6l8Zyg7i5nNKffsYZ17ZdFsnbnQfnRaDMhv1tQ9Knt BQ26Llmu6mmV92ddQdysihxv86LLW9YxigTYZ2diNMAQIE6chw9l9YWunS60zZv+zde5 lMGQ==
X-Gm-Message-State: AOAM531gSno2wntPUOq+FKp89Tv3oOhweBEsoEvK41/jmUHKpsGbF40s IHyuwy92GNzMsQx3WIMWEqPXw5Du0Sh0lhA5PNJ5ZA==
X-Google-Smtp-Source: ABdhPJxk6o4GdtlvYEPIjbUNoP5yvzBRvUFrwvj9PAZnIg5PAUhZWalAs5SIBFfZsreig/m498uj+cn7TDdXozFZVfw=
X-Received: by 2002:a2e:a550:: with SMTP id e16mr196739ljn.125.1600976760091; Thu, 24 Sep 2020 12:46:00 -0700 (PDT)
MIME-Version: 1.0
References: <20200924185441.GA11798@localhost> <674AE5F9-72B6-41B5-A5FF-3904A0C59BE1@cisco.com>
In-Reply-To: <674AE5F9-72B6-41B5-A5FF-3904A0C59BE1@cisco.com>
From: Andy Bierman <andy@yumaworks.com>
Date: Thu, 24 Sep 2020 12:45:49 -0700
Message-ID: <CABCOCHTX1uEC7KGeSYdqN764tcv-uGpjoPqQtUgDgj1FkQHVRg@mail.gmail.com>
To: "Acee Lindem (acee)" <acee=40cisco.com@dmarc.ietf.org>
Cc: Ebben Aries <ebben.aries@nokia.com>, YANG Doctors <yang-doctors@ietf.org>
Content-Type: multipart/alternative; boundary="00000000000014507705b01473a4"
Archived-At: <https://mailarchive.ietf.org/arch/msg/yang-doctors/RAXYBVOEotuxNHbMdNh8rxNsPpU>
Subject: Re: [yang-doctors] Modeling of protocol message structures
X-BeenThere: yang-doctors@ietf.org
X-Mailman-Version: 2.1.29
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: Thu, 24 Sep 2020 19:46:07 -0000

On Thu, Sep 24, 2020 at 12:16 PM Acee Lindem (acee) <acee=
40cisco.com@dmarc.ietf.org> wrote:

> Hi Ebben, Esteemed Doctors,
> It would be good to understand the reasons for using YANG as a message
> schema language and how it relates to the tooling and bits on the wire.
> Note that I didn't read the document other than looking at the YANG model
> so perhaps these questions are addressed.
>


We have been using YANG to drive protocol message automation for years.
Since the tools already support YANG for NETCONF this is not hard to add.

The main reasons:
   - want a formal definition of the message exchanges
   - want to annotate the model with tool-specific extensions to automate
lots of corner-cases
   - want an encoding-neutral message definition
   - want to utilize existing support to send/receive YANG data in
different encodings
       - lots of XML now but we already cover all data with JSON and soon
CBOR
   - using augment it is easy to define message payloads in layers


Thanks,
> Acee
>


Andy


>
> On 9/24/20, 2:55 PM, "yang-doctors on behalf of Ebben Aries" <
> yang-doctors-bounces@ietf.org on behalf of ebben.aries@nokia.com> wrote:
>
>     I wanted to solicit feedback/opinions from a recent review (that at
>     least 1 other of you have had the chance to review) - The draft in
>     question is draft-ietf-dots-rfc8782-bis-00
>
>     Now, this is the first I've seen to make its way through YD review (and
>     maybe there are others) but the above is an example of modeling the
>     message structure payload for the DOTS signaling channel over CoAP.
>     There is no relationship to NETCONF/RESTCONF and/or datastores but
>     rather just definitions of pure message structures as best as can be
>     described in the YANG language (with implementation details left to the
>     specficiation).
>
>     For the most part, I think this is fine and a possible use being code
>     generation but still need to factor in statements that will not
>     translate directly to underlying language semantics and/or rules and
>     restrictions that sit outside of the data-model (and only in the
>     specification or description stmt) - Is the use being force fit for
> this
>     type of case?
>
>     My questions/comments to everyone:
>
>     - Are we starting to see this as the norm for newer protocol
>       specifications in general and is there any rule around such or is it
>       up to each author if they want to model any message structures or not
>       in the YANG language and publish a module?
>
>     - Is the above necessary?  Does this provide much if any advantage to
>       doing so in comparison to the maintenance, publication and potential
>       for confusion?
>
>     - We now have the potential for publication of a large amount of YANG
>       models that may or may not apply to the regular use to date.  You
>       cannot tell the difference or purpose of these modules by purely
>       looking at any identifier in the module name or header today.
>
>     - To the above point, modules will be published that could very well
>       conflict with proper names of future modules that are centered around
>       datastore interaction for that same domain.
>
>     - (Specific to the review and not structures themselves) - Some modules
>       related to above have been published and am assuming these did not go
>       through YD review.  We now have very generic prefixes published such
>       as 'data-channel'.  While of local significance, we should be more
>       descriptive and unique across IETF or IANA published modules.
>
>     Thx
>
>     /ebben
>
>     _______________________________________________
>     yang-doctors mailing list
>     yang-doctors@ietf.org
>     https://www.ietf.org/mailman/listinfo/yang-doctors
>
> _______________________________________________
> yang-doctors mailing list
> yang-doctors@ietf.org
> https://www.ietf.org/mailman/listinfo/yang-doctors
>