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

Ebben Aries <ebben.aries@nokia.com> Thu, 24 September 2020 20:06 UTC

Return-Path: <ebben.aries@nokia.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 4F4BB3A1257 for <yang-doctors@ietfa.amsl.com>; Thu, 24 Sep 2020 13:06:29 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -3.595
X-Spam-Level:
X-Spam-Status: No, score=-3.595 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIMWL_WL_HIGH=-1.695, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, MSGID_FROM_MTA_HEADER=0.001, RCVD_IN_MSPIKE_H2=-0.001, SPF_PASS=-0.001, URIBL_BLOCKED=0.001] autolearn=unavailable autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (1024-bit key) header.d=nokia.onmicrosoft.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 hqE9H7djDuaM for <yang-doctors@ietfa.amsl.com>; Thu, 24 Sep 2020 13:06:27 -0700 (PDT)
Received: from NAM11-DM6-obe.outbound.protection.outlook.com (mail-dm6nam11on2133.outbound.protection.outlook.com [40.107.223.133]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id C31003A1258 for <yang-doctors@ietf.org>; Thu, 24 Sep 2020 13:06:27 -0700 (PDT)
ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=hLi0q/JCOMDrknzNL0yUWZatwagX6ajtTBuk7VOJRmCm1S85jUOt71pWUJadjPpxNhy769CBdnfQdsQyBYx2mMxZDyCq9tHG07oU4974u2NJ0GxrqIVb9OcHOnlWnH6bADOuSE/tQ+sm3cQWnpzYAnD8T3uGsyCRXraKNFN+jm4S7Y7BFEJzjLVm/Z4u7raVcdibUoG/0grmDoT9s9nxMguwKetCdst+4ccyQ3pmbx1AxSIRvH4bpUvbbMuvq3UEUbghJhREN/FhdVq4qkvMXbYp98F9/1l/COkM7ZQqAg8PT7kAjxBXTFsxR4xgoSPh1kGTurCJJZIY0K59Ut+M8g==
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=T0rr9gOMHD28sL9fXOnR/tng51/a0bn0KI/tkrn+99o=; b=cvTTbt2gzJsgB9/3HsDx2CvTxvagvwrB++UPAzjyNvnyvgPPG2Y232U1HYpY9H9dBzTtyx5CnrVjDBeqort25Az8sqNDRFuV/8ohS5l6uspRH+0nB3o4xdIDb2vieXZHwYcAYL+BT57qvJQeuBJqPRd0zOZ5Ne/WXyR7Lj2uLcmEfDgxT4dqKx+T+8ISB13/EH8B6PreozLOXs85Fc6dPXyhYLWQYw7Hca65joX5nVi82izezKFKssUPJfR98obARm31WeOEQHX96td4PlsWApECCjIPhrHmsH+9Yil0GM0XxpIbpoPrxTGtzsIgu1IfyEVeI5zWrgbgC1dcMZ86Bg==
ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=nokia.com; dmarc=pass action=none header.from=nokia.com; dkim=pass header.d=nokia.com; arc=none
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=nokia.onmicrosoft.com; s=selector1-nokia-onmicrosoft-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=T0rr9gOMHD28sL9fXOnR/tng51/a0bn0KI/tkrn+99o=; b=kvPYmZyBrQesyMi9sCY3FNn/1IGS51MC1ZY45c78/rhZ14JB9Pdf5pMcS8/Vyoj8uY5Wp1TNH1ALW2OQ8u3Hz0TnESsB7903IToCmN8JmZuKp64YJsbKCHmmW7RMfy4ERMys575bQKHteWx9NhfHsezw+sU/m6mEiSzNSmZbNDU=
Authentication-Results: yumaworks.com; dkim=none (message not signed) header.d=none;yumaworks.com; dmarc=none action=none header.from=nokia.com;
Received: from BN8PR08MB6258.namprd08.prod.outlook.com (2603:10b6:408:db::14) by BN7PR08MB6033.namprd08.prod.outlook.com (2603:10b6:408:37::17) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.3391.11; Thu, 24 Sep 2020 20:06:18 +0000
Received: from BN8PR08MB6258.namprd08.prod.outlook.com ([fe80::292e:c8f:4e0b:a202]) by BN8PR08MB6258.namprd08.prod.outlook.com ([fe80::292e:c8f:4e0b:a202%9]) with mapi id 15.20.3412.022; Thu, 24 Sep 2020 20:06:18 +0000
Date: Thu, 24 Sep 2020 14:06:27 -0600
From: Ebben Aries <ebben.aries@nokia.com>
To: Andy Bierman <andy@yumaworks.com>
Cc: "Acee Lindem (acee)" <acee=40cisco.com@dmarc.ietf.org>, YANG Doctors <yang-doctors@ietf.org>
Message-ID: <20200924200627.GA16594@localhost>
References: <20200924185441.GA11798@localhost> <674AE5F9-72B6-41B5-A5FF-3904A0C59BE1@cisco.com> <CABCOCHTX1uEC7KGeSYdqN764tcv-uGpjoPqQtUgDgj1FkQHVRg@mail.gmail.com>
Content-Type: text/plain; charset="us-ascii"
Content-Disposition: inline
In-Reply-To: <CABCOCHTX1uEC7KGeSYdqN764tcv-uGpjoPqQtUgDgj1FkQHVRg@mail.gmail.com>
X-Originating-IP: [131.228.48.74]
X-ClientProxiedBy: CH2PR20CA0015.namprd20.prod.outlook.com (2603:10b6:610:58::25) To BN8PR08MB6258.namprd08.prod.outlook.com (2603:10b6:408:db::14)
MIME-Version: 1.0
X-MS-Exchange-MessageSentRepresentingType: 1
Received: from localhost (131.228.48.74) by CH2PR20CA0015.namprd20.prod.outlook.com (2603:10b6:610:58::25) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.3412.20 via Frontend Transport; Thu, 24 Sep 2020 20:06:17 +0000
X-MS-PublicTrafficType: Email
X-MS-Office365-Filtering-HT: Tenant
X-MS-Office365-Filtering-Correlation-Id: 396272c6-4246-42af-a9d9-08d860c54c9f
X-MS-TrafficTypeDiagnostic: BN7PR08MB6033:
X-Microsoft-Antispam-PRVS: <BN7PR08MB6033C881DEAD8FFDFB8F693FFB390@BN7PR08MB6033.namprd08.prod.outlook.com>
X-MS-Oob-TLC-OOBClassifiers: OLM:10000;
X-MS-Exchange-SenderADCheck: 1
X-Microsoft-Antispam: BCL:0;
X-Microsoft-Antispam-Message-Info: 7FP1Pm59Y1s3IJ5QARPN6hvipBA+kuQtigyuLrnTAOI3ilzSeO90dAIsLpEjdgkDGpSW2XR+v69i6YfRx2n5TCNkFz3DiZO7EWbNRkPOnACeTL+dEVVHl/kxg6xJlbm6oZcrqxFwEqsiRtS4pufctaGPyvhE5DI/xE1ljfd1pMiZvI9EuuPP7wPokKXwqKZ7n8ruf3WXUmyWBp3dvmvQcmOymfGBAIhQdIXHorlKVr6mXPDifyRwyjIyeZuLEMaz6GsVYI2H/gWdmO+I/tU8MlPrjanXJ2YhfCHWf+TSS7r3k2WVE5+CbJY3yoHR5SSed2TDw0Ir/WjYP5mXnGdHbKFWEydyOBzfEeRTq4Dz2d6wIh3/aDDr0/bHup2o2srbexSqxZxNNeBQxhLV1cQ54w==
X-Forefront-Antispam-Report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:BN8PR08MB6258.namprd08.prod.outlook.com; PTR:; CAT:NONE; SFS:(4636009)(39860400002)(346002)(136003)(376002)(396003)(366004)(8936002)(83380400001)(86362001)(2906002)(8676002)(9576002)(54906003)(478600001)(966005)(44832011)(33656002)(15650500001)(956004)(33716001)(66476007)(9686003)(6916009)(6666004)(1076003)(16526019)(52116002)(55016002)(316002)(53546011)(66946007)(6496006)(66556008)(26005)(186003)(5660300002)(4326008); DIR:OUT; SFP:1102;
X-MS-Exchange-AntiSpam-MessageData: xLN9tnfz+M4MILFUi8ur/n56p52ElDveKjnRx8S7eEBxbiLsFlDfZrgi3LAWVGAgIgh2OIup9m5IyGxfY9ynJbGkRaNB9K/ypIeG4mupTt2Ro8EwiH18FXr/4guihxQ3Wf+JFCBQ2pU+AbpOTwhuJIFRkuSNrISmAOg3+YBXYEVcwDpez1sXOENoLjS0dTJOa1/Oo+qCgz8bejdnr6OLrsL6VKFT8Z4q673ja/N2IIsUmpc9WfOilDujWY8iFGoVprRhUfAIFsprGYELzy81WmLNgv8n/gYDWDYVklDLSXujjR+Pi6u5Eratt8f9jxhua6gc5jjfF2LoTLcZG+Y0REXUqsReLEFaIn7kBpzmD/LlKNanEYsWWJ08uiJcfN1GJ6lPl5R7Nb7RfPfkWFS9UFcSS+d/XRgn/2+okxOhOh0NCQOSgmjCC1X7CbLQtKE0A/P1zWcwnGKgC1VD6goGxi7OW8VsVZ+uK3BPR/hNxNZyJJYvaZ5rUAloqArglERfqauS4RgjtuDKC2CtZ36pGdguV/CQsRupW/UJCrz/WK0YusqN3ZVMDddCdltlH0bco6BtB1DDS17lmj/4Ox3BgVhyD+zqmUhFQtfyktudNVibX4Ax5dKIsq1uP1sO4pHGzczAbDm1ldeRnSiuJ0xtHw==
X-OriginatorOrg: nokia.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 396272c6-4246-42af-a9d9-08d860c54c9f
X-MS-Exchange-CrossTenant-AuthSource: BN8PR08MB6258.namprd08.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 24 Sep 2020 20:06:18.5371 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 5d471751-9675-428d-917b-70f44f9630b0
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: SxzPkTNzZrsA6IQbsVXkvRQdsuPrGC0fOFBsk6JF91EU5adNVmU9/HH9pWGO82NRDlNCYRWlq8lXk3fhErrWhw==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: BN7PR08MB6033
Archived-At: <https://mailarchive.ietf.org/arch/msg/yang-doctors/lJx8z-hHdiYzmM83Y_12kGLEZno>
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 20:06:29 -0000

On Sep 24 12:45 PM, Andy Bierman wrote:
> 
> 
> 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
>

Yes and all great reasons however my questions/comments are more
specific as to the publication of protocol message structures in IETF
documents as published IETF and IANA YANG models.

This document is the first I've seen attempting to do such.

And are we going to go back through other protocols to date and develop
message structure modules for those?

Before I raise the question of intent as to why back towards the
document author, I wanted to understand if anyone else has been seeing
this approach in IETF documents yet (or if it is being
promoted/mandated)

> 
> 
>     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
>