[OPSAWG]Re: [VELOCE] Discussion (2/3): How should an RFC reference a YANG module in a git repository?

Michael Richardson <mcr+ietf@sandelman.ca> Sat, 11 July 2026 17:26 UTC

Return-Path: <mcr+ietf@sandelman.ca>
X-Original-To: opsawg@mail2.ietf.org
Delivered-To: opsawg@mail2.ietf.org
Received: from localhost (localhost [127.0.0.1]) by mail2.ietf.org (Postfix) with ESMTP id 8EE051152336F for <opsawg@mail2.ietf.org>; Sat, 11 Jul 2026 10:26:28 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=ietf.org; s=ietf1; t=1783790788; bh=rt0ToMNhdsoUYPiXfkxj+oIAzPEp46NqSg0UoAi4CBs=; h=From:To:Subject:In-Reply-To:References:Date; b=rtXg39QeSYUV2uqUeewx3YmB9Fb4j+tvRj34MNur5XwKLai7PCbzyNuW+acH4zTxD uaF03TMnxA451zVwe52Klj4rC9CevZ0zW0XMQr9inng98zMa3yVjHkplvZGqMnhqG6 CVaJAKRuavTVxqVLU+JgG2krEn+02M5dvBkzsmis=
X-Virus-Scanned: amavisd-new at ietf.org
X-Spam-Flag: NO
X-Spam-Score: -2.8
X-Spam-Level:
X-Spam-Status: No, score=-2.8 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, RCVD_IN_DNSWL_LOW=-0.7, SPF_HELO_NONE=0.001, SPF_PASS=-0.001] autolearn=ham autolearn_force=no
Authentication-Results: mail2.ietf.org (amavisd-new); dkim=pass (2048-bit key) header.d=sandelman.ca
Received: from mail2.ietf.org ([166.84.6.31]) by localhost (mail2.ietf.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id YbAibenFmcFG for <opsawg@mail2.ietf.org>; Sat, 11 Jul 2026 10:26:27 -0700 (PDT)
Received: from tuna.sandelman.ca (tuna.sandelman.ca [IPv6:2607:f0b0:f:3:216:3eff:fe7c:d1f3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature ECDSA (P-256) server-digest SHA256) (No client certificate requested) by mail2.ietf.org (Postfix) with ESMTPS id 8F7BA11523360 for <opsawg@ietf.org>; Sat, 11 Jul 2026 10:26:26 -0700 (PDT)
Received: from localhost (localhost [127.0.0.1]) by tuna.sandelman.ca (Postfix) with ESMTP id CBC561800D for <opsawg@ietf.org>; Sat, 11 Jul 2026 13:26:19 -0400 (EDT)
Received: from tuna.sandelman.ca ([127.0.0.1]) by localhost (localhost [127.0.0.1]) (amavis, port 10024) with LMTP id UDIyeeIctfJZ for <opsawg@ietf.org>; Sat, 11 Jul 2026 13:26:17 -0400 (EDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=sandelman.ca; s=mail; t=1783790777; bh=wU/XGpqSu7NxpUL273d2suDXDmnY5JTKizwh9m+Kdh0=; h=From:To:Subject:In-Reply-To:References:Date:From; b=cgVztTIWjDcfqddEDU4bCFDtGN/ozHJFkcIdM1vAw4vDEVhfyQ1iWbX3HrhqLlj0L iLq0yh4Z5X74jho+jgYeFUaKpjPE98zXCNGLO1WnRPJvI2BEKsJElLMPo2Kp7Tkchm 14zIrzkxoIQWyqEr4Od9LrNTDXYVUwQPMo/bgFq44AqTV1HJZj88TK1JQGqOzOCGth QnVoruIWC3mHAxR5rrfdJ1jrJLWqjhvdDhe5cntaP3DT6wMFl5saenYpz99TjPUdr9 4koMsu3QEz7uq+g6MZxlVXPnW9Z4ubHj6jjPv+a9xfvHezjFwHdpQPPa3n/PWZSu5u dO34kU5YJ7YBA==
Received: from sandelman.ca (obiwan.sandelman.ca [IPv6:2607:f0b0:f:2::247]) by tuna.sandelman.ca (Postfix) with ESMTP id A414C1800C for <opsawg@ietf.org>; Sat, 11 Jul 2026 13:26:17 -0400 (EDT)
Received: from obiwan.sandelman.ca (obiwan.sandelman.ca [127.0.0.1]) by sandelman.ca (Postfix) with ESMTP id 9D3FB196 for <opsawg@ietf.org>; Sat, 11 Jul 2026 13:26:17 -0400 (EDT)
From: Michael Richardson <mcr+ietf@sandelman.ca>
To: opsawg <opsawg@ietf.org>
In-Reply-To: <e44d6d99efe94b6aaba3dd70f3d54586@huawei.com>
References: <CDEFB344-3F04-4035-A163-BF428399B5A1@gmail.com> <e44d6d99efe94b6aaba3dd70f3d54586@huawei.com>
X-Mailer: MH-E 8.6+git; nmh 1.8+dev; Emacs 30.1
X-Face: $\n1pF)h^`}$H>Hk{L"x@)JS7<%Az}5RyS@k9X%29-lHB$Ti.V>2bi.~ehC0;<'$9xN5Ub# z!G,p`nR&p7Fz@^UXIn156S8.~^@MJ*mMsD7=QFeq%AL4m<nPbLgmtKK-5dC@#:k
MIME-Version: 1.0
Content-Type: multipart/signed; boundary="=-=-="; micalg="pgp-sha512"; protocol="application/pgp-signature"
Date: Sat, 11 Jul 2026 13:26:17 -0400
Message-ID: <5532.1783790777@obiwan.sandelman.ca>
Message-ID-Hash: 3IU2DQ6U5ZY4KH5M5QFMZSMTLFCQSSEG
X-Message-ID-Hash: 3IU2DQ6U5ZY4KH5M5QFMZSMTLFCQSSEG
X-MailFrom: mcr+ietf@sandelman.ca
X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; header-match-opsawg.ietf.org-0; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header
X-Mailman-Version: 3.3.9rc6
Precedence: list
Subject: [OPSAWG]Re: [VELOCE] Discussion (2/3): How should an RFC reference a YANG module in a git repository?
List-Id: OPSA Working Group Mail List <opsawg.ietf.org>
Archived-At: <https://mailarchive.ietf.org/arch/msg/opsawg/8jk7ocUbs-R6WWSX0tQ5YSaisqA>
List-Archive: <https://mailarchive.ietf.org/arch/browse/opsawg>
List-Help: <mailto:opsawg-request@ietf.org?subject=help>
List-Owner: <mailto:opsawg-owner@ietf.org>
List-Post: <mailto:opsawg@ietf.org>
List-Subscribe: <mailto:opsawg-join@ietf.org>
List-Unsubscribe: <mailto:opsawg-leave@ietf.org>

Italo Busi <Italo.Busi=40huawei.com@dmarc.ietf.org> wrote:
    > I think we can resolve all these issues by always publishing a short
    > RFC-update which just updates the [TAG-URL]

No.

1. While the assymptotic effort of publishing an RFC is O(length), there is a
   very large constant overhead even for a 1 page RFC.  Eliminating/reducing that
   large constant is the goal here.


2. This does not address the question of how the YANG module is referred to
   in the original RFC, such that it can be updated.

Right now, we pass by value (inline), and we need to pass by reference.

    > 1. WHAT DOES THE RFC POINTER LOOK LIKE?

    > At the time of publication, the YANG module is at a specific version in
    > the repository. The RFC needs to capture that version
    > permanently. Issue #20 proposed boilerplate along the lines of:

    > "The YANG module at the time of publication of this RFC is available at
    > [TAG-URL]. For the latest version of the module, see [LATEST-URL]."

    > The format and target of both URLs remain open. Should [TAG-URL] be a
    > git tag URL, an IANA registry entry, or something else? Should
    > [LATEST-URL] point to a specific branch (such as main), to an IANA
    > registry entry, or to something the WG maintains separately?

I proposed that it refer to an IANA Registry, with an IESG Action consideration.
The IESG would then be in full control of updating the contents of the
indirection table.
So, it's not a TAG-URL exactly.

It would give the _YANG module ietf-foobar_ [ref], where [ref] is a normative
reference to the IANA YANG Module registry itself.

https://github.com/mjethanandani/veloce/pull/49/changes

This process is similiar to how we advance PS->STD, when no document changes
are neededed.   v6ops did this for
RFC7755 with https://datatracker.ietf.org/doc/draft-palet-v6ops-siit-dc-st/00/
It's not through the IESG, AFAIK.
Note that it still has to gain WG Consensus, AD review, and maybe even
sectorial review.  But, word smithing and detailed editing is not important.

    > 2. WHICH VERSION SHOULD AN IMPLEMENTOR TARGET?

    > Once a module can be updated post-publication, the RFC simultaneously
    > points to a frozen publication-day version and a living latest
    > version. If an implementor wants to be compliant, which should they
    > implement? The options are:

I guess that this refers to the source of the data (the router control
plane).   Not the NMS or other thing that speaks *CONF and uses YANG.

The implementor should implement the *oldest* version of the module which
covers all of the attributes that their implementation ... implements.
That retains as MUCH compatibility with existing NMS as possible.
Naturally, if router platform FOOBAR's BGP module now implements (picking
something at random) v4-next-hop-v6, and one needs at least YANG MODULE
20260215 to describe that, then that's the minimum version.


--
Michael Richardson <mcr+IETF@sandelman.ca>   . o O ( IPv6 IøT consulting )
           Sandelman Software Works Inc, Ottawa and Worldwide

**       My working hours and your working hours may be different.         **
** Please do not feel obligated to reply outside your normal working hours **