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

Lou Berger <lberger@labn.net> Fri, 09 June 2017 14:12 UTC

Return-Path: <lberger@labn.net>
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 513A1129483 for <netmod@ietfa.amsl.com>; Fri, 9 Jun 2017 07:12:18 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -4.2
X-Spam-Level:
X-Spam-Status: No, score=-4.2 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H2=-2.8, RCVD_IN_SORBS_SPAM=0.5, SPF_PASS=-0.001, URIBL_BLOCKED=0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (768-bit key) header.d=labn.net
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 oe9mRDjcZwfM for <netmod@ietfa.amsl.com>; Fri, 9 Jun 2017 07:12:16 -0700 (PDT)
Received: from gproxy8.mail.unifiedlayer.com (gproxy8-pub.mail.unifiedlayer.com [67.222.33.93]) (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 3ADAC12426E for <netmod@ietf.org>; Fri, 9 Jun 2017 07:12:16 -0700 (PDT)
Received: from CMOut01 (unknown [10.0.90.82]) by gproxy8.mail.unifiedlayer.com (Postfix) with ESMTP id A87581AB07A for <netmod@ietf.org>; Fri, 9 Jun 2017 08:12:15 -0600 (MDT)
Received: from box313.bluehost.com ([69.89.31.113]) by CMOut01 with id WeCB1v00r2SSUrH01eCE55; Fri, 09 Jun 2017 08:12:15 -0600
X-Authority-Analysis: v=2.2 cv=K+5SJ2eI c=1 sm=1 tr=0 a=h1BC+oY+fLhyFmnTBx92Jg==:117 a=h1BC+oY+fLhyFmnTBx92Jg==:17 a=IkcTkHD0fZMA:10 a=xqWC_Br6kY4A:10 a=LWSFodeU3zMA:10 a=48vgC7mUAAAA:8 a=SJoBkxFSY3z_vumiJPcA:9 a=KMrDw2QKs0pXkGpL:21 a=TWgvJRPUaKaY2-84:21 a=QEXdDO2ut3YA:10 a=w1C3t2QeGrPiZgrLijVG:22
DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=labn.net; s=default; h=Content-Transfer-Encoding:Content-Type:In-Reply-To:MIME-Version :Date:Message-ID:From:References:To:Subject:Sender:Reply-To:Cc:Content-ID: Content-Description:Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc :Resent-Message-ID:List-Id:List-Help:List-Unsubscribe:List-Subscribe: List-Post:List-Owner:List-Archive; bh=UXd/Gwmaam7aNWHf3EUpyjMDm/5uCiVLOS03jfkUKPo=; b=T8xOfvOzzAWicD2FQjWwPWyd9y 47FqmI8uBSDsq+C8zJbWVjDa5g+6wyx7v6zvPqlzYoLqtyYerflUx6txJXKbfnM17FMe1xM3KUX7k Rz6wc9N7uoYdeNpWTzdDvPS5R;
Received: from pool-100-15-84-20.washdc.fios.verizon.net ([100.15.84.20]:37746 helo=[IPv6:::1]) by box313.bluehost.com with esmtpsa (TLSv1.2:ECDHE-RSA-AES128-GCM-SHA256:128) (Exim 4.87) (envelope-from <lberger@labn.net>) id 1dJKe3-0000j4-O6; Fri, 09 Jun 2017 08:12:11 -0600
To: Benoit Claise <bclaise@cisco.com>, NETMOD Working Group <netmod@ietf.org>
References: <767b9462-80ad-2942-f67e-31789239b894@cisco.com>
From: Lou Berger <lberger@labn.net>
Message-ID: <9acb5757-c520-b9a1-bff6-6a7aa67d776a@labn.net>
Date: Fri, 9 Jun 2017 10:12:10 -0400
User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64; rv:52.0) Gecko/20100101 Thunderbird/52.1.1
MIME-Version: 1.0
In-Reply-To: <767b9462-80ad-2942-f67e-31789239b894@cisco.com>
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 8bit
Content-Language: en-US
X-AntiAbuse: This header was added to track abuse, please include it with any abuse report
X-AntiAbuse: Primary Hostname - box313.bluehost.com
X-AntiAbuse: Original Domain - ietf.org
X-AntiAbuse: Originator/Caller UID/GID - [47 12] / [47 12]
X-AntiAbuse: Sender Address Domain - labn.net
X-BWhitelist: no
X-Source-IP: 100.15.84.20
X-Exim-ID: 1dJKe3-0000j4-O6
X-Source:
X-Source-Args:
X-Source-Dir:
X-Source-Sender: pool-100-15-84-20.washdc.fios.verizon.net ([IPv6:::1]) [100.15.84.20]:37746
X-Source-Auth: lberger@labn.net
X-Email-Count: 4
X-Source-Cap: bGFibm1vYmk7bGFibm1vYmk7Ym94MzEzLmJsdWVob3N0LmNvbQ==
Archived-At: <https://mailarchive.ietf.org/arch/msg/netmod/j9YXyBr7HY35qxI2si6quDn4Z9Q>
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: Fri, 09 Jun 2017 14:12:18 -0000

Benoit,

    Thanks for this!

WG,

    Now would be a good time to take a look at, and comment on,
draft-dsdt-nmda-guidelines
<https://datatracker.ietf.org/doc/draft-dsdt-nmda-guidelines/> also
consider how this document impacts draft-ietf-netmod-rfc6087bis
(particularly section 5.23).  Optimally we could have a proposed
revision to draft-ietf-netmod-rfc6087bis discussed on the list prior to
Prague, but I know I'm being optimistic.

Lou and Kent


On 6/9/2017 9:56 AM, Benoit Claise 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
> https://www.ietf.org/mailman/listinfo/netmod