idnits 2.17.00 (12 Aug 2021) /tmp/idnits7865/draft-zheng-netmod-xmi-yang-translation-00.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- ** There is 1 instance of too long lines in the document, the longest one being 1 character in excess of 72. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year == The document doesn't use any RFC 2119 keywords, yet seems to have RFC 2119 boilerplate text. == Couldn't figure out when the document was first submitted -- there may comments or warnings related to the use of a disclaimer for pre-RFC5378 work that could not be issued because of this. Please check the Legal Provisions document at https://trustee.ietf.org/license-info to determine if you need the pre-RFC5378 disclaimer. -- The document date (October 27, 2014) is 2763 days in the past. Is this intentional? Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) == Unused Reference: 'RFC6991' is defined on line 179, but no explicit reference was found in the text == Unused Reference: 'RFC6536' is defined on line 186, but no explicit reference was found in the text -- Possible downref: Non-RFC (?) normative reference: ref. 'XMI' -- Obsolete informational reference (is this intentional?): RFC 6536 (Obsoleted by RFC 8341) Summary: 1 error (**), 0 flaws (~~), 5 warnings (==), 3 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 1 Network Working Group G. Zheng 2 Internet Draft Huawei Technologies 3 Intended status: Standard Track October 27, 2014 4 Expires: April 30, 2015 6 Translation of XML Metadata Interchange (XMI) UML Model to YANG 7 Modules 8 draft-zheng-netmod-xmi-yang-translation-00.txt 10 Abstract 12 This document defines a mechanism of translating XMI UML objects into 13 YANG modules. With the translation mechanism, the data objects 14 defined in XMI UML objects could be accessed via NETCONF. 16 Status of this Memo 18 This Internet-Draft is submitted in full conformance with the 19 provisions of BCP 78 and BCP 79. 21 Internet-Drafts are working documents of the Internet Engineering 22 Task Force (IETF). Note that other groups may also distribute working 23 documents as Internet-Drafts. The list of current Internet-Drafts is 24 at http://datatracker.ietf.org/drafts/current/. 26 Internet-Drafts are draft documents valid for a maximum of six months 27 and may be updated, replaced, or obsoleted by other documents at any 28 time. It is inappropriate to use Internet-Drafts as reference 29 material or to cite them other than as "work in progress." 31 This Internet-Draft will expire on April 30, 2015. 33 Copyright Notice 35 Copyright (c) 2011 IETF Trust and the persons identified as the 36 document authors. All rights reserved. 38 This document is subject to BCP 78 and the IETF Trust's Legal 39 Provisions Relating to IETF Documents 40 (http://trustee.ietf.org/license-info) in effect on the date of 41 publication of this document. Please review these documents 42 carefully, as they describe your rights and restrictions with respect 43 to this document. Code Components extracted from this document must 44 include Simplified BSD License text as described in Section 4.e of 45 the Trust Legal Provisions and are provided without warranty as 46 described in the Simplified BSD License. 48 Table of Contents 50 1. Introduction ................................................. 3 51 2. Requirements Language and Terminology ........................ 3 52 3. Requirements for translating XMI to YANG ..................... 4 53 4. Mapping of Well-Known Types .................................. 4 54 5. Translation of XMI Model classes ............................. 4 55 6. Translation of XMI Attributes ................................ 4 56 6.1. Element Identification Attributes ....................... 4 57 6.2. Linking Attributes ...................................... 4 58 6.3. Type Attribute .......................................... 4 59 7. Translation of Model Representation .......................... 4 60 8. Security Considerations ...................................... 5 61 9. IANA Considerations .......................................... 5 62 10. References .................................................. 5 63 10.1. Normative References ................................... 5 64 10.2. Informative References ................................. 5 65 11. Acknowledgments ............................................. 5 66 Authors' Addresses .............................................. 6 68 1. Introduction 70 This document describes a mechanism of translating XMI (XML Metadata 71 Interchange) [XMI] specified Model into YANG [RFC6020] modules. With 72 the translation mechanism, the data objects defined in XMI UML 73 objects could be accessed via NETCONF [RFC6241]. 75 MOF is the foundation technology for describing metamodels. It covers 76 a wide range of domains, and is based on a constrained subset of UML. 77 XMI is widely used XML interchange format of UML. It defines the 78 following aspects involved in describing objects in: 80 - The representation of objects in terms of XML elements and 81 attributes. 82 - The standard mechanisms to link objects within the same file or 83 across files. 84 - The validation of XMI documents using XML Schemas. 85 - Object identity, which allows objects to be referenced from 86 other objects in terms of IDs and UUIDs. 88 The YANG modules that generated from XMI model should not be modified. 89 Any necessary changes should be made by modifying the original XMI 90 model (with proper updates of the XMI LAST-UPDATED and REVISION 91 clauses) and then running the translation defined in this memo again. 92 Note that this does not affect the usage of YANG augments and or YANG 93 deviations: YANG modules generated from XMI model can be augmented 94 like any other YANG module, and YANG deviations can be used to 95 document how an implementation deviates from the generated YANG 96 module. 98 2. Requirements Language and Terminology 100 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 101 "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and 102 "OPTIONAL" in this document are to be interpreted as described in 103 [RFC2119] when they appear in ALL CAPS. When these words are not in 104 ALL CAPS (such as "should" or "Should"), they have their usual 105 English meanings, and are not to be interpreted as [RFC2119] key 106 words. 108 Terminology: 110 3. Requirements for translating XMI to YANG 112 As YANG is gradually becoming mature, more and more working groups 113 are planning or have chosen YANG as the information model description 114 language. These working groups or their service areas have existed 115 for many years. Each working group already has their information 116 model, and they used to use their traditional information model 117 designing tools and hope to continue using the tools for a long time 118 (e.g. using SMIv2 to construct MIB; using UML tools to build the UML 119 objects). They only provide the YANG models when publishing the 120 models. 122 As we all know, there has been a standard [RFC6643] of SMI to YANG 123 conversion. But there is no standard to guide how to convert UML 124 objects to YANG models. This memo specifying the conversion rules of 125 translating XMI formatted UML models to YANG models. 127 4. Mapping of Well-Known Types 129 The SMIv2 base types and some well-known derived textual conventions 130 are mapped to YANG types by this section's rules. 132 5. Translation of XMI Model classes 134 This section will describe how classes are translated. (TBD) 136 6. Translation of XMI Attributes 138 This section will describe how XMI Attributes are translated. 140 6.1. Element Identification Attributes 142 TBD. 144 6.2. Linking Attributes 146 TBD. 148 6.3. Type Attribute 150 TBD. 152 7. Translation of Model Representation 154 This section will describe how Model Representation are translated. 156 8. Security Considerations 158 TBD. 160 9. IANA Considerations 162 This document requires no IANA registration. 164 10. References 166 10.1. Normative References 168 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 169 Requirement Levels", BCP 14, RFC 2119, March 1997. 171 [RFC6020] Bjorklund, M., "YANG - A Data Modeling Language for the 172 Network Configuration Protocol (NETCONF)", RFC 6020, 173 October 2010. 175 [RFC6241] Enns, R., Bjorklund, M., Schoenwaelder, J., and A. Bierman, 176 "Network Configuration Protocol (NETCONF)", RFC 6241, June 177 2011. 179 [RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types", RFC 6991, 180 July 2013. 182 [XMI] http://www.omg.org/spec/XMI/2.4.2 184 10.2. Informative References 186 [RFC6536] Bierman, A. and M. Bjorklund, "Network Configuration 187 Protocol (NETCONF) Access Control Model", RFC 6536, March 188 2012. 190 [RFC6643] J. Schoenwaelder, "Translation of Structure of Management 191 Information Version 2 (SMIv2) MIB Modules to YANG Modules", 192 RFC 6643, February 2013. 194 11. Acknowledgments 196 This document was prepared using 2-Word-v2.0.template.dot. 198 Authors' Addresses 200 Guangying Zheng 201 N9-3-B01 Building 202 Huawei Technologies Co., Ltd 203 No.101 Yuhuatai Rd., Nanjing 204 P.R. China 206 Email: zhengguangying@huawei.com