Re: [netmod] "iana" in yang modules' name/namespace/prefix

Juergen Schoenwaelder <j.schoenwaelder@jacobs-university.de> Fri, 20 July 2018 14:40 UTC

Return-Path: <j.schoenwaelder@jacobs-university.de>
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 76B1F130EB4 for <netmod@ietfa.amsl.com>; Fri, 20 Jul 2018 07:40:10 -0700 (PDT)
X-Virus-Scanned: amavisd-new at amsl.com
X-Spam-Flag: NO
X-Spam-Score: -1.899
X-Spam-Level:
X-Spam-Status: No, score=-1.899 tagged_above=-999 required=5 tests=[BAYES_00=-1.9, URIBL_BLOCKED=0.001] autolearn=ham autolearn_force=no
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 g8UEs9SlcgNZ for <netmod@ietfa.amsl.com>; Fri, 20 Jul 2018 07:40:08 -0700 (PDT)
Received: from anna.localdomain (firewallix.jacobs-university.de [212.201.44.247]) by ietfa.amsl.com (Postfix) with ESMTP id BA03A130E0F for <netmod@ietf.org>; Fri, 20 Jul 2018 07:40:07 -0700 (PDT)
Received: by anna.localdomain (Postfix, from userid 501) id E813C2360ADC; Fri, 20 Jul 2018 16:40:06 +0200 (CEST)
Date: Fri, 20 Jul 2018 16:40:06 +0200
From: Juergen Schoenwaelder <j.schoenwaelder@jacobs-university.de>
To: Martin Vigoureux <martin.vigoureux@nokia.com>
Cc: netmod@ietf.org
Message-ID: <20180720144006.ybautxifiwwh2xth@anna.jacobs.jacobs-university.de>
Reply-To: Juergen Schoenwaelder <j.schoenwaelder@jacobs-university.de>
Mail-Followup-To: Martin Vigoureux <martin.vigoureux@nokia.com>, netmod@ietf.org
References: <98a58631-0c57-7ed8-5277-5dcb3ee9dd86@nokia.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <98a58631-0c57-7ed8-5277-5dcb3ee9dd86@nokia.com>
User-Agent: NeoMutt/20180622
Archived-At: <https://mailarchive.ietf.org/arch/msg/netmod/xWIog8LWqg0BiODoC9t_P3XgpSg>
Subject: Re: [netmod] "iana" in yang modules' name/namespace/prefix
X-BeenThere: netmod@ietf.org
X-Mailman-Version: 2.1.27
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, 20 Jul 2018 14:40:11 -0000

On Fri, Jul 20, 2018 at 03:45:47PM +0200, Martin Vigoureux wrote:
 
> As part of a recent IESG review (of draft-bfd-yang) a point came up on the
> use of "iana" in yang modules' name/namespace/prefix.
> This is typically used in the case where the module refers to an IANA
> maintained registry. However, the point raised was that the name of the
> registry operator might not always be IANA, and that using that name might
> not put modules on the most stable deployment footing under all possible
> circumstances.
> 
> On top of that, as far as I can tell, the use of "iana" is an undocumented
> convention.
> 
> So, I wanted to collect views:
> on whether a convention should be documented,
> and, with regards to the point raised in IESG, on whether that keyword
> should be changed going forward. In that context, what about "reg" (for
> registry) or "regop" (for registry operator)? Other proposals are welcome.

iana- has the advantage that everybody knows which registry is meant.
Using registry- is perhaps more flexible in case IANA registry gets
renamed but it leaves is much more open where the module is
maintained. The first part of a module name is supposed to identify an
organization. draft-ietf-netmod-rfc6087bis-20.txt (RFC editor queue)
says:

   It is suggested that a stable prefix be selected representing the
   entire organization.  All normative YANG modules published by the
   IETF MUST begin with the prefix "ietf-".  Another standards
   organization, such as the IEEE, might use the prefix "ieee-" for all
   YANG modules.

Concerning documentation, perhaps we could change the above to this:

   It is suggested that a stable prefix be selected representing the
   entire organization.  All normative YANG modules published by the
   IETF MUST begin with the prefix "ietf-".  Another standards
   organization, such as the IEEE, might use the prefix "ieee-" for all
   YANG modules. YANG modules maintained by IANA for the IETF SHOULD
   begin with the prefix "iana-".

/js

-- 
Juergen Schoenwaelder           Jacobs University Bremen gGmbH
Phone: +49 421 200 3587         Campus Ring 1 | 28759 Bremen | Germany
Fax:   +49 421 200 3103         <https://www.jacobs-university.de/>