IVY B. Wu Internet-Draft Huawei Intended status: Standards Track C. Zhou Expires: 1 November 2024 China Mobile Q. Wu Huawei M. Boucadair Orange 30 April 2024 A YANG Network Data Model of Network Inventory Software Extensions draft-wzwb-ivy-network-inventory-software-01 Abstract The base Network Inventory YANG model defines the physical network elements (NEs) and hardware components of NEs. This document extends the base Network Inventory model for software-enabled NEs (e.g., controllers, virtual network functions (VNFs)) and software components (e.g., platform operating system (OS), software-patch). Status of This Memo This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79. Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet- Drafts is at https://datatracker.ietf.org/drafts/current/. Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress." This Internet-Draft will expire on 1 November 2024. Copyright Notice Copyright (c) 2024 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 Wu, et al. Expires 1 November 2024 [Page 1] Internet-Draft Network Inventory Software April 2024 and restrictions with respect to this document. Code Components extracted from this document must include Revised BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Revised BSD License. Table of Contents 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 2. Requirements Language . . . . . . . . . . . . . . . . . . . . 3 3. Relationship to Other YANG Data Models . . . . . . . . . . . 3 4. Model Overview . . . . . . . . . . . . . . . . . . . . . . . 3 5. Software-enabled Network Elements . . . . . . . . . . . . . . 4 6. Software components . . . . . . . . . . . . . . . . . . . . . 4 7. YANG Data model for Network Inventory Software Extensions . . 4 8. Security Considerations . . . . . . . . . . . . . . . . . . . 7 9. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 8 10. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 8 11. References . . . . . . . . . . . . . . . . . . . . . . . . . 8 11.1. Normative References . . . . . . . . . . . . . . . . . . 8 11.2. Informative References . . . . . . . . . . . . . . . . . 9 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 10 1. Introduction The Network Inventory consists of the network element (NE), hardware components, firmware components, and software components on the a managed network domain. [I-D.ietf-ivy-network-inventory-yang] defines the base Network Inventory YANG model for physical network element (NE) and hardware components of NEs. Examples of hardware components could be rack, shelf, slot, board and physical port. This document extends the base Network Inventory to support software extensions for software-enabled NEs (e.g. controllers, virtual network functions (VNFs)) and software components. Examples of software components could be platform operating system (OS), software-patch, bios, and boot-loader. The YANG data model in Section 7 conforms to the Network Management Datastore Architecture (NMDA) [RFC8342]. Wu, et al. Expires 1 November 2024 [Page 2] Internet-Draft Network Inventory Software April 2024 2. Requirements Language The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [RFC2119][RFC8174] when, and only when, they appear in all capitals, as shown here. 3. Relationship to Other YANG Data Models The base network inventory model supports the software versions of NEs and software versions of hardware components. This document adds more software component identifiers (e.g. platformos, software patch) and more NE types (e.g. virtual NE) to provide enhanced software information on the NE to facilitate software compatibility check. Figure Figure 1 depicts the relationship between the Software Extension model and other models. The Software Extension network inventory model enhances the model defined in the base network inventory model. +-------------------------+ | | | Base Network Inventory | | | +------------+------------+ | +------------------+-------------------+ | | | +------V------+ +------V------ +------V------ | | | | | | | Hardware | | Software | | | | Extensions | | Extensions | | Entitlement | | e.g. Power | | e.g. | | | | supply unit | | SW patch | | | +-------------+ +-------------+ +-------------+ Figure 1: Relationship of SW Extension Model to Other Inventory Models 4. Model Overview The following tree diagram [RFC8340] provides an overview of the data model for "ietf-network-inventory-sw-ext" module. Wu, et al. Expires 1 November 2024 [Page 3] Internet-Draft Network Inventory Software April 2024 module: ietf-network-inventory-sw-ext augment /nwi:network-inventory/nwi:network-elements /nwi:network-element: +--rw virtual-ne-attributes augment /nwi:network-inventory/nwi:network-elements /nwi:network-element/nwi:components/nwi:component: +--rw software-module-specific-info 5. Software-enabled Network Elements In the base Network Inventory YANG model, "ne-type" is a YANG identity that describes the type of the network element and only the "physical-network-element" identity" is defined. This document adds non- hardware identity, such as "ne-virtual". 6. Software components Software components refer to the software installed on the NE, such as software releases and software patches, and platform operating system (OS) of the software. 7. YANG Data model for Network Inventory Software Extensions The "ietf-network-inventory-sw-ext" module uses types defined in xxxx. file="ietf-network-inventory-sw-ext@2024-04-30.yang" module ietf-network-inventory-sw-ext { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:ietf-network-inventory-sw-ext"; prefix nis; import ietf-network-inventory { prefix nwi; reference "RFCAAAA: A YANG Data Model for Network Inventory"; } organization "IETF Network Inventory YANG (ivy) Working Group"; contact "WG Web: WG List: Editor: Bo Wu Wu, et al. Expires 1 November 2024 [Page 4] Internet-Draft Network Inventory Software April 2024 Editor: Cheng Zhou Editor: Qin Wu Editor: Mohamed Boucadair "; description "This YANG module defines a model for network inventory software extensions. Copyright (c) 2024 IETF Trust and the persons identified as authors of the code. All rights reserved. Redistribution and use in source and binary forms, with or without modification, is permitted pursuant to, and subject to the license terms contained in, the Revised BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info). This version of this YANG module is part of RFC XXXX; see the RFC itself for full legal notices. The key words 'MUST', 'MUST NOT', 'REQUIRED', 'SHALL', 'SHALL NOT', 'SHOULD', 'SHOULD NOT', 'RECOMMENDED', 'NOT RECOMMENDED', 'MAY', and 'OPTIONAL' in this document are to be interpreted as described in BCP 14 (RFC 2119) (RFC 8174) when, and only when, they appear in all capitals, as shown here."; revision 2024-04-30 { description "Initial version"; reference "RFC XXXX: A YANG Data Model for Network Inventory Software Extensions."; } identity ne-virtual { base nwi:ne-type; description "A virtual network element (NE). "; } identity software-component { base nwi:non-hardware-component-class; description "Base identity for software components in a managed device."; Wu, et al. Expires 1 November 2024 [Page 5] Internet-Draft Network Inventory Software April 2024 } identity operating-system { base software-component; description "OS software type."; } identity operating-system-patch { base software-component; description "An operating system update - which should be a subcomponent of the `operating-system` running on a component. A patch is defined to be a set of software changes that are atomically installed (and uninstalled) together. "; } identity bios { base software-component; description "Legacy BIOS or UEFI firmware interface responsible for initializing hardware components and first stage boot loader."; } identity boot-loader { base software-component; description "Software layer responsible for loading and booting the device OS or network OS."; } identity software-module { base software-component; description "A base identity for software modules installed and/or running on the device. Modules include user-space programs and kernel modules that provide specific functionality. A component with type SOFTWARE_MODULE should also have a module type that indicates the specific type of software module"; } grouping software-module-specific-info-grouping { //To be enriched in the future. description "Specific attributes applicable to Software Modules only."; } Wu, et al. Expires 1 November 2024 [Page 6] Internet-Draft Network Inventory Software April 2024 /* Main blocks */ augment "/nwi:network-inventory/nwi:network-elements" + "/nwi:network-element" { description "Augment network element (NE) attributes."; container virtual-ne-attributes { when "derived-from-or-self(../nwi:ne-type,'ne-virtual')"; description "Container for the attributes applicable only to virtual Network Elements (NEs)."; //To be enriched in the future. } } augment "/nwi:network-inventory/nwi:network-elements/" + "nwi:network-element/nwi:components/nwi:component" { description "Augment component attributes."; container software-module-specific-info { when "derived-from-or-self(../nwi:class,'software-module')"; description "This container contains some attributes belong to Software Modules only."; uses software-module-specific-info-grouping; } } } 8. Security Considerations The YANG module specified in this document defines a data schema designed to be accessed through network management protocols such as NETCONF [RFC6241] or RESTCONF [RFC8040]. The lowest NETCONF layer is the secure transport layer, and the required secure transport is Secure Shell (SSH) [RFC6242]. The lowest RESTCONF layer is HTTPS, and the required secure transport is TLS [RFC8446]. The Network Configuration Access Control Model (NACM) [RFC8341] provides a means of restricting access to specific NETCONF or RESTCONF users to a preconfigured subset of all available NETCONF or RESTCONF protocol operations and contents. Thus, NACM SHOULD be used to restrict the NSF registration from unauthorized users. Wu, et al. Expires 1 November 2024 [Page 7] Internet-Draft Network Inventory Software April 2024 There are a number of data nodes defined in this YANG module that are writable, creatable, and deletable (i.e., config true, which is the default). These data nodes may be considered sensitive or vulnerable in some network environments. Write operations to these data nodes could have a negative effect on network and security operations. Some of the readable data nodes in this YANG module may be considered sensitive or vulnerable in some network environments. It is thus important to control read access (e.g., via get, get-config, or notification) to these data nodes. These are the subtrees and data nodes and their sensitivity/vulnerability: <<>> 9. IANA Considerations This document registers a URI in the "IETF XML Registry" [RFC3688]. Following the format in [RFC3688], the following registration has been made. URI: urn:ietf:params:xml:ns:yang:ietf-network-inventory-sw-ext Registrant Contact: The IESG. XML: N/A, the requested URI is an XML namespace. This document registers a YANG module in the "YANG Module Names" registry[RFC7950] . name: ietf-network-inventory-sw-ext namespace: urn:ietf:params:xml:ns:yang:ietf-network-inventory-sw-ext prefix: nis maintained by IANA: N reference: RFC xxxx 10. Acknowledgements TBD 11. References 11.1. Normative References [I-D.ietf-ivy-network-inventory-yang] Yu, C., Belotti, S., Bouquier, J., Peruzzini, F., and P. Bedard, "A YANG Data Model for Network Inventory", Work in Progress, Internet-Draft, draft-ietf-ivy-network- inventory-yang-01, 4 March 2024, . Wu, et al. Expires 1 November 2024 [Page 8] Internet-Draft Network Inventory Software April 2024 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997, . [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, DOI 10.17487/RFC3688, January 2004, . [RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., and A. Bierman, Ed., "Network Configuration Protocol (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011, . [RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011, . [RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language", RFC 7950, DOI 10.17487/RFC7950, August 2016, . [RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017, . [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, May 2017, . [RFC8341] Bierman, A. and M. Bjorklund, "Network Configuration Access Control Model", STD 91, RFC 8341, DOI 10.17487/RFC8341, March 2018, . [RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K., and R. Wilton, "Network Management Datastore Architecture (NMDA)", RFC 8342, DOI 10.17487/RFC8342, March 2018, . [RFC8446] Rescorla, E., "The Transport Layer Security (TLS) Protocol Version 1.3", RFC 8446, DOI 10.17487/RFC8446, August 2018, . 11.2. Informative References Wu, et al. Expires 1 November 2024 [Page 9] Internet-Draft Network Inventory Software April 2024 [RFC8340] Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams", BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018, . Authors' Addresses Bo Wu Huawei 101 Software Avenue, Yuhua District Nanjing Jiangsu, 210012 China Email: lana.wubo@huawei.com Cheng Zhou China Mobile Beijing 100053 China Email: zhouchengyjy@chinamobile.com Qin Wu Huawei 101 Software Avenue, Yuhua District Nanjing Jiangsu, 210012 China Email: bill.wu@huawei.com Mohamed Boucadair Orange Rennes 35000 France Email: mohamed.boucadair@orange.com Wu, et al. Expires 1 November 2024 [Page 10]