Re: [netmod] Updated Content of Module Versioning - T7 (Filename changes)
Andy Bierman <andy@yumaworks.com> Wed, 15 November 2023 21:45 UTC
Return-Path: <andy@yumaworks.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 0F616C14CF13 for <netmod@ietfa.amsl.com>; Wed, 15 Nov 2023 13:45:01 -0800 (PST)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -7.106
X-Spam-Level:
X-Spam-Status: No, score=-7.106 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, HTML_MESSAGE=0.001, RCVD_IN_DNSWL_HI=-5, RCVD_IN_ZEN_BLOCKED_OPENDNS=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01, URIBL_DBL_BLOCKED_OPENDNS=0.001, URIBL_ZEN_BLOCKED_OPENDNS=0.001] autolearn=ham autolearn_force=no
Authentication-Results: ietfa.amsl.com (amavisd-new); dkim=pass (2048-bit key) header.d=yumaworks.com
Received: from mail.ietf.org ([50.223.129.194]) by localhost (ietfa.amsl.com [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id nOAAX8vLQjVy for <netmod@ietfa.amsl.com>; Wed, 15 Nov 2023 13:44:56 -0800 (PST)
Received: from mail-lf1-x132.google.com (mail-lf1-x132.google.com [IPv6:2a00:1450:4864:20::132]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by ietfa.amsl.com (Postfix) with ESMTPS id 68884C151086 for <netmod@ietf.org>; Wed, 15 Nov 2023 13:44:56 -0800 (PST)
Received: by mail-lf1-x132.google.com with SMTP id 2adb3069b0e04-5099184f8a3so150595e87.2 for <netmod@ietf.org>; Wed, 15 Nov 2023 13:44:56 -0800 (PST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=yumaworks.com; s=google; t=1700084694; x=1700689494; darn=ietf.org; h=cc:to:subject:message-id:date:from:in-reply-to:references :mime-version:from:to:cc:subject:date:message-id:reply-to; bh=ewDHi6EdIAwSZzaluFQyh8qV91PMSt71mLS3TszFjX0=; b=OzzMfOztkWDOcOlp30541MTtNLKTPBTJo/9bcktOkYuwShezg1qdqqYGQkaquCtlM+ jPol1Kie5yUbO+EV3AD0kqX48UkHdN2MM3qGtB65DXVlkgbNV6zF+yD8khAHO6K5ptLI PHk9v38cJcWqo/mw/VQB9rTM5PqfbPxglWjVmYNP7RLLecMD4igOmV91V2KHcRqQbI+2 g20YFQspi1FNXf9ebFgEJdr0lvmCErv5A8TCLBIguAx6X2NUmA/Weai1NXjyQlazNsqq SizE5BR5v2l1KdxJ8WJbbjeR8PkwyFOZT/fMjsJ0PVi1OZkY2+zU+Em42OrV0kG6Wxpi wGDw==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1700084694; x=1700689494; h=cc:to:subject:message-id:date:from:in-reply-to:references :mime-version:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=ewDHi6EdIAwSZzaluFQyh8qV91PMSt71mLS3TszFjX0=; b=vr9pJMHhRMA62ilFPSJM3OSj5O5EH4FP3p5sJHMCJ2ndvCJHdLDdx49JDA9dvbjAJ0 G0uopQo25ahNPArbZeH6FthzO2GtDYQM8oscKt8M1lM9vzHxfjBvWFJsEKSM6NajqSNQ 0MyVG3IglGc2/FthHjl6xpetIP2YUd4J7g1Suu061cPNcZ7gJPeSoqP0gQ7IBsAY5v6S pGQnRuUJaJyYHqpcvCawd920aGTtSJpC41EtDiFkwmF46egFOj8vbjkFQreb1XkYmgPG qlA+ev1ZPJBmYaYNGjbWJ8WlcWeEOvHkN2xrWknGpniZHBjUmlMJG/emucVNJWhwtz2c tEVA==
X-Gm-Message-State: AOJu0YzYBa80PR+AAZBrgOwFGs8a76vBgkU0tM7gJwnzojzu18afu3j8 HsfNjeS1r5N8igqgHw2oxmFN0YmN7NhlEeXVTy9Sdw==
X-Google-Smtp-Source: AGHT+IE5TV0LaxNk84QLaxOzwVDydyPYKeArwrjbTHo6vGbwuBHykIIhHA8YS77+ahBWWGv1oD0z2V4xCmqCv2GtgSE=
X-Received: by 2002:ac2:5ec1:0:b0:509:8fbf:7af0 with SMTP id d1-20020ac25ec1000000b005098fbf7af0mr9205003lfq.69.1700084693632; Wed, 15 Nov 2023 13:44:53 -0800 (PST)
MIME-Version: 1.0
References: <DM6PR08MB508483A98537B82190016B0B9BDFA@DM6PR08MB5084.namprd08.prod.outlook.com> <DM6PR08MB5084A3E1CF323F0E63DA13D29BDEA@DM6PR08MB5084.namprd08.prod.outlook.com> <ZTlfFkUU0jO1Osql@alice.eecs.jacobs-university.de> <DM6PR08MB50845E8BD25455F0494C6F3E9BDEA@DM6PR08MB5084.namprd08.prod.outlook.com> <ZTljMu10HSBu_03x@alice.eecs.jacobs-university.de> <CABCOCHQgkBECc8-ur-3cN2n4Fa5dNx0WouMAx=p5Y8gu_ng5Bg@mail.gmail.com> <DM6PR08MB50848D090A95A6060221F5669BB1A@DM6PR08MB5084.namprd08.prod.outlook.com>
In-Reply-To: <DM6PR08MB50848D090A95A6060221F5669BB1A@DM6PR08MB5084.namprd08.prod.outlook.com>
From: Andy Bierman <andy@yumaworks.com>
Date: Wed, 15 Nov 2023 13:44:42 -0800
Message-ID: <CABCOCHSY+sxt-cZcnoPNywK_RZGCgVoVgo4sLL90TTiKT8PtaQ@mail.gmail.com>
To: "Jason Sterne (Nokia)" <jason.sterne@nokia.com>
Cc: Jürgen Schönwälder <jschoenwaelder@constructor.university>, "netmod@ietf.org" <netmod@ietf.org>
Content-Type: multipart/alternative; boundary="000000000000409e01060a37d0ef"
Archived-At: <https://mailarchive.ietf.org/arch/msg/netmod/-x5fwQf9SEPAF6Ji5NYerk0-imA>
Subject: Re: [netmod] Updated Content of Module Versioning - T7 (Filename changes)
X-BeenThere: netmod@ietf.org
X-Mailman-Version: 2.1.39
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: Wed, 15 Nov 2023 21:45:01 -0000
On Wed, Nov 15, 2023 at 1:35 PM Jason Sterne (Nokia) <jason.sterne@nokia.com> wrote: > Hi all, > > > > We discussed this in the weekly YANG versioning call. There have been > concerns expressed on the list about weakening the format specified as a > SHOULD in RFC7950 and about the time it may take for the ecosystem of tools > to be updated. There is not any clear consensus that we should keep the new > label-based filename recommendation. > > > > So we’re proposing to remove this new filename convention from the Module > Versioning draft. That means there would be no particular standardized way > of putting a label (yang semver label) in the module filename. We’d stick > with the RFC7950 my-module@2023-10-14.yang format for now (or of course > the format without any label or date: my-module.yang). > > > thank you. The recent simplifications in this work make it better (IMO). Look forward to implementing the RFC. > If anyone feels that you can’t live without the new filename format > specified (e.g. my-module@3.0.1.yang) now is the time to speak up. > Otherwise we’ll remove it from the next iteration of Module Versioning. > > > > Jason > > Andy > > > *From:* Andy Bierman <andy@yumaworks.com> > *Sent:* Wednesday, October 25, 2023 4:28 PM > *To:* Jürgen Schönwälder <jschoenwaelder@constructor.university>; Jason > Sterne (Nokia) <jason.sterne@nokia.com>; netmod@ietf.org > *Subject:* Re: [netmod] Updated Content of Module Versioning - T7 > (Filename changes) > > > > > > *CAUTION:* This is an external email. Please be very careful when > clicking links or opening attachments. See the URL nok.it/ext for > additional information. > > > > > > > > On Wed, Oct 25, 2023 at 11:49 AM Jürgen Schönwälder < > jschoenwaelder@constructor.university> wrote: > > I strongly disagree. You can add additional file names, you can't > soften the existing SHOULD to a conditional SHOULD. > > > > +1 > > > > Getting tools to handle the file naming patterns defined in RFC 7950 took > a long time. > > It would be disruptive to introduce yet another file-naming pattern. > > It would also be another NBC change forced on YANG 1.1 tools. > > > > > > /js > > > > Andy > > > > On Wed, Oct 25, 2023 at 06:45:31PM +0000, Jason Sterne (Nokia) wrote: > > Sure - I'd be OK with adding some wording here that makes it clear the > 7950 recommendation remains. > > > > i.e. you SHOULD use my-module@2023-01-06 as per 7950, but if you elect > to not use that format, and want to use a label in the filename, then this > format is RECOMMENDED: my-module#3.0.2.yang. > > > > I can see that 'primary identifier' isn't great. Maybe something more > like "to uniquely identify the version of the module" or similar. > > > > Jason > > > > > -----Original Message----- > > > From: Jürgen Schönwälder <jschoenwaelder@constructor.university> > > > Sent: Wednesday, October 25, 2023 2:32 PM > > > To: Jason Sterne (Nokia) <jason.sterne@nokia.com> > > > Cc: netmod@ietf.org > > > Subject: Re: [netmod] Updated Content of Module Versioning - T7 > > > (Filename changes) > > > > > > > > > CAUTION: This is an external email. Please be very careful when > clicking > > > links or opening attachments. See the URL nok.it/ext for additional > > > information. > > > > > > > > > > > > It needs to be clear that the existing text in section 5.2 remains > > > untouched. > > > > > > YANG modules and submodules are typically stored in files, one > > > "module" or "submodule" statement per file. The name of the file > > > SHOULD be of the form: > > > > > > module-or-submodule-name ['@' revision-date] ( '.yang' / '.yin' ) > > > > > > "module-or-submodule-name" is the name of the module or submodule, > > > and the optional "revision-date" is the latest revision of the > module > > > or submodule, as defined by the "revision" statement (Section > 7.1.9). > > > > > > Words like 'primary identifier' confuse me. > > > > > > /js > > > > > > On Wed, Oct 25, 2023 at 06:22:57PM +0000, Jason Sterne (Nokia) wrote: > > > > Hi all, > > > > > > > > Starting a dedicated thread for T7 Filename changes. > > > > > > > > These are my own personal opinions (not those of the > > > authors/contributors). > > > > > > > > RFC7950 says that the filename format SHOULD be my-module@2023-01- > > > 06.yang<mailto:my-module@2023-01-06.yang> > > > > > > > > Module versioning currently says the following format is RECOMMENDED > > > (if the file has a revision label): my-module#3.1.2.yang > > > > > > > > I'd recommend we remove that from Module Versioning, but add it to > the > > > YANG Semver draft (where all revision label text will be located - it > is all > > > being removed from Module Versioning). > > > > > > > > We could potentially say it more like this: > > > > > > > > If a revision has an associated yang-semver-label, and if the > publisher > > > > wishes to use the label in the filename as the primary identifier > for the > > > > version of the module instead of the revision date, then it is > > > > RECOMMENDED to put the yang-semver-label into the filename as > > > follows: > > > > > > > > module-or-submodule-name ['#' yang-semver-label] ( '.yang' / > '.yin' ) > > > > > > > > E.g., acme-router-module#2.0.3.yang > > > > > > > > YANG module (or submodule) files may be identified using either the > > > > revision-date (as per [RFC8407] section 3.2) or the revision label. > > > > > > > > If we don't at least have a recommendation (*if* people really want > to put > > > the label in the filename), then we might have different organizations > using > > > different formats: > > > > > > > > * org #1: my-module@2.0.3.yang<mailto:my-module@2.0.3.yang> > > > > * org#2: my-module#2.0.3@2023-01-06.yang<mailto:my- > > > module#2.0.3@2023-01-06.yang> > > > > * org#3: my-module%2.0.3.yang > > > > * org#4: my-module(2.0.3).yang > > > > > > > > I'm trying to find wording that doesn't strongly mandate the my- > > > module#2.0.3.yang filename format, but does highly recommend it *if* > > > someone is going to put a label in the filename somewhere. > > > > > > > > Jason > > > > > > > > > > > > From: netmod <netmod-bounces@ietf.org> On Behalf Of Jason Sterne > > > (Nokia) > > > > Sent: Tuesday, October 24, 2023 9:58 AM > > > > To: netmod@ietf.org > > > > Subject: [netmod] Updated Content of Module Versioning > > > > > > > > Hello NETMOD WG, > > > > > > > > The YANG versioning authors and weekly call group members have been > > > discussing the next steps for the versioning drafts. > > > > > > > > We'd propose that the first step is to converge on what aspects of > the > > > current Module Versioning draft should be retained, and which parts > should > > > be removed. We can then work towards a final call on an updated version > > > with this revised scope. > > > > > > > > Below is a summary of the main topics in the Module Versioning draft. > > > We've divided the items T1-T10 into 2 groups: > > > > A) Baseline content of Module Versioning > > > > B) Items which need more WG discussion > > > > > > > > In addition to whatever discussions happen on this email list, we > have also > > > created a hedgedoc where you can register your preference for items T7- > > > T10. It would be much appreciated if you can put your opinion in the > > > hedgedoc here: > > > > https://notes.ietf.org/CdKrT5kVSF6qbnRSY4KeSA?both > > > > > > > > > > > > GROUP A (Baseline content of Module Vesioning) > > > > ----------------------------------------------------------------- > > > > Based on resolution of WG LC comments and subsequent discussions, and > > > some feedback to reduce complexity and content in the Module Versioning > > > draft, here is a summary of items that will and won't be part of the > next > > > update of the Module Versioning draft (also referred to as "this draft" > > > below). > > > > > > > > T1. The "ver:non-backwards-compatible" annotation (Sec 3.2): > > > > Retained. This top level (module level) extension (which can be > ignored by > > > tools that don't understand it) is critical to include so that module > readers > > > and tools can know when NBC changes have occurred. > > > > > > > > T2. Updated rules of what is NBC: (Sect 3.1.1, 3.1.2) > > > > Retained. These are updates/clarifications (i.e., changes) to the > RFC 7950 > > > rules that are appropriate and helpful: > > > > (i) "status obsolete" > > > > - This draft changes RFC 7950 so that marking a data node as > obsolete is > > > an NBC change because it can break clients. > > > > (ii) "extensions" > > > > - This draft changes the RFC 7950 rules to allow extensions to > define the > > > backwards compatibility considerations for the extension itself. The > existing > > > RFC 7950 rules only allow extensions to be added, not changed or > removed. > > > > (iii) "import by revision-date" > > > > - This draft changes the RFC 7950 rules to allow the revision date > of an > > > import-statement to be changed/added/removed. The imported module > > > must be versioned separately (i.e., by a YANG package/library defining > the > > > schema). > > > > (iv) "whitespace": > > > > - This draft clarifies the existing RFC 7950 behaviour that > changing > > > insignificant whitespace is classified as a backwards compatible change > > > > > > > > T3. revision-label-scheme extension (Sec 3.4.2) > > > > Removed. Based on WG LC discussions we will go back to a single > > > versioning scheme for YANG modules, and hence the revision-label-scheme > > > extension will be removed from this draft. > > > > > > > > T4. revision-label extension (Sec 3.4) > > > > Removed. Related to T3 above, given that a single versioning scheme > is > > > sufficient, the revision-label extension will be moved to the YANG > Semver > > > draft, and removed from Module Versioning. > > > > > > > > T5. Resolving ambiguous imports in YANG library (Sec 5.1) > > > > Removed. This will be removed from Module Versioning (could be > > > considered in YANG Next, although that is many years away). Note, RFC > > > 7950, section 5.6.5, paragraph 5 does consistently define how to build > the > > > schema. The change in the draft was to always prioritise an > implemented > > > module over the most recent implemented *or* import-only revision. But > > > this will be removed. > > > > > > > > T6. Advertisement for how deprecated & obsolete nodes are handled > (Sec > > > 5.2.2) > > > > Retained. This information is important for clients to be able to > accurately > > > construct the schema and hence it is retained in Module Versioning. > > > > > > > > GROUP B (Needs WG discussion) > > > > ------------------------------------------- > > > > For these items we don't have consensus within the WG - they need > more > > > discussion and input. > > > > > > > > It is recommended to go back and look at the NETMOD emails on these > > > topics (from the WG LC discussions). > > > > > > > > Please add your name beside your preferred option in the poll: > > > https://notes.ietf.org/CdKrT5kVSF6qbnRSY4KeSA?both > > > > > > > > T7. filename changes (Sec 3.4.1) > > > > The authors/contributors are leaning towards suggesting that this > moved > > > change be moved to YANG Next consideration. However, there isn't > > > complete consensus, with concerns that the vendors will each define > their > > > own incompatible file naming schemes for YANG modules that use version > > > numbers. If we retain this work then this would likely move to the > YANG > > > Semver draft. > > > > [See hedgedoc poll T7] > > > > > > > > T8. recommended-min for imports (Sec 4) > > > > The WG seems to be somewhat split on how urgent this is, and there > isn't > > > consensus amongst authors/contributors for retaining this work or > > > deferring it. One option is to keep it, but renamed as recommended-min- > > > date. > > > > [See hedgedoc poll T8] > > > > > > > > T9. Versioning of YANG instance data (Sec 6) > > > > There wasn't any consensus among the authors/contributors as to > > > whether this should be retained or deferred to a new version of the > YANG > > > instance data document. > > > > [See hedgedoc poll T9] > > > > > > > > T10. Do *all* whitespace changes (including whitespace between > > > statements) require a new revision to be published? Sec 3.1, last > paragraph. > > > > The authors/contributors are somewhat split on whether to retain > this. > > > The advantage of keeping this is that it makes it very easy to check > (i.e., via a > > > simple text diff tool) whether two modules pertaining to be the same > > > version are in fact the same. It should also mean that it is easy to > generate > > > a hash-based fingerprint of a module revision. The alternative gives > more > > > flexibility to users to reformat modules (e.g., for different > line-lengths), but > > > complicates the check to ensure that a YANG module revision hasn't been > > > changed or makes it slightly more expensive to generate a hash since > the > > > module formatting would need to be normalized first. > > > > [See hedgedoc poll T10] > > > > > > > > Jason (he/him) > > > > > > > > > > > _______________________________________________ > > > > netmod mailing list > > > > netmod@ietf.org > > > > https://www.ietf.org/mailman/listinfo/netmod > > > > > > > > > -- > > > Jürgen Schönwälder Constructor University Bremen gGmbH > > > Phone: +49 421 200 3587 Campus Ring 1 | 28759 Bremen | Germany > > > Fax: +49 421 200 3103 <https://constructor.university/> > > -- > Jürgen Schönwälder Constructor University Bremen gGmbH > Phone: +49 421 200 3587 Campus Ring 1 | 28759 Bremen | Germany > Fax: +49 421 200 3103 <https://constructor.university/> > > _______________________________________________ > netmod mailing list > netmod@ietf.org > https://www.ietf.org/mailman/listinfo/netmod > >
- [netmod] Updated Content of Module Versioning Jason Sterne (Nokia)
- [netmod] Updated Content of Module Versioning - T… Jason Sterne (Nokia)
- Re: [netmod] Updated Content of Module Versioning… Jürgen Schönwälder
- Re: [netmod] Updated Content of Module Versioning… Jason Sterne (Nokia)
- Re: [netmod] Updated Content of Module Versioning… Jürgen Schönwälder
- Re: [netmod] Updated Content of Module Versioning… Jason Sterne (Nokia)
- Re: [netmod] Updated Content of Module Versioning… Joe Clarke (jclarke)
- Re: [netmod] Updated Content of Module Versioning… Andy Bierman
- Re: [netmod] Updated Content of Module Versioning… Jürgen Schönwälder
- Re: [netmod] Updated Content of Module Versioning… Andy Bierman
- Re: [netmod] Updated Content of Module Versioning… Jürgen Schönwälder
- Re: [netmod] Updated Content of Module Versioning… Jason Sterne (Nokia)
- Re: [netmod] Updated Content of Module Versioning… Andy Bierman
- [netmod] Updated Content of Module Versioning - T… Jason Sterne (Nokia)
- Re: [netmod] Updated Content of Module Versioning… Jürgen Schönwälder
- Re: [netmod] Updated Content of Module Versioning… Jason Sterne (Nokia)
- Re: [netmod] Updated Content of Module Versioning… Jürgen Schönwälder
- Re: [netmod] Updated Content of Module Versioning… Andy Bierman