[yang-doctors] Modeling of protocol message structures

Ebben Aries <ebben.aries@nokia.com> Thu, 24 September 2020 18:54 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 C1E1B3A1238 for <yang-doctors@ietfa.amsl.com>; Thu, 24 Sep 2020 11:54:35 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -3.596
X-Spam-Level:
X-Spam-Status: No, score=-3.596 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] autolearn=ham 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 fS5lvxKmnDcI for <yang-doctors@ietfa.amsl.com>; Thu, 24 Sep 2020 11:54:34 -0700 (PDT)
Received: from NAM04-BN3-obe.outbound.protection.outlook.com (mail-eopbgr680119.outbound.protection.outlook.com [40.107.68.119]) (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 70FE23A1232 for <yang-doctors@ietf.org>; Thu, 24 Sep 2020 11:54:34 -0700 (PDT)
ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=LrGEhnhCZ/5nUlTsoNI/gsYRsrpVjYrBx7Q+sY1yox8KMb9UxLqoSt9jGO/6Kunnyd3Mx6Pchhb+survsYmSbP3vnyS1tOvGr6sDTmeuCRKDiNrPGStPLXtdTSjiVHBBJBbBs3wIS1ZC4FpJzPEXJJR8xOK9WynlRWhrtUYQFZoqB21yK2un1hJIxWpGvKwrDQhyOuuqd4LrS2ixluQW6ialM3lIiDNq87LvyFi2C4poWwZUGhLrjKxTWKnhGnABEb8B7kChTWVzhAYVQ34cGMMLILaX70yTEVXKWKF3pw+MaTl2lohhEDZtwWKxwl83OP0Ie/bHm39T4dbXrl6zwQ==
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=jR+0auoCjcf9xxYwtXdjTT15naHtdPx50BTLwFZRj2Y=; b=j5vtiLzP7tyjFaVmrbrLV92nsYgAop2I/mlj2cKAnYf6v+S/V+2+HaiPl4cKxv1rjUn+xHvk3uUjgovn9o8AmSGfwQ7NDX5QK3Qi6f8VAtk38Y6Sm+/t4/9XcyDJct2FzccEfjLLKaROy+zbX81wrq9XuuLY6lNL55PWlezCl+eLqfoA9UT8qpHfCywVq6cc46ctfUSCg9J66IaQqGiBVkeJfWQ0KzWdwLtJqcLem6owPgUrPNRo1u9RPlWQM5fw9mAv/sQiY1e2ZWoBaqJ9fmCiUOxPYbMJ/6j4nhNeWR4cystcRiMwV3n0eNeEcvuEnKQav2CmTFOJr9h8GgiBPw==
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=jR+0auoCjcf9xxYwtXdjTT15naHtdPx50BTLwFZRj2Y=; b=yOACWZSe076aJBgCkn7UraF4aciSy8Bc7Bie3H1ZmTVYQxXcTRs4aLFoGiKZuVKEwGKn6ZWMR0a/vvocf56Mu8nFgHBdXFntrJbqplkF6JdU/+spaZkbVGfOg2ubvEJaRcEjiSeBOTmH+2Fo+DclJ8bsVhP+ARrjOFRCy43VfLA=
Authentication-Results: ietf.org; dkim=none (message not signed) header.d=none;ietf.org; dmarc=none action=none header.from=nokia.com;
Received: from BN8PR08MB6258.namprd08.prod.outlook.com (2603:10b6:408:db::14) by BN8PR08MB6177.namprd08.prod.outlook.com (2603:10b6:408:d8::11) 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 18:54:32 +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 18:54:32 +0000
Date: Thu, 24 Sep 2020 12:54:41 -0600
From: Ebben Aries <ebben.aries@nokia.com>
To: YANG Doctors <yang-doctors@ietf.org>
Message-ID: <20200924185441.GA11798@localhost>
Content-Type: text/plain; charset="us-ascii"
Content-Disposition: inline
X-Originating-IP: [131.228.48.74]
X-ClientProxiedBy: CH2PR20CA0002.namprd20.prod.outlook.com (2603:10b6:610:58::12) 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 CH2PR20CA0002.namprd20.prod.outlook.com (2603:10b6:610:58::12) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.3412.23 via Frontend Transport; Thu, 24 Sep 2020 18:54:32 +0000
X-MS-PublicTrafficType: Email
X-MS-Office365-Filtering-HT: Tenant
X-MS-Office365-Filtering-Correlation-Id: d75b6e4c-41a9-4764-761e-08d860bb4621
X-MS-TrafficTypeDiagnostic: BN8PR08MB6177:
X-Microsoft-Antispam-PRVS: <BN8PR08MB617712384B3594D464A59ACDFB390@BN8PR08MB6177.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: iWjkA8+L2OUTm4MebNAVN8mDxYbCpgNokvU14MFepvuoAp+4o7/hcvi5soN7jS/JnJV+rhvRX5droOGzRMGreG637s6u7DTKq5mt75nu9WiczFpcCcM4igIGwRmd3oj+vxIabR/wNrg8BTK8miUXVoOQoAPtufyJi7oahQZmQ2gHTwD/bjqhRAUdnzedQxX5IGGAfSZ9hM/CM3DCJTU+J7CldZZY1NJwM2CM7cxkAs7KHdVwk8vVOEE3w8GIH/ZIMm8tn/Wg+G1ct1Gf6+LqiAqEop323C1ToPkT+Co6RAZ8OE1ICeqfHfQiwN+1ph5c+tGTKCrzheLSKMCOQbQ2kg==
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)(396003)(346002)(376002)(136003)(366004)(39860400002)(86362001)(478600001)(8676002)(8936002)(83380400001)(6496006)(6666004)(15650500001)(52116002)(9576002)(5660300002)(16526019)(2906002)(26005)(44832011)(1076003)(956004)(6916009)(33716001)(66476007)(66946007)(186003)(33656002)(66556008)(55016002)(9686003)(316002); DIR:OUT; SFP:1102;
X-MS-Exchange-AntiSpam-MessageData: Du6nJGbPg9LOs/K5NxVhIARN1SDW2BoEq/XiFsGz4dNERCqSfSDzrBR3RBwgPcsX493QXSH6/d3zVA7hCrsBFp/kLcTML9mWK2Ba7C+7mxhEmd1ngNPYGVh0L5Lu+iqTQ8zagydnScnwHhGANgfaA6ss6WjR3605W4eaeIeMzyJdd0RcoTlMFilyIry+akN83Lx9jsANQF3OsmCNDpjLWFWzgg2eqzlBBqM3j9g2TSlAiWHMhaW+xEzDpBm1nD6IGm25mWkEfueZwQAwStxNdyHcQbRRWawd8tw5vS7CQMUgOMbYY7kAbO+WSVGX79aqNEzm1RUGKrXIluMdX2/s8Xhyi8HlsbpyxWWlI3Ax33iT25wzhDmlTdCVKMizb/nVCwyJeQgWsvTXRsWzEp+JdxfLy4l0mQWdmDg8OLc4eDxwJ8EY8oq/LqAVC08P4b5LPOn8jmX0YBj/vOxbpFwpOhGKM0L8VQvxxli26nPBI2wy4P0wkZxqJ62ggQc/GVAZD921nRgu8hx6ullCOhgQ4zmURGZIx8hndxr1hTGdoxJo8FtVbilJwHCqy+O2LhUDQjN7vxkKgX8/vvvnSE3WPTZniTMQLmPV0UyETsHBuc6cVwwfOFUWfhDziLTzjrjVL10MMleExJiety/96copSQ==
X-OriginatorOrg: nokia.com
X-MS-Exchange-CrossTenant-Network-Message-Id: d75b6e4c-41a9-4764-761e-08d860bb4621
X-MS-Exchange-CrossTenant-AuthSource: BN8PR08MB6258.namprd08.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 24 Sep 2020 18:54:32.6804 (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: gKTVvFZK3Ms3v6znPcCjBgBwP+jnGXGfw5cT6d6jN2IJRFMNq//7wdEkWEQN9aGNzDb7wD1unakSyH1vDY0bUQ==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: BN8PR08MB6177
Archived-At: <https://mailarchive.ietf.org/arch/msg/yang-doctors/Ub9KoJGlAM8eIfbnflqtk2oX_Wk>
Subject: [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 18:54:36 -0000

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