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

Kent Watsen <kwatsen@juniper.net> Sat, 10 June 2017 03:42 UTC

Return-Path: <kwatsen@juniper.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 99956128AFE for <netmod@ietfa.amsl.com>; Fri, 9 Jun 2017 20:42:46 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -4.801
X-Spam-Level:
X-Spam-Status: No, score=-4.801 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_NONE=-0.0001, RCVD_IN_MSPIKE_H2=-2.8, SPF_HELO_PASS=-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=juniper.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 wHKp4BobQwKh for <netmod@ietfa.amsl.com>; Fri, 9 Jun 2017 20:42:43 -0700 (PDT)
Received: from NAM02-SN1-obe.outbound.protection.outlook.com (mail-sn1nam02on0100.outbound.protection.outlook.com [104.47.36.100]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-SHA384 (256/256 bits)) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id BCA3912708C for <netmod@ietf.org>; Fri, 9 Jun 2017 20:42:43 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=juniper.net; s=selector1; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version; bh=ampB1DFyGeA9jnTRhFGvk5eLyg2TuWvDKdXd725PVJw=; b=HoCDjOito4FD80COVFgaRIOh+faks8cZiKWbZxstfEIvmWMW+vB9KPWxK67KuebMeruWDPEOsfbUk+7DNUaObpgcO8hCb2xHymqtIpUtdHiq3MwSYWlMHvjst40lBCbDj9oN5bzHkSufATJuCF1zuqilHwjK5//MH6Be5IPM+Fw=
Received: from BN3PR0501MB1442.namprd05.prod.outlook.com (10.160.117.151) by BN3PR0501MB1217.namprd05.prod.outlook.com (10.160.113.25) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256_P256) id 15.1.1157.9; Sat, 10 Jun 2017 03:42:42 +0000
Received: from BN3PR0501MB1442.namprd05.prod.outlook.com ([10.160.117.151]) by BN3PR0501MB1442.namprd05.prod.outlook.com ([10.160.117.151]) with mapi id 15.01.1157.014; Sat, 10 Jun 2017 03:42:42 +0000
From: Kent Watsen <kwatsen@juniper.net>
To: Andy Bierman <andy@yumaworks.com>
CC: Benoit Claise <bclaise@cisco.com>, NETMOD Working Group <netmod@ietf.org>
Thread-Topic: [netmod] Important: Guidelines for YANG module authors
Thread-Index: AQHS4Sg9yo6TKjTdckiOsaZCZtmCo6IcwyIAgACxx04=
Date: Sat, 10 Jun 2017 03:42:41 +0000
Message-ID: <4F84D7BA-4FBE-4C39-9633-D19976C6E388@juniper.net>
References: <767b9462-80ad-2942-f67e-31789239b894@cisco.com>, <CABCOCHTQBxf7Ep8nUL2TXLpfTEEK2Zc-6uq4oOOynfXVCHMnLg@mail.gmail.com>
In-Reply-To: <CABCOCHTQBxf7Ep8nUL2TXLpfTEEK2Zc-6uq4oOOynfXVCHMnLg@mail.gmail.com>
Accept-Language: en-US
Content-Language: en-US
X-MS-Has-Attach:
X-MS-TNEF-Correlator:
authentication-results: yumaworks.com; dkim=none (message not signed) header.d=none;yumaworks.com; dmarc=none action=none header.from=juniper.net;
x-originating-ip: [137.118.194.72]
x-ms-publictraffictype: Email
x-microsoft-exchange-diagnostics: 1; BN3PR0501MB1217; 7:2GgBDNBI4yXG/sCgTtKptR4ETr74YQgEjQoGWbtm/+RhW4N4NaNBeQLpXHi12y2c4XEMKryeW1zeG/JxIwSgmyJfqJjvUSmiqTlIMzEtGC+Ba/EnJxDshgDhhRB1QSu2TB47KgprFDTsAlwqF5ii0tYtl84Qm4MujLchviFAQ2r8Qdqs6sSpgA3TRLYsfg43TnwgFlvLveBqgeREerLHb/nRrxL41qj22Si9mISVhEEMQBlJO7CQjItEpb7V6+I2Z62s5v0ASZT7e8SpDUfmbzUULFBxG3x8V3wX/CNdNLNiOzrsuBJGntRD2Q+EQmgxmotyeaGC3BtHXuFdtjqdpQ==
x-ms-traffictypediagnostic: BN3PR0501MB1217:
x-ms-office365-filtering-correlation-id: 42552632-6b54-4686-09d4-08d4afb2bfb3
x-ms-office365-filtering-ht: Tenant
x-microsoft-antispam: UriScan:; BCL:0; PCL:0; RULEID:(22001)(2017030254075)(48565401081)(201703131423075)(201703031133081)(201702281549075); SRVR:BN3PR0501MB1217;
x-microsoft-antispam-prvs: <BN3PR0501MB1217636256A0BE0F6D972E1AA5CF0@BN3PR0501MB1217.namprd05.prod.outlook.com>
x-exchange-antispam-report-test: UriScan:(120809045254105)(95692535739014);
x-exchange-antispam-report-cfa-test: BCL:0; PCL:0; RULEID:(100000700101)(100105000095)(100000701101)(100105300095)(100000702101)(100105100095)(6040450)(601004)(2401047)(8121501046)(5005006)(93006095)(93001095)(3002001)(100000703101)(100105400095)(10201501046)(6055026)(6041248)(20161123564025)(20161123558100)(20161123555025)(20161123560025)(201703131423075)(201702281528075)(201703061421075)(201703061406153)(20161123562025)(6072148)(100000704101)(100105200095)(100000705101)(100105500095); SRVR:BN3PR0501MB1217; BCL:0; PCL:0; RULEID:(100000800101)(100110000095)(100000801101)(100110300095)(100000802101)(100110100095)(100000803101)(100110400095)(100000804101)(100110200095)(100000805101)(100110500095); SRVR:BN3PR0501MB1217;
x-forefront-prvs: 0334223192
x-forefront-antispam-report: SFV:NSPM; SFS:(10019020)(39450400003)(39850400002)(39410400002)(39400400002)(39860400002)(39840400002)(377454003)(24454002)(478600001)(14454004)(2900100001)(6486002)(606005)(99286003)(77096006)(189998001)(966005)(6506006)(6436002)(82746002)(6916009)(110136004)(122556002)(6306002)(54896002)(6512007)(54906002)(236005)(83716003)(2950100002)(33656002)(6246003)(38730400002)(53936002)(4326008)(8936002)(36756003)(3846002)(2906002)(102836003)(53546009)(76176999)(54356999)(50986999)(25786009)(229853002)(3280700002)(7736002)(7906003)(81166006)(66066001)(3660700001)(86362001)(8676002)(5660300001); DIR:OUT; SFP:1102; SCL:1; SRVR:BN3PR0501MB1217; H:BN3PR0501MB1442.namprd05.prod.outlook.com; FPR:; SPF:None; MLV:sfv; LANG:en;
spamdiagnosticoutput: 1:99
spamdiagnosticmetadata: NSPM
Content-Type: multipart/alternative; boundary="_000_4F84D7BA4FBE4C399633D19976C6E388junipernet_"
MIME-Version: 1.0
X-OriginatorOrg: juniper.net
X-MS-Exchange-CrossTenant-originalarrivaltime: 10 Jun 2017 03:42:42.0053 (UTC)
X-MS-Exchange-CrossTenant-fromentityheader: Hosted
X-MS-Exchange-CrossTenant-id: bea78b3c-4cdb-4130-854a-1d193232e5f4
X-MS-Exchange-Transport-CrossTenantHeadersStamped: BN3PR0501MB1217
Archived-At: <https://mailarchive.ietf.org/arch/msg/netmod/fJLCJVzc2xMg8jT21VUvG6mObYU>
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 03:42:47 -0000

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.

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/>s/>, 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


_______________________________________________
netmod mailing list
netmod@ietf.org<mailto:netmod@ietf.org>
https://www.ietf.org/mailman/listinfo/netmod