Re: [netmod] Important: Guidelines for YANG module authors

Benoit Claise <bclaise@cisco.com> Sat, 10 June 2017 06:49 UTC

Return-Path: <bclaise@cisco.com>
X-Original-To: netmod@ietfa.amsl.com
Delivered-To: netmod@ietfa.amsl.com
Received: from localhost (localhost [127.0.0.1]) by ietfa.amsl.com (Postfix) with ESMTP id A10E31293F3 for <netmod@ietfa.amsl.com>; Fri, 9 Jun 2017 23:49:31 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -14.522
X-Spam-Level:
X-Spam-Status: No, score=-14.522 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, RP_MATCHES_RCVD=-0.001, SPF_HELO_PASS=-0.001, SPF_PASS=-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 nVFlBmP6ZlqP for <netmod@ietfa.amsl.com>; Fri, 9 Jun 2017 23:49:25 -0700 (PDT)
Received: from aer-iport-3.cisco.com (aer-iport-3.cisco.com [173.38.203.53]) (using TLSv1.2 with cipher DHE-RSA-SEED-SHA (128/128 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 5AEE11293E9 for <netmod@ietf.org>; Fri, 9 Jun 2017 23:49:24 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=cisco.com; i=@cisco.com; l=12375; q=dns/txt; s=iport; t=1497077364; x=1498286964; h=subject:to:cc:references:from:message-id:date: mime-version:in-reply-to; bh=xix8V933XyCJibwspPtf+QAP3ScFL8j5FiC9mN7hurs=; b=mRoUG9AljTGntl85flsEFaX6cWH7HrV+YFzFlr9FPaeKa0S5Hdg+DoE8 CaHqRBfmKszFzCEbPZPHDbJuxf+jtSKJgKuvxUuhiVOB9Maq18I3gNn/4 GD0FZ80e8qwGc1qxIr2D+bUS6YGhFve/m7w1GV1elu+EidP0WGS3CLuwk c=;
X-IronPort-Anti-Spam-Filtered: true
X-IronPort-Anti-Spam-Result: =?us-ascii?q?A0A9AQAtlTtZ/xbLJq1cGQEBAQEBAQEBA?= =?us-ascii?q?QEBBwEBAQEBgyuBD4ENg3SKGHOQWiGQSoU5ghEhAQqFLkoCg0AYAQIBAQEBAQE?= =?us-ascii?q?BayiFGQEBAQMBASFLCxALDgQGJwMCAicfAw4GAQwGAgEBF4oRELEfgiYrizkBA?= =?us-ascii?q?QEBAQEBAQEBAQEBAQEBAQEBAQEYBYZhgWArC4Jqh3yCYQWQdoYShzWHK1uLQoI?= =?us-ascii?q?GhUODS4ZyjC6DU4RqHzg/SzAhCBsVSAiBcYJagj0+Noc0KoIVAQEB?=
X-IronPort-AV: E=Sophos;i="5.39,321,1493683200"; d="scan'208,217";a="653496362"
Received: from aer-iport-nat.cisco.com (HELO aer-core-1.cisco.com) ([173.38.203.22]) by aer-iport-3.cisco.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 10 Jun 2017 06:49:19 +0000
Received: from [10.55.221.37] (ams-bclaise-nitro4.cisco.com [10.55.221.37]) by aer-core-1.cisco.com (8.14.5/8.14.5) with ESMTP id v5A6nJkn007543; Sat, 10 Jun 2017 06:49:19 GMT
To: Kent Watsen <kwatsen@juniper.net>, Andy Bierman <andy@yumaworks.com>
Cc: NETMOD Working Group <netmod@ietf.org>
References: <767b9462-80ad-2942-f67e-31789239b894@cisco.com> <CABCOCHTQBxf7Ep8nUL2TXLpfTEEK2Zc-6uq4oOOynfXVCHMnLg@mail.gmail.com> <4F84D7BA-4FBE-4C39-9633-D19976C6E388@juniper.net>
From: Benoit Claise <bclaise@cisco.com>
Message-ID: <e2773ac4-c781-4986-da29-765cbd3902ba@cisco.com>
Date: Sat, 10 Jun 2017 08:49:19 +0200
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64; rv:52.0) Gecko/20100101 Thunderbird/52.1.1
MIME-Version: 1.0
In-Reply-To: <4F84D7BA-4FBE-4C39-9633-D19976C6E388@juniper.net>
Content-Type: multipart/alternative; boundary="------------EF691065C0E0FF799E8637CC"
Content-Language: en-US
Archived-At: <https://mailarchive.ietf.org/arch/msg/netmod/pDLDm8gdIBwwyGyfa_acVKHtu_Q>
Subject: Re: [netmod] Important: Guidelines for YANG module authors
X-BeenThere: netmod@ietf.org
X-Mailman-Version: 2.1.22
Precedence: list
List-Id: NETMOD WG list <netmod.ietf.org>
List-Unsubscribe: <https://www.ietf.org/mailman/options/netmod>, <mailto:netmod-request@ietf.org?subject=unsubscribe>
List-Archive: <https://mailarchive.ietf.org/arch/browse/netmod/>
List-Post: <mailto:netmod@ietf.org>
List-Help: <mailto:netmod-request@ietf.org?subject=help>
List-Subscribe: <https://www.ietf.org/mailman/listinfo/netmod>, <mailto:netmod-request@ietf.org?subject=subscribe>
X-List-Received-Date: Sat, 10 Jun 2017 06:49:31 -0000

On 6/10/2017 5:42 AM, Kent Watsen wrote:
>
> Yes, let's rewrite 6.23 completely to state more helpfully what's in 
> the guidelines draft.
>
> I don't expect the guidelines doc is going to progress independently.
Agreed.

Regards, B.
>
> Kent. // shepherd
>
>
> On Jun 9, 2017, at 1:06 PM, Andy Bierman <andy@yumaworks.com 
> <mailto:andy@yumaworks.com>> wrote:
>
>> Hi,
>>
>> I am trying to complete rfc6087bis.
>> It has been held up waiting for this draft.
>> It is not clear to me how sec. 6.23 (Operational Data) needs to change.
>> Should the whole section be replaced by an informative reference to 
>> this new draft?
>>
>>
>> Andy
>>
>>
>> On Fri, Jun 9, 2017 at 6:56 AM, Benoit Claise <bclaise@cisco.com 
>> <mailto:bclaise@cisco.com>> wrote:
>>
>>     Dear all,
>>
>>     Now that the new NETMOD and NETCONF charters have been approved,
>>     it's time to think about the guidelines for YANG module authors.
>>
>>     The Network Management Datastore Architecture (NMDA) addresses
>>     the so-called "OpState problem" that has been the subject of much
>>     discussion in the IETF. NMDA is still in development, and there
>>     will be a transition period before NMDA solutions are universally
>>     available.
>>
>>     The NETMOD Datastore Design Team and the Routing Yang
>>     Architecture Design Team have worked with Alia and Benoit to
>>     create initial guidelines for how the NMDA, as defined in
>>     draft-ietf-netmod-revised-datastores
>>     <https://datatracker.ietf.org/doc/draft-ietf-netmod-revised-datastores/>,
>>     impacts Yang models. The draft-dsdt-nmda-guidelines
>>     <https://datatracker.ietf.org/doc/draft-dsdt-nmda-guidelines/>
>>     individual draft was foundational in helping creating those
>>     guidelines.
>>
>>     If you have questions or concerns on how these guidelines should
>>     apply to work of interest, please contact your WG Chairs or ADs.
>>
>>     It is our strong recommendation, as ADs with agreement from the
>>     NETMOD WG Chairs, that models SHOULD move as quickly as possible
>>     to the NMDA. The specific approach to be taken for models being
>>     developed now and during the NMDA transition period should be
>>     based on both the expected usage and the maturity of the data model.
>>
>>     1. New models and models that are not concerned with the
>>     operational state of configuration information SHOULD immediately
>>     be structured to be NMDA-compatible.
>>
>>     2. Models that require immediate support for "in use" and "system
>>     created" information SHOULD be structured for NMDA. Then derived
>>     versions of these models SHOULD be created, either by hand or
>>     with suitable tools, that follow the current modeling strategies.
>>     In some cases, the non-NMDA model may be an existing model and
>>     not derived from the NMDA model. In all cases, the NMDA and
>>     non-NMDA modules SHOULD be published in the same document, with
>>     NMDA modules in the document main body and the non-NMDA modules
>>     in an Appendix. The use of the non-NMDA model will allow
>>     temporary bridging of the time period until NMDA implementations
>>     are available. The non-NMDA module names should include ’-state’
>>     appended.
>>
>>     We would like to thank Kent Watsen, Lou Berger, Rob Wilton,
>>     Martin Bjorklund, Phil Shafer, Acee Lindem, Chris Hopps, Juergen
>>     Schoenwaelder, and all others who helped develop these guidelines.
>>
>>     Regards,
>>     Alia Atlas, Routing AD
>>     Deborah Brungard, Routing AD
>>     Alvaro Retana, Routing AD
>>     Warren Kumari, Operations & Management AD
>>     Benoit Claise, Operations & Management AD
>>
>>     _______________________________________________
>>     netmod mailing list
>>     netmod@ietf.org <mailto:netmod@ietf.org>
>>     https://www.ietf.org/mailman/listinfo/netmod
>>     <https://www.ietf.org/mailman/listinfo/netmod>
>>
>>
>> _______________________________________________
>> netmod mailing list
>> netmod@ietf.org <mailto:netmod@ietf.org>
>> https://www.ietf.org/mailman/listinfo/netmod