| < draft-ietf-netmod-module-tags-07.txt | draft-ietf-netmod-module-tags-08.txt > | |||
|---|---|---|---|---|
| Network Working Group C. Hopps | Network Working Group C. Hopps | |||
| Internet-Draft LabN Consulting, L.L.C. | Internet-Draft LabN Consulting, L.L.C. | |||
| Updates: 8407 (if approved) L. Berger | Updates: 8407 (if approved) L. Berger | |||
| Intended status: Standards Track LabN Consulting, LLC. | Intended status: Standards Track LabN Consulting, LLC. | |||
| Expires: September 10, 2019 D. Bogdanovic | Expires: November 4, 2019 D. Bogdanovic | |||
| Volta Networks | Volta Networks | |||
| March 9, 2019 | May 3, 2019 | |||
| YANG Module Tags | YANG Module Tags | |||
| draft-ietf-netmod-module-tags-07 | draft-ietf-netmod-module-tags-08 | |||
| Abstract | Abstract | |||
| This document provides for the association of tags with YANG modules. | This document provides for the association of tags with YANG modules. | |||
| The expectation is for such tags to be used to help classify and | The expectation is for such tags to be used to help classify and | |||
| organize modules. A method for defining, reading and writing a | organize modules. A method for defining, reading and writing a | |||
| modules tags is provided. Tags may be standardized and assigned | modules tags is provided. Tags may be registered and assigned during | |||
| during module definition; assigned by implementations; or dynamically | module definition; assigned by implementations; or dynamically | |||
| defined and set by users. This document also provides guidance to | defined and set by users. This document also provides guidance to | |||
| future model writers; as such, this document updates RFC8407. | future model writers; as such, this document updates RFC8407. | |||
| Status of This Memo | Status of This Memo | |||
| This Internet-Draft is submitted in full conformance with the | This Internet-Draft is submitted in full conformance with the | |||
| provisions of BCP 78 and BCP 79. | provisions of BCP 78 and BCP 79. | |||
| Internet-Drafts are working documents of the Internet Engineering | Internet-Drafts are working documents of the Internet Engineering | |||
| Task Force (IETF). Note that other groups may also distribute | Task Force (IETF). Note that other groups may also distribute | |||
| working documents as Internet-Drafts. The list of current Internet- | working documents as Internet-Drafts. The list of current Internet- | |||
| Drafts is at https://datatracker.ietf.org/drafts/current/. | Drafts is at https://datatracker.ietf.org/drafts/current/. | |||
| Internet-Drafts are draft documents valid for a maximum of six months | Internet-Drafts are draft documents valid for a maximum of six months | |||
| and may be updated, replaced, or obsoleted by other documents at any | and may be updated, replaced, or obsoleted by other documents at any | |||
| time. It is inappropriate to use Internet-Drafts as reference | time. It is inappropriate to use Internet-Drafts as reference | |||
| material or to cite them other than as "work in progress." | material or to cite them other than as "work in progress." | |||
| This Internet-Draft will expire on September 10, 2019. | This Internet-Draft will expire on November 4, 2019. | |||
| Copyright Notice | Copyright Notice | |||
| Copyright (c) 2019 IETF Trust and the persons identified as the | Copyright (c) 2019 IETF Trust and the persons identified as the | |||
| document authors. All rights reserved. | document authors. All rights reserved. | |||
| This document is subject to BCP 78 and the IETF Trust's Legal | This document is subject to BCP 78 and the IETF Trust's Legal | |||
| Provisions Relating to IETF Documents | Provisions Relating to IETF Documents | |||
| (https://trustee.ietf.org/license-info) in effect on the date of | (https://trustee.ietf.org/license-info) in effect on the date of | |||
| publication of this document. Please review these documents | publication of this document. Please review these documents | |||
| skipping to change at page 2, line 16 ¶ | skipping to change at page 2, line 16 ¶ | |||
| include Simplified BSD License text as described in Section 4.e of | include Simplified BSD License text as described in Section 4.e of | |||
| the Trust Legal Provisions and are provided without warranty as | the Trust Legal Provisions and are provided without warranty as | |||
| described in the Simplified BSD License. | described in the Simplified BSD License. | |||
| Table of Contents | Table of Contents | |||
| 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 | 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 | |||
| 1.1. Some possible use cases for YANG module tags . . . . . . 3 | 1.1. Some possible use cases for YANG module tags . . . . . . 3 | |||
| 1.2. Conventions Used in This Document . . . . . . . . . . . . 4 | 1.2. Conventions Used in This Document . . . . . . . . . . . . 4 | |||
| 2. Tag Values . . . . . . . . . . . . . . . . . . . . . . . . . 4 | 2. Tag Values . . . . . . . . . . . . . . . . . . . . . . . . . 4 | |||
| 2.1. IETF Standard Tags . . . . . . . . . . . . . . . . . . . 4 | 2.1. IETF Tags . . . . . . . . . . . . . . . . . . . . . . . . 4 | |||
| 2.2. Vendor Tags . . . . . . . . . . . . . . . . . . . . . . . 4 | 2.2. Vendor Tags . . . . . . . . . . . . . . . . . . . . . . . 4 | |||
| 2.3. User Tags . . . . . . . . . . . . . . . . . . . . . . . . 5 | 2.3. User Tags . . . . . . . . . . . . . . . . . . . . . . . . 5 | |||
| 2.4. Reserved Tags . . . . . . . . . . . . . . . . . . . . . . 5 | 2.4. Reserved Tags . . . . . . . . . . . . . . . . . . . . . . 5 | |||
| 3. Tag Management . . . . . . . . . . . . . . . . . . . . . . . 5 | 3. Tag Management . . . . . . . . . . . . . . . . . . . . . . . 5 | |||
| 3.1. Module Definition Tagging . . . . . . . . . . . . . . . . 5 | 3.1. Module Definition Tagging . . . . . . . . . . . . . . . . 5 | |||
| 3.2. Implementation Tagging . . . . . . . . . . . . . . . . . 5 | 3.2. Implementation Tagging . . . . . . . . . . . . . . . . . 5 | |||
| 3.3. User Tagging . . . . . . . . . . . . . . . . . . . . . . 5 | 3.3. User Tagging . . . . . . . . . . . . . . . . . . . . . . 5 | |||
| 4. Tags Module Structure . . . . . . . . . . . . . . . . . . . . 6 | 4. Tags Module Structure . . . . . . . . . . . . . . . . . . . . 6 | |||
| 4.1. Tags Module Tree . . . . . . . . . . . . . . . . . . . . 6 | 4.1. Tags Module Tree . . . . . . . . . . . . . . . . . . . . 6 | |||
| 4.2. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 6 | 4.2. YANG Module . . . . . . . . . . . . . . . . . . . . . . . 6 | |||
| 5. Other Classifications . . . . . . . . . . . . . . . . . . . . 9 | 5. Other Classifications . . . . . . . . . . . . . . . . . . . . 9 | |||
| 6. Guidelines to Model Writers . . . . . . . . . . . . . . . . . 9 | 6. Guidelines to Model Writers . . . . . . . . . . . . . . . . . 9 | |||
| 6.1. Define Standard Tags . . . . . . . . . . . . . . . . . . 9 | 6.1. Define Standard Tags . . . . . . . . . . . . . . . . . . 9 | |||
| 7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 9 | 7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 9 | |||
| 7.1. YANG Module Tag Prefixes Registry . . . . . . . . . . . . 9 | 7.1. YANG Module Tag Prefixes Registry . . . . . . . . . . . . 9 | |||
| 7.2. YANG Module Tags Registry . . . . . . . . . . . . . . . . 10 | 7.2. IETF YANG Module Tags Registry . . . . . . . . . . . . . 10 | |||
| 7.3. Updates to the IETF XML Registry . . . . . . . . . . . . 12 | 7.3. Updates to the IETF XML Registry . . . . . . . . . . . . 12 | |||
| 7.4. Updates to the YANG Module Names Registry . . . . . . . . 12 | 7.4. Updates to the YANG Module Names Registry . . . . . . . . 12 | |||
| 8. Security Considerations . . . . . . . . . . . . . . . . . . . 12 | 8. Security Considerations . . . . . . . . . . . . . . . . . . . 12 | |||
| 9. References . . . . . . . . . . . . . . . . . . . . . . . . . 13 | 9. References . . . . . . . . . . . . . . . . . . . . . . . . . 13 | |||
| 9.1. Normative References . . . . . . . . . . . . . . . . . . 13 | 9.1. Normative References . . . . . . . . . . . . . . . . . . 13 | |||
| 9.2. Informative References . . . . . . . . . . . . . . . . . 13 | 9.2. Informative References . . . . . . . . . . . . . . . . . 13 | |||
| Appendix A. Examples . . . . . . . . . . . . . . . . . . . . . . 14 | Appendix A. Examples . . . . . . . . . . . . . . . . . . . . . . 14 | |||
| Appendix B. Acknowledgements . . . . . . . . . . . . . . . . . . 15 | Appendix B. Acknowledgements . . . . . . . . . . . . . . . . . . 15 | |||
| Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 15 | Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 15 | |||
| 1. Introduction | 1. Introduction | |||
| The use of tags for classification and organization is fairly | The use of tags for classification and organization is fairly | |||
| ubiquitous not only within IETF protocols, but in the internet itself | ubiquitous not only within IETF protocols, but in the internet itself | |||
| (e.g., "#hashtags"). One benefit of using tags for organization over | (e.g., "#hashtags"). One benefit of using tags for organization over | |||
| a rigid structure is that it is more flexible and can more easily | a rigid structure is that it is more flexible and can more easily | |||
| adapt over time as technologies evolve. Tags can be usefully | adapt over time as technologies evolve. Tags can be usefully | |||
| standardized, but they can also serve as a non-standardized mechanism | registered, but they can also serve as a non-registered mechanism | |||
| available for users to define themselves. This document provides a | available for users to define themselves. This document provides a | |||
| mechanism to define tags and associate them with YANG modules in a | mechanism to define tags and associate them with YANG modules in a | |||
| flexible manner. In particular, tags may be standardized as well as | flexible manner. In particular, tags may be registered as well as | |||
| assigned during module definition; assigned by implementations; or | assigned during module definition; assigned by implementations; or | |||
| dynamically defined and set by users. | dynamically defined and set by users. | |||
| This document defines a YANG module [RFC7950] which provides a list | This document defines a YANG module [RFC7950] which provides a list | |||
| of module entries to allow for adding or removing of tags as well as | of module entries to allow for adding or removing of tags as well as | |||
| viewing the set of tags associated with a module. | viewing the set of tags associated with a module. | |||
| This document defines an extension statement to be used to indicate | This document defines an extension statement to be used to indicate | |||
| tags that SHOULD be added by the module implementation automatically | tags that SHOULD be added by the module implementation automatically | |||
| (i.e., outside of configuration). | (i.e., outside of configuration). | |||
| skipping to change at page 4, line 22 ¶ | skipping to change at page 4, line 22 ¶ | |||
| The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", | The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", | |||
| "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and | "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and | |||
| "OPTIONAL" in this document are to be interpreted as described in | "OPTIONAL" in this document are to be interpreted as described in | |||
| [RFC2119] [RFC8174] when, and only when, they appear in all capitals, | [RFC2119] [RFC8174] when, and only when, they appear in all capitals, | |||
| as shown here. | as shown here. | |||
| 2. Tag Values | 2. Tag Values | |||
| All tags SHOULD begin with a prefix indicating who owns their | All tags SHOULD begin with a prefix indicating who owns their | |||
| definition. An IANA registry (Section 7.1) is used to support | definition. An IANA registry (Section 7.1) is used to support | |||
| standardizing tag prefixes. Currently 3 prefixes are defined. No | registering tag prefixes. Currently 3 prefixes are defined. No | |||
| further structure is imposed by this document on the value following | further structure is imposed by this document on the value following | |||
| the standard prefix, and the value can contain any YANG type 'string' | the registered prefix, and the value can contain any YANG type | |||
| characters except carriage-returns, newlines and tabs. | 'string' characters except carriage-returns, newlines and tabs. | |||
| Again, except for the conflict-avoiding prefix, this document is not | Again, except for the conflict-avoiding prefix, this document is not | |||
| specifying any structure on (i.e., restricting) the tag values on | specifying any structure on (i.e., restricting) the tag values on | |||
| purpose. The intent is to avoid arbitrarily restricting the values | purpose. The intent is to avoid arbitrarily restricting the values | |||
| that designers, implementers and users can use. As a result of this | that designers, implementers and users can use. As a result of this | |||
| choice, designers, implementers, and users are free to add or not add | choice, designers, implementers, and users are free to add or not add | |||
| any structure they may require to their own tag values. | any structure they may require to their own tag values. | |||
| 2.1. IETF Standard Tags | 2.1. IETF Tags | |||
| An IETF standard tag is a tag that has the prefix "ietf:". All IETF | An IETF tag is a tag that has the prefix "ietf:". All IETF tags are | |||
| standard tags are registered with IANA in a registry defined later in | registered with IANA in a registry defined later in this document | |||
| this document (Section 7.2). | (Section 7.2). | |||
| 2.2. Vendor Tags | 2.2. Vendor Tags | |||
| A vendor tag is a tag that has the prefix "vendor:". These tags are | A vendor tag is a tag that has the prefix "vendor:". These tags are | |||
| defined by the vendor that implements the module, and are not | defined by the vendor that implements the module, and are not | |||
| standardized; however, it is RECOMMENDED that the vendor include | registered; however, it is RECOMMENDED that the vendor include extra | |||
| extra identification in the tag to avoid collisions such as using the | identification in the tag to avoid collisions such as using the | |||
| enterpise or organization name following the "vendor:" prefix (e.g., | enterpise or organization name following the "vendor:" prefix (e.g., | |||
| vendor:example.com:vendor-defined-classifier). | vendor:example.com:vendor-defined-classifier). | |||
| 2.3. User Tags | 2.3. User Tags | |||
| A user tag is any tag that has the prefix "user:". These tags are | A user tag is any tag that has the prefix "user:". These tags are | |||
| defined by the user/administrator and will never be standardized. | defined by the user/administrator and are not meant to be registered. | |||
| Users are not required to use the "user:" prefix; however, doing so | Users are not required to use the "user:" prefix; however, doing so | |||
| is RECOMMENDED as it helps avoid collisions. | is RECOMMENDED as it helps avoid collisions. | |||
| 2.4. Reserved Tags | 2.4. Reserved Tags | |||
| Any tag not starting with the prefix "ietf:", "vendor:" or "user:" is | Any tag not starting with the prefix "ietf:", "vendor:" or "user:" is | |||
| reserved for future standardization. These tag values are not | reserved for future use. These tag values are not invalid, but | |||
| invalid, but simply reserved in the context of standardization. | simply reserved in the context of specifications (e.g., RFCs). | |||
| 3. Tag Management | 3. Tag Management | |||
| Tags can become associated with a module in a number of ways. Tags | Tags can become associated with a module in a number of ways. Tags | |||
| may be defined and associated at module design time, at | may be defined and associated at module design time, at | |||
| implementation time, or via user administrative control. As the main | implementation time, or via user administrative control. As the main | |||
| consumer of tags are users, users may also remove any tag, no matter | consumer of tags are users, users may also remove any tag, no matter | |||
| how the tag became associated with a module. | how the tag became associated with a module. | |||
| 3.1. Module Definition Tagging | 3.1. Module Definition Tagging | |||
| A module definition MAY indicate a set of tags to be added by the | A module definition MAY indicate a set of tags to be added by the | |||
| module implementer. These design time tags are indicated using the | module implementer. These design time tags are indicated using the | |||
| module-tag extension statement. | module-tag extension statement. | |||
| If the module is defined in an IETF standards track document, the | If the module is defined in an IETF standards track document, the | |||
| tags MUST be IETF Standard Tags (2.1). Thus, new modules can drive | tags MUST be IETF Tags (2.1). Thus, new modules can drive the | |||
| the addition of new standard tags to the IANA registry defined in | addition of new IETF tags to the IANA registry defined in | |||
| Section 7.2, and the IANA registry can serve as a check against | Section 7.2, and the IANA registry can serve as a check against | |||
| duplication. | duplication. | |||
| 3.2. Implementation Tagging | 3.2. Implementation Tagging | |||
| An implementation MAY include additional tags associated with a | An implementation MAY include additional tags associated with a | |||
| module. These tags SHOULD be IETF Standard or vendor specific tags. | module. These tags SHOULD be IETF Tags (i.e., registered) or vendor | |||
| specific tags. | ||||
| 3.3. User Tagging | 3.3. User Tagging | |||
| Tags of any kind, with or without a prefix, can be assigned and | Tags of any kind, with or without a prefix, can be assigned and | |||
| removed by the user using normal configuration mechanisms. In order | removed by the user using normal configuration mechanisms. In order | |||
| to remove a tag from the operational datastore the user adds a | to remove a tag from the operational datastore the user adds a | |||
| matching "masked-tag" entry for a given module. | matching "masked-tag" entry for a given module. | |||
| 4. Tags Module Structure | 4. Tags Module Structure | |||
| skipping to change at page 6, line 21 ¶ | skipping to change at page 6, line 21 ¶ | |||
| module: ietf-module-tags | module: ietf-module-tags | |||
| +--rw module-tags | +--rw module-tags | |||
| +--rw module* [name] | +--rw module* [name] | |||
| +--rw name yang:yang-identifier | +--rw name yang:yang-identifier | |||
| +--rw tag* tag | +--rw tag* tag | |||
| +--rw masked-tag* tag | +--rw masked-tag* tag | |||
| 4.2. YANG Module | 4.2. YANG Module | |||
| <CODE BEGINS> file "ietf-module-tags@2019-03-09.yang" | <CODE BEGINS> file "ietf-module-tags@2019-05-03.yang" | |||
| module ietf-module-tags { | module ietf-module-tags { | |||
| yang-version 1.1; | yang-version 1.1; | |||
| namespace "urn:ietf:params:xml:ns:yang:ietf-module-tags"; | namespace "urn:ietf:params:xml:ns:yang:ietf-module-tags"; | |||
| prefix tags; | prefix tags; | |||
| import ietf-yang-types { | import ietf-yang-types { | |||
| prefix yang; | prefix yang; | |||
| } | } | |||
| organization | organization | |||
| skipping to change at page 7, line 28 ¶ | skipping to change at page 7, line 28 ¶ | |||
| described in BCP 14 [RFC2119] [RFC8174] when, and only when, | described in BCP 14 [RFC2119] [RFC8174] when, and only when, | |||
| they appear in all capitals, as shown here. | they appear in all capitals, as shown here. | |||
| This version of this YANG module is part of RFC XXXX | This version of this YANG module is part of RFC XXXX | |||
| (https://tools.ietf.org/html/rfcXXXX); see the RFC itself for | (https://tools.ietf.org/html/rfcXXXX); see the RFC itself for | |||
| full legal notices."; | full legal notices."; | |||
| // RFC Ed.: update the date below with the date of RFC publication | // RFC Ed.: update the date below with the date of RFC publication | |||
| // and RFC number and remove this note. | // and RFC number and remove this note. | |||
| revision 2019-03-09 { | revision 2019-05-03 { | |||
| description | description | |||
| "Initial revision."; | "Initial revision."; | |||
| reference "RFC XXXX: YANG Module Tags"; | reference "RFC XXXX: YANG Module Tags"; | |||
| } | } | |||
| typedef tag { | typedef tag { | |||
| type string { | type string { | |||
| length "1..max"; | length "1..max"; | |||
| pattern '[\S ]+'; | pattern '[\S ]+'; | |||
| } | } | |||
| description | description | |||
| "A tag is a type 'string' value that does not include carriage | "A tag is a type 'string' value that does not include carriage | |||
| return, newline or tab characters. It SHOULD begin with a | return, newline or tab characters. It SHOULD begin with a | |||
| standard prefix; however, tags without a standard prefix | registered prefix; however, tags without a registered prefix | |||
| SHOULD NOT be treated as invalid."; | SHOULD NOT be treated as invalid."; | |||
| } | } | |||
| extension module-tag { | extension module-tag { | |||
| argument tag; | argument tag; | |||
| description | description | |||
| "The argument 'tag' is of type 'tag'. This extension statement | "The argument 'tag' is of type 'tag'. This extension statement | |||
| is used by module authors to indicate the tags that SHOULD be | is used by module authors to indicate the tags that SHOULD be | |||
| added automatically by the system. As such the origin of the | added automatically by the system. As such the origin of the | |||
| value for the pre-defined tags should be set to 'system' | value for the pre-defined tags should be set to 'system' | |||
| skipping to change at page 8, line 26 ¶ | skipping to change at page 8, line 26 ¶ | |||
| type yang:yang-identifier; | type yang:yang-identifier; | |||
| mandatory true; | mandatory true; | |||
| description | description | |||
| "The YANG module name."; | "The YANG module name."; | |||
| } | } | |||
| leaf-list tag { | leaf-list tag { | |||
| type tag; | type tag; | |||
| description | description | |||
| "Tags associated with the module. See the IANA 'YANG Module | "Tags associated with the module. See the IANA 'YANG Module | |||
| Tag Prefixes' registry for reserved prefixes and the IANA | Tag Prefixes' registry for reserved prefixes and the IANA | |||
| 'YANG Module Tags' registry for IETF standard tags. | 'IETF YANG Module Tags' registry for IETF tags. | |||
| The 'operational' state [RFC8342] view of this list is | The 'operational' state [RFC8342] view of this list is | |||
| constructed using the following steps: | constructed using the following steps: | |||
| 1) System tags (i.e., tags of 'system' origin) are added. | 1) System tags (i.e., tags of 'system' origin) are added. | |||
| 2) User configured tags (i.e., tags of 'intended' origin) | 2) User configured tags (i.e., tags of 'intended' origin) | |||
| are added. | are added. | |||
| 3) Any tag that is equal to a masked-tag is removed."; | 3) Any tag that is equal to a masked-tag is removed."; | |||
| } | } | |||
| leaf-list masked-tag { | leaf-list masked-tag { | |||
| skipping to change at page 9, line 5 ¶ | skipping to change at page 8, line 51 ¶ | |||
| operational state datastore [RFC8342] by adding them to | operational state datastore [RFC8342] by adding them to | |||
| this list. It is not an error to add tags to this list | this list. It is not an error to add tags to this list | |||
| that are not associated with the module, but they have no | that are not associated with the module, but they have no | |||
| operational effect."; | operational effect."; | |||
| } | } | |||
| } | } | |||
| } | } | |||
| } | } | |||
| <CODE ENDS> | <CODE ENDS> | |||
| Figure 1: Module Tags Module | ||||
| 5. Other Classifications | 5. Other Classifications | |||
| It is worth noting that a different YANG module classification | It is worth noting that a different YANG module classification | |||
| document exists [RFC8199]. That document only classifies modules in | document exists [RFC8199]. That document only classifies modules in | |||
| a logical manner and does not define tagging or any other mechanisms. | a logical manner and does not define tagging or any other mechanisms. | |||
| It divides YANG modules into two categories (service or element) and | It divides YANG modules into two categories (service or element) and | |||
| then into one of three origins: standard, vendor or user. It does | then into one of three origins: standard, vendor or user. It does | |||
| provide a good way to discuss and identify modules in general. This | provide a good way to discuss and identify modules in general. This | |||
| document defines standard tags to support [RFC8199] style | document defines IETF tags to support [RFC8199] style classification. | |||
| classification. | ||||
| 6. Guidelines to Model Writers | 6. Guidelines to Model Writers | |||
| This section updates [RFC8407]. | This section updates [RFC8407]. | |||
| 6.1. Define Standard Tags | 6.1. Define Standard Tags | |||
| A module MAY indicate, using module-tag extension statements, a set | A module MAY indicate, using module-tag extension statements, a set | |||
| of tags that are to be automatically associated with it (i.e., not | of tags that are to be automatically associated with it (i.e., not | |||
| added through configuration). | added through configuration). | |||
| skipping to change at page 9, line 36 ¶ | skipping to change at page 9, line 35 ¶ | |||
| module example-module { | module example-module { | |||
| //... | //... | |||
| import module-tags { prefix tags; } | import module-tags { prefix tags; } | |||
| tags:module-tag "ietf:some-new-tag"; | tags:module-tag "ietf:some-new-tag"; | |||
| tags:module-tag "ietf:some-other-tag"; | tags:module-tag "ietf:some-other-tag"; | |||
| // ... | // ... | |||
| } | } | |||
| The module writer can use existing standard tags, or use new tags | The module writer can use existing standard tags, or use new tags | |||
| defined in the model definition, as appropriate. For standardized | defined in the model definition, as appropriate. For IETF | |||
| modules new tags MUST be assigned in the IANA registry defined below, | standardized modules new tags MUST be assigned in the IANA registry | |||
| see Section 7.2. | defined below, see Section 7.2. | |||
| 7. IANA Considerations | 7. IANA Considerations | |||
| 7.1. YANG Module Tag Prefixes Registry | 7.1. YANG Module Tag Prefixes Registry | |||
| IANA is asked to create a new registry "YANG Module Tag Prefixes" | IANA is asked to create a new registry "YANG Module Tag Prefixes" | |||
| grouped under a new "Protocol" category named "YANG Module Tags". | grouped under a new "Protocol" category named "YANG Module Tags". | |||
| This registry allocates tag prefixes. All YANG module tags SHOULD | This registry allocates tag prefixes. All YANG module tags SHOULD | |||
| begin with one of the prefixes in this registry. | begin with one of the prefixes in this registry. | |||
| Prefix entries in this registry should be short strings consisting of | Prefix entries in this registry should be short strings consisting of | |||
| lowercase ASCII alpha-numeric characters and a final ":" character. | lowercase ASCII alpha-numeric characters and a final ":" character. | |||
| The allocation policy for this registry is Specification Required | The allocation policy for this registry is Specification Required | |||
| [RFC8126]. | [RFC8126]. The Reference and Assignee values should be sufficient to | |||
| identify and contact the organization that has been allocated the | ||||
| prefix. | ||||
| The initial values for this registry are as follows. | The initial values for this registry are as follows. | |||
| +---------+---------------------------------------------------------+ | +---------+----------------------------------+-----------+----------+ | |||
| | Prefix | Description | | | Prefix | Description | Reference | Assignee | | |||
| +---------+---------------------------------------------------------+ | +---------+----------------------------------+-----------+----------+ | |||
| | ietf: | IETF Standard Tag allocated in the IANA YANG Module | | | ietf: | IETF Tags allocated in the IANA | [This | IETF | | |||
| | | Tags registry. | | | | IETF YANG Module Tags registry. | document] | | | |||
| | | | | | | | | | | |||
| | vendor: | Non-standardized tags allocated by the module | | | vendor: | Non-registered tags allocated by | [This | IETF | | |||
| | | implementer. | | | | the module implementer. | document] | | | |||
| | | | | | | | | | | |||
| | user: | Non-standardized tags allocated by and for the user. | | | user: | Non-registered tags allocated by | [This | IETF | | |||
| +---------+---------------------------------------------------------+ | | | and for the user. | document] | | | |||
| +---------+----------------------------------+-----------+----------+ | ||||
| Other standards organizations (SDOs) wishing to standardize their own | Other standards organizations (SDOs) wishing to allocate their own | |||
| set of tags should allocate a prefix from this registry. | set of tags should allocate a prefix from this registry. | |||
| 7.2. YANG Module Tags Registry | 7.2. IETF YANG Module Tags Registry | |||
| IANA is asked to create a new registry "YANG Module Tags" grouped | IANA is asked to create a new registry "IETF YANG Module Tags" | |||
| under a new "Protocol" category "YANG Module Tags". This registry | grouped under a new "Protocol" category "IETF YANG Module Tags". | |||
| should be included below "YANG Module Tag Prefixes" when listed on | This registry should be included below "YANG Module Tag Prefixes" | |||
| the same page. | when listed on the same page. | |||
| This registry allocates prefixes that have the standard prefix | This registry allocates tags that have the registered prefix "ietf:". | |||
| "ietf:". New values should be well considered and not achievable | New values should be well considered and not achievable through a | |||
| through a combination of already existing standard tags. | combination of already existing IETF tags. | |||
| The allocation policy for this registry is IETF Review [RFC8126]. | The allocation policy for this registry is IETF Review [RFC8126]. | |||
| The initial values for this registry are as follows. | The initial values for this registry are as follows. | |||
| +----------------------------+--------------------------+-----------+ | +----------------------------+--------------------------+-----------+ | |||
| | Tag | Description | Reference | | | Tag | Description | Reference | | |||
| +----------------------------+--------------------------+-----------+ | +----------------------------+--------------------------+-----------+ | |||
| | ietf:network-element-class | [RFC8199] network | [RFC8199] | | | ietf:network-element-class | [RFC8199] network | [RFC8199] | | |||
| | | element. | | | | | element. | | | |||
| skipping to change at page 14, line 25 ¶ | skipping to change at page 14, line 25 ¶ | |||
| [RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure | [RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure | |||
| Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011, | Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011, | |||
| <https://www.rfc-editor.org/info/rfc6242>. | <https://www.rfc-editor.org/info/rfc6242>. | |||
| [RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams", | [RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams", | |||
| BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018, | BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018, | |||
| <https://www.rfc-editor.org/info/rfc8340>. | <https://www.rfc-editor.org/info/rfc8340>. | |||
| Appendix A. Examples | Appendix A. Examples | |||
| The following is a fictional example result from a query of the | The following is a fictional NETCONF example result from a query of | |||
| module tags list. For the sake of brevity only a few module results | the module tags list. For the sake of brevity only a few module | |||
| are imagined. | results are imagined. | |||
| <ns0:config xmlns:ns0="urn:ietf:params:xml:ns:netconf:base:1.0"> | <ns0:data xmlns:ns0="urn:ietf:params:xml:ns:netconf:base:1.0"> | |||
| <t:module-tags xmlns:t="urn:ietf:params:xml:ns:yang:ietf-module-tags"> | <t:module-tags xmlns:t="urn:ietf:params:xml:ns:yang:ietf-module-tags"> | |||
| <t:module> | <t:module> | |||
| <t:name>ietf-bfd</t:name> | <t:name>ietf-bfd</t:name> | |||
| <t:tag>ietf:network-element-class</t:tag> | <t:tag>ietf:network-element-class</t:tag> | |||
| <t:tag>ietf:oam</t:tag> | <t:tag>ietf:oam</t:tag> | |||
| <t:tag>ietf:protocol</t:tag> | <t:tag>ietf:protocol</t:tag> | |||
| <t:tag>ietf:sdo-defined-class</t:tag> | <t:tag>ietf:sdo-defined-class</t:tag> | |||
| </t:module> | </t:module> | |||
| <t:module> | <t:module> | |||
| <t:name>ietf-isis</t:name> | <t:name>ietf-isis</t:name> | |||
| skipping to change at page 15, line 29 ¶ | skipping to change at page 15, line 29 ¶ | |||
| <t:tag>ietf:routing</t:tag> | <t:tag>ietf:routing</t:tag> | |||
| </t:module> | </t:module> | |||
| <t:module> | <t:module> | |||
| <t:name>ietf-ssh-server</t:name> | <t:name>ietf-ssh-server</t:name> | |||
| <t:tag>ietf:network-element-class</t:tag> | <t:tag>ietf:network-element-class</t:tag> | |||
| <t:tag>ietf:protocol</t:tag> | <t:tag>ietf:protocol</t:tag> | |||
| <t:tag>ietf:sdo-defined-class</t:tag> | <t:tag>ietf:sdo-defined-class</t:tag> | |||
| <t:tag>ietf:system-management</t:tag> | <t:tag>ietf:system-management</t:tag> | |||
| </t:module> | </t:module> | |||
| </t:module-tags> | </t:module-tags> | |||
| </ns0:config> | </ns0:data> | |||
| Appendix B. Acknowledgements | Appendix B. Acknowledgements | |||
| Special thanks to Robert Wilton for his help improving the | Special thanks to Robert Wilton for his help improving the | |||
| introduction and providing the example use cases. | introduction and providing the example use cases. | |||
| Authors' Addresses | Authors' Addresses | |||
| Christian Hopps | Christian Hopps | |||
| LabN Consulting, L.L.C. | LabN Consulting, L.L.C. | |||
| End of changes. 34 change blocks. | ||||
| 60 lines changed or deleted | 65 lines changed or added | |||
This html diff was produced by rfcdiff 1.48. The latest version is available from http://tools.ietf.org/tools/rfcdiff/ | ||||