YANG Module Tags
RFC 8819

Document Type RFC - Proposed Standard (January 2021; No errata)
Updates RFC 8407
Authors Christian Hopps  , Lou Berger  , Dean Bogdanović 
Last updated 2021-01-04
Replaces draft-rtgyangdt-netmod-module-tags
Stream IETF
Formats plain text html xml pdf htmlized bibtex
Yang Validation 0 errors, 0 warnings.
Reviews
Additional Resources
- Yang catalog entry for ietf-module-tags-state@2020-02-29.yang
- Yang catalog entry for ietf-module-tags@2020-02-29.yang
- Yang impact analysis for draft-ietf-netmod-module-tags
- Mailing list discussion
Stream WG state Held by WG
Document shepherd Joel Jaeggli
Shepherd write-up Show (last changed 2019-02-17)
IESG IESG state RFC 8819 (Proposed Standard)
Consensus Boilerplate Yes
Telechat date
Responsible AD Alissa Cooper
Send notices to Joel Jaeggli <joelja@gmail.com>
IANA IANA review state Version Changed - Review Needed
IANA action state RFC-Ed-Ack


Internet Engineering Task Force (IETF)                          C. Hopps
Request for Comments: 8819                                     L. Berger
Updates: 8407                                    LabN Consulting, L.L.C.
Category: Standards Track                                  D. Bogdanovic
ISSN: 2070-1721                                           Volta Networks
                                                            January 2021

                            YANG Module Tags

Abstract

   This document provides for the association of tags with YANG modules.
   The expectation is for such tags to be used to help classify and
   organize modules.  A method for defining, reading, and writing
   modules tags is provided.  Tags may be registered and assigned during
   module definition, assigned by implementations, or dynamically
   defined and set by users.  This document also provides guidance to
   future model writers; as such, this document updates RFC 8407.

Status of This Memo

   This is an Internet Standards Track document.

   This document is a product of the Internet Engineering Task Force
   (IETF).  It represents the consensus of the IETF community.  It has
   received public review and has been approved for publication by the
   Internet Engineering Steering Group (IESG).  Further information on
   Internet Standards is available in Section 2 of RFC 7841.

   Information about the current status of this document, any errata,
   and how to provide feedback on it may be obtained at
   https://www.rfc-editor.org/info/rfc8819.

Copyright Notice

   Copyright (c) 2021 IETF Trust and the persons identified as the
   document authors.  All rights reserved.

   This document is subject to BCP 78 and the IETF Trust's Legal
   Provisions Relating to IETF Documents
   (https://trustee.ietf.org/license-info) in effect on the date of
   publication of this document.  Please review these documents
   carefully, as they describe your rights and restrictions with respect
   to this document.  Code Components extracted from this document must
   include Simplified BSD License text as described in Section 4.e of
   the Trust Legal Provisions and are provided without warranty as
   described in the Simplified BSD License.

Table of Contents

   1.  Introduction
     1.1.  Some Possible Use Cases for YANG Module Tags
     1.2.  Conventions Used in This Document
   2.  Tag Values
     2.1.  IETF Tags
     2.2.  Vendor Tags
     2.3.  User Tags
     2.4.  Reserved Tags
   3.  Tag Management
     3.1.  Module Definition Tagging
     3.2.  Implementation Tagging
     3.3.  User Tagging
   4.  Tags Module Structure
     4.1.  Tags Module Tree
     4.2.  YANG Module
   5.  Other Classifications
   6.  Guidelines to Model Writers
     6.1.  Define Standard Tags
   7.  IANA Considerations
     7.1.  YANG Module Tag Prefixes Registry
     7.2.  IETF YANG Module Tags Registry
     7.3.  Updates to the IETF XML Registry
     7.4.  Updates to the YANG Module Names Registry
   8.  Security Considerations
   9.  References
     9.1.  Normative References
     9.2.  Informative References
   Appendix A.  Examples
   Appendix B.  Non-NMDA State Module
   Acknowledgements
   Authors' Addresses

1.  Introduction

   The use of tags for classification and organization is fairly
   ubiquitous not only within IETF protocols but in the internet itself
   (e.g., "#hashtags").  One benefit of using tags for organization over
   a rigid structure is that it is more flexible and can more easily
   adapt over time as technologies evolve.  Tags can be usefully
   registered, but they can also serve as a non-registered mechanism
   available for users to define themselves.  This document provides a
   mechanism to define tags and associate them with YANG modules in a
   flexible manner.  In particular, tags may be registered as well as
   assigned during module definition, assigned by implementations, or
   dynamically defined and set by users.

   This document defines a YANG module [RFC7950] that provides a list of
   module entries to allow for adding or removing tags as well as
   viewing the set of tags associated with a module.

   This document defines an extension statement to indicate tags that
   SHOULD be added by the module implementation automatically (i.e.,
   outside of configuration).

   This document also defines an IANA registry for tag prefixes as well
   as a set of globally assigned tags.

   Section 6 provides guidelines for authors of YANG data models.

   This document updates [RFC8407].

   The YANG data model in this document conforms to the Network
   Management Datastore Architecture (NMDA) defined in [RFC8342].

1.1.  Some Possible Use Cases for YANG Module Tags

   During this document's development, there were requests for example
   uses of module tags.  The following are a few example use cases for
   tags.  This list is certainly not exhaustive.

   One example use of tags would be to help filter different discrete
Show full document text