Skip to main content

YANG Full Embed
draft-jouqui-netmod-yang-full-include-01

Document Type Active Internet-Draft (individual)
Authors Jean Quilbeuf , Benoît Claise , Thomas Joubert
Last updated 2024-03-04
RFC stream (None)
Intended RFC status (None)
Formats
Yang Validation 0 errors, 0 warnings
Additional resources Github repo for Issue Tracking, PRs and latest version
Stream Stream state (No stream defined)
Consensus boilerplate Unknown
RFC Editor Note (None)
IESG IESG state I-D Exists
Telechat date (None)
Responsible AD (None)
Send notices to (None)
draft-jouqui-netmod-yang-full-include-01
NETMOD                                                       J. Quilbeuf
Internet-Draft                                                 B. Claise
Intended status: Standards Track                              T. Joubert
Expires: 5 September 2024                                         Huawei
                                                            4 March 2024

                            YANG Full Embed
                draft-jouqui-netmod-yang-full-include-01

Abstract

   YANG lacks re-usability of models defined outside of the grouping and
   augmentation mechanisms.  For instance, it is almost impossible to
   reuse a model defined for a device in the context of the network, i.e
   by encapsulating it in a list indexed by device IDs.  [RFC8528]
   defines the YANG mount mechanism, partially solving the problem by
   allowing to mount an arbitrary set of schemas at an arbitrary point.
   However, YANG mount is only focusing on deploy or runtime.  This
   document aims to provide the same mechanism at design time.

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 5 September 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
   and restrictions with respect to this document.  Code Components

Quilbeuf, et al.        Expires 5 September 2024                [Page 1]
Internet-Draft               YANG Full Embed                  March 2024

   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.  Terminology . . . . . . . . . . . . . . . . . . . . . . . . .   4
   3.  Full Embed  . . . . . . . . . . . . . . . . . . . . . . . . .   4
     3.1.  Definition  . . . . . . . . . . . . . . . . . . . . . . .   5
     3.2.  Limitations . . . . . . . . . . . . . . . . . . . . . . .   5
     3.3.  Allowed sub-statements  . . . . . . . . . . . . . . . . .   6
   4.  ietf-full-embed YANG module . . . . . . . . . . . . . . . . .   6
   5.  Security Considerations . . . . . . . . . . . . . . . . . . .   8
   6.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .   8
   7.  Contributors  . . . . . . . . . . . . . . . . . . . . . . . .   8
   8.  Open issues . . . . . . . . . . . . . . . . . . . . . . . . .   8
     8.1.  Parent-nodes mechanism from schema mount  . . . . . . . .   8
   9.  References  . . . . . . . . . . . . . . . . . . . . . . . . .   9
     9.1.  Normative References  . . . . . . . . . . . . . . . . . .   9
     9.2.  Informative References  . . . . . . . . . . . . . . . . .  10
   Appendix A.  Changes between revisions  . . . . . . . . . . . . .  11
   Appendix B.  Examples . . . . . . . . . . . . . . . . . . . . . .  11
     B.1.  Example using YANG Full Embed . . . . . . . . . . . . . .  12
     B.2.  Using YANG Schema Mount . . . . . . . . . . . . . . . . .  13
     B.3.  Support Files . . . . . . . . . . . . . . . . . . . . . .  14
   Acknowledgements  . . . . . . . . . . . . . . . . . . . . . . . .  17
   Authors' Addresses  . . . . . . . . . . . . . . . . . . . . . . .  17

1.  Introduction

   [RFC8528] introduces the challenges of reusing existing YANG modules,
   especially when including the full subtree of YANG module under a
   specific node of another module.  In that RFC, three different phases
   of data model life cycle are identified: "design time",
   "implementation time" and "run time".  Only the last two are covered.
   We focus here on the first phase of the life cycle, that is inserting
   modules at design time.

   We identified some use cases that require this design time definition
   of which modules need to be included in the top-level module.  The
   have in common the need to re-use YANG modules defined for the
   devices in the context of a network-level module.  Also, they both
   aim to define a model that is independent of the underlying devices.

   *  The use case that triggered the creation of this document is
      [I-D.ietf-opsawg-collected-data-manifest].  In this draft, the
      goal is to provide a YANG model giving the context in which YANG-

Quilbeuf, et al.        Expires 5 September 2024                [Page 2]
Internet-Draft               YANG Full Embed                  March 2024

      push [RFC8641] data are collected so that they can be exploited a
      posteriori.  To get the full context, we need the hardware and os
      version of each device, but also the list of YANG modules
      supported by the devices and the parameters for the YANG-push
      subscriptions.  For the last two items YANG Library [RFC8525] and
      YANG Push [RFC8641] provide good and standard modules for
      representing this information at the device level.  However, the
      data manifests need to be considered at the network level, so that
      we can distinguish between the devices from which they come.  In
      YANG, that means including them in a list indexed by the device
      id, which proves out to be difficult without copy-pasting the
      original modules.

   *  A similar use case is the digital map
      [I-D.havel-opsawg-digital-map], where the goal is to build a model
      of the network.  In particular, to model the devices a lot of
      standard modules have already been defined by the IETF and there
      is a need to reuse these modules to build this larger network
      model.  The IVY workgroup (https://datatracker.ietf.org/wg/ivy/
      about/) might also rely on the pattern of re-using device level
      modules into a network model.

   YANG Schema Mount [RFC8528] and Peer Mount
   [I-D.clemm-netmod-peermount] focus on mounting a given part of a an
   existing data instance into another data instance.  Although the
   final goal is the same: being able to reuse modules defined elsewhere
   in order to avoid redefining them, the approach is more focused on
   the runtime than the design time.  In the first case, the mapping
   between the mount points and the existing modules to be mounted at
   that mount point is left to the NETCONF [RFC6241] server.  Thus, to
   guarantee that the contents under a given mount point conforms to a
   predefined schema requires the proper configuration of the server.
   In the case of Peer mount, the focus is on synchronizing a given
   subtree of a server (remote or local) with a subtree of the local
   server.  Again, the contents under the local subtree cannot be
   enforced from the design time.

   The notion of reusing an existing schema within a new schema is not
   new.  Several schema definition languages propose this feature, such
   as RELAX NG (https://books.xmlschemata.org/relaxng/relax-CHP-10-SECT-
   1.html), Protobuf (https://protobuf.dev/programming-guides/
   proto3/#other/) or json-schema (https://json-schema.org/
   understanding-json-schema/structuring#dollarref).

   In this document, we propose a new extension, named full embed.  This
   extension enables reusing imported modules by rooting them at an
   arbitrary point of the data model.  The concept of mount point from
   [RFC8528] is replaced by an anydata statement containing list of

Quilbeuf, et al.        Expires 5 September 2024                [Page 3]
Internet-Draft               YANG Full Embed                  March 2024

   "full:embed" statement, each statement corresponding to the inclusion
   of one imported module at that location.  In that sense, the design
   time solution is a pure YANG solution that does not rely on external
   configuration to specify the list of mounted modules, hence the term
   full embed rather than mount.  Also, we use 'embed' not to conflict
   with the native 'include' statement in YANG [RFC7950].

   The obtained data model that we want to associate to our construct is
   similar to the one obtained by specifying a mount point and binding
   it to the same set of modules.  Therefore, we can reuse the concepts
   of the YANG schema mount to define the semantics of our new
   extension.

2.  Terminology

   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.

   The following terms are defined in [RFC7950]:

   *  data model

   *  data node

   The following terms are defined in [RFC8528]:

   *  mount point

3.  Full Embed

   The full embed mechanism defined in this document completes
   [RFC8528], by providing a mechanism to "mount" modules at design
   time.  Supporting mounting modules at this step of the data model
   life cycle is left out of scope in [RFC8528].

   The approach for supporting the full embed mechanism is to keep the
   semantics of [RFC8528] for the resulting data model.  In [RFC8528],
   the list of modules to mount in each mount point is left to the
   NETCONF server.  In this document, we propose the full embed
   mechanism to define this mapping directly in the YANG module that
   embeds the mounted modules.

   To ensure interoperability with clients that do not support the full
   embed extension, the full embed statement can only appear within an
   anydata node.  Clients that do not support the extension will see the

Quilbeuf, et al.        Expires 5 September 2024                [Page 4]
Internet-Draft               YANG Full Embed                  March 2024

   contents of the embedded model as arbitrary data.  Clients that
   support the extension will be able to interpret the contents of the
   anydata node according to the semantics of the embedded YANG modules.

   In the sequel, we use "full" as the prefix for the module 'ietf-yang-
   full-embed' (see Section 4).  Thus "full:embed" refers to the
   extension 'embed' defined in that module.

3.1.  Definition

   The "full:embed" statement can appear as a sub-statement of anydata.

   The "full:embed" statement takes as an argument a prefix, that must
   be the prefix associated to an imported module.  Modules can contain
   multiple uses of the "full:embed" statement.  An "anydata" statement
   MAY contain multiple uses of the "full:embed" statement.  These
   multiple uses define the full list of modules to be embedded, rooted
   in the anydata node where the "full:embed" statement is used.

   The "full:embed" statement can be interpreted using YANG Schema Mount
   [RFC8528], by following these steps:

   1.  For each anydata node containing a set of "full:embed" statement,
       replace them by a container containing single "mount-point" with
       a unique label.

   2.  Declare each of these "mount-points" as "shared-schema" in the
       data model defined in [RFC8528].

   3.  In the instance corresponding to each "mount-point", define the
       ietf-yang-library [RFC8525] to include a module-set (at '/yang-
       library/module-set/) with the following.  The list 'module'
       contains an entry for every module referred to in the set of
       "full:embed" statements corresponding to the "mount-point".
       Additionally, the list 'module' contains an entry for "ietf-yang-
       library" as it is needed by YANG Schema mount.  As usual, the
       list 'imported-modules' contains the list of dependencies needed
       by the modules in the 'module' list.

   An example of module using "full:embed" and its translation into a
   similar YANG Schema mount version is presented in Appendix B.

3.2.  Limitations

   A module MUST NOT use the "full:embed" statement with its own prefix
   as argument.  This rule prevents any infinite recursion in the
   mounted schemas.

Quilbeuf, et al.        Expires 5 September 2024                [Page 5]
Internet-Draft               YANG Full Embed                  March 2024

   As for YANG Schema Mount, the set of embedded modules is an
   independent YANG context, where every reference (for instance leaf-
   ref, augment, when) is contained in that context.  It is not possible
   for an embedded module to refer to the embedding module, which would
   be rejected by the compiler anyway because it would create a
   dependency loop.  If a server supports a module both at top-level and
   embedded in another module, the corresponding data instances are
   disjoint.

   Activation of the features for the embedded module follows the same
   rules as for normal module.  Therefore it’s not possible to activate
   some features for some embedded modules only.  The feature is either
   supported by the server and then activated for every module (embedded
   or not) or not supported and then deactivated for all modules
   (embedded or not).

3.3.  Allowed sub-statements

   The following sub-statements are allowed in the "full:embed"
   statement:

   *  when

   *  if-feature

   Both statements have the same meaning as in [RFC7950].  The when
   statement MUST NOT refer to nodes which are in the embedded module
   designated by the "full:embed" statement.

4.  ietf-full-embed YANG module

   We present in this section the YANG module defining the "full-embed"
   extension.  The module in itself defines solely the 'embed'
   extension.  A module importing this extension SHOULD use the prefix
   'full', so that the statement reads "full:embed" when used in the
   code.

   <CODE BEGINS> file "ietf-full-embed@2023-11-03.yang"
   module ietf-yang-full-embed {
     yang-version 1.1;
     namespace "urn:ietf:params:xml:ns:yang:ietf-yang-full-embed";
     prefix full;

     organization
       "IETF NETMOD (NETCONF Data Modeling Language) Working Group";
     contact
       "WG Web:   <https://datatracker.ietf.org/wg/netmod/>
        WG List:  <mailto:netmod@ietf.org>

Quilbeuf, et al.        Expires 5 September 2024                [Page 6]
Internet-Draft               YANG Full Embed                  March 2024

        Editor:   ";
     description
       "This module defines a YANG extension statement that can be used
        to incorporate data models defined in other YANG modules in a
        module.

        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.

        Copyright (c) 2023 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.";

     revision 2023-11-05 {
       description
         "Initial revision.";
       reference
         "RFC XXXX: YANG Full Embed";
     }

     extension embed {
       argument prefix;
       description
         "The argument 'prefix' MUST be the prefix of a module imported
          by the calling module.

          The 'embed' statement MUST NOT be used in a YANG version 1
          module, neither explicitly nor via a 'uses' statement.

          The 'embed' statement MAY be present as a substatement of
          'anydata' and MUST NOT be present elsewhere.

          Whenever a sequence of 'embed' statements is used, the schema
          tree defined by the set of the included modules is inserted
          in the schema tree of the calling module, at the place where
          the sequence is declared";

Quilbeuf, et al.        Expires 5 September 2024                [Page 7]
Internet-Draft               YANG Full Embed                  March 2024

     }
   }
   <CODE ENDS>

5.  Security Considerations

   TODO

6.  IANA Considerations

   TODO

7.  Contributors

8.  Open issues

   *  What name should we give to this draft?  Any suggestions instead
      of full embed?

   *  Do we want to support the parent-nodes mechanism from [RFC8528]?
      (see below)

   *  Do we allow full embed into an augment?  We could even relax no
      self-reference to have a module embed itself into another by
      augmenting it?

   *  Does this mechanism already exist?

   *  Do we want to add a partial embed with an xpath instead of just
      the prefix?  The goal would be to include only part of a module.
      This complexifies a bit the validation as leaf-ref, must, when and
      other statement involving Xpath will need to be reinterpreted in
      that new context.

8.1.  Parent-nodes mechanism from schema mount

   YANG Schema Mount includes a mechanism to make some nodes from the
   embedding model available to the embedded model for validation
   purposes.  We could achieve the same by adding a second extension,
   which can also only appear under a "full:embed" nodes.  That
   extension, for instance named "full:embed-parent-refs" would take a
   Xpath expression as the in the "parent-reference" leaflist defined in
   the YANG Schema Mount and would have the same semantics.  If several
   XPath are needed for clarity, the statement can be repeated with
   several values.

Quilbeuf, et al.        Expires 5 September 2024                [Page 8]
Internet-Draft               YANG Full Embed                  March 2024

   As an example, Figure 1 restates the parent-references example from
   [RFC8528] using this new extension.  We might want to put some
   restrictions on the nodes that can be referred to in the Xpath
   argument.

   ...
   import "ietf-routing" {
     prefix "rt";
   }
   import "ietf-interfaces" {
     prefix "if";
   }

   ...
   container network-instances {
     list network-instance {
       leaf name {...}
       anydata root {
         full:embed "rt" {
           full:embed-parent-refs "if:interfaces/if:interface[\
                 ni:bind-network-instance-name = current()/../ni:name]";
         }
         // other full:embed if needed
       }
     }
   }

     Figure 1: Pseudo-YANG example of parent-references from [RFC8528]
                             with "full:embed"

9.  References

9.1.  Normative References

   [RFC2119]  Bradner, S., "Key words for use in RFCs to Indicate
              Requirement Levels", BCP 14, RFC 2119,
              DOI 10.17487/RFC2119, March 1997,
              <https://www.rfc-editor.org/info/rfc2119>.

   [RFC7950]  Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language",
              RFC 7950, DOI 10.17487/RFC7950, August 2016,
              <https://www.rfc-editor.org/info/rfc7950>.

   [RFC8174]  Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC
              2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174,
              May 2017, <https://www.rfc-editor.org/info/rfc8174>.

Quilbeuf, et al.        Expires 5 September 2024                [Page 9]
Internet-Draft               YANG Full Embed                  March 2024

   [RFC8528]  Bjorklund, M. and L. Lhotka, "YANG Schema Mount",
              RFC 8528, DOI 10.17487/RFC8528, March 2019,
              <https://www.rfc-editor.org/info/rfc8528>.

9.2.  Informative References

   [I-D.clemm-netmod-peermount]
              Clemm, A., Voit, E., Guo, A., and I. D. Martinez-
              Casanueva, "Mounting YANG-Defined Information from Remote
              Datastores", Work in Progress, Internet-Draft, draft-
              clemm-netmod-peermount-02, 23 October 2023,
              <https://datatracker.ietf.org/doc/html/draft-clemm-netmod-
              peermount-02>.

   [I-D.havel-opsawg-digital-map]
              Havel, O., Claise, B., de Dios, O. G., Elhassany, A.,
              Graf, T., and M. Boucadair, "Modeling the Digital Map
              based on RFC 8345: Sharing Experience and Perspectives",
              Work in Progress, Internet-Draft, draft-havel-opsawg-
              digital-map-01, 23 October 2023,
              <https://datatracker.ietf.org/doc/html/draft-havel-opsawg-
              digital-map-01>.

   [I-D.ietf-opsawg-collected-data-manifest]
              Claise, B., Quilbeuf, J., Lopez, D. R., Dominguez, I., and
              T. Graf, "A Data Manifest for Contextualized Telemetry
              Data", Work in Progress, Internet-Draft, draft-ietf-
              opsawg-collected-data-manifest-03, 4 March 2024,
              <https://datatracker.ietf.org/api/v1/doc/document/draft-
              ietf-opsawg-collected-data-manifest/>.

   [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,
              <https://www.rfc-editor.org/info/rfc6241>.

   [RFC8340]  Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams",
              BCP 215, RFC 8340, DOI 10.17487/RFC8340, March 2018,
              <https://www.rfc-editor.org/info/rfc8340>.

   [RFC8525]  Bierman, A., Bjorklund, M., Schoenwaelder, J., Watsen, K.,
              and R. Wilton, "YANG Library", RFC 8525,
              DOI 10.17487/RFC8525, March 2019,
              <https://www.rfc-editor.org/info/rfc8525>.

   [RFC8641]  Clemm, A. and E. Voit, "Subscription to YANG Notifications
              for Datastore Updates", RFC 8641, DOI 10.17487/RFC8641,
              September 2019, <https://www.rfc-editor.org/info/rfc8641>.

Quilbeuf, et al.        Expires 5 September 2024               [Page 10]
Internet-Draft               YANG Full Embed                  March 2024

Appendix A.  Changes between revisions

   00 -> 01

   *  Renamed full include -> full embed

   *  Require extension to appear in anydata for clients not supporting
      extension

   *  Allow "if-feature" and "must" as sub-statement of full:embed,
      explain that feature work at server level

Appendix B.  Examples

   In this section we present some minimalistic examples in order to
   illustrate the "full:embed" statement.  For these examples, we are in
   a situation where we have a device-level module already defined and
   we want to have a network-level module that represent a list of
   device, each having an independent instance of the device-level
   module.  This situation might arise if we want to simplify the
   network management by presenting a unified model for the network.  In
   that case, the heterogeneity of the devices should be handled by
   mapping their model to the device-level module (which is clearly out
   of scope for this draft).

   In our simplistic example, the device-level module simply exposes the
   hostname and the cpu-usage of the device.  Note that we cannot modify
   this device-level module, because in a more realistic example we
   would be reusing standard modules.  The tree representation
   ([RFC8340]) of the 'device-level' module is depicted in Figure 2.

   module: device-level
     +--rw hostname     string
     +--ro cpu-usage?   int8

       Figure 2: YANG Tree representation of the device-level module.

   For the network-level module, we have a list of devices indexed by
   their 'device-id'.  The tree representation ([RFC8340]) of such a
   module is depicted in Figure 3.

   module: network-level-stub
     +--rw devices
        +--rw device* [device-id]
           +--rw device-id    string

       Figure 3: YANG Tree representation of a stub for the network-
                                level module

Quilbeuf, et al.        Expires 5 September 2024               [Page 11]
Internet-Draft               YANG Full Embed                  March 2024

   The goal is now to complete this stub so that the full contents of
   the 'device-level' is added under the "device" list.

B.1.  Example using YANG Full Embed

   We propose in this section a YANG module for 'network-level'.  The
   YANG code is presented in Figure 4.

   module network-level {
     yang-version 1.1;
     namespace "urn:network-level";
     prefix "net-l";

     import "ietf-yang-full-include" {
       prefix "full";
     }

     import "device-level" {
       prefix "dev-l";
     }

     container devices {
       list device {
         key device-id;
         leaf device-id {
           type string;
         }
         anydata device-content {
              full:include "dev-l";
         }
       }
     }
   }

       Figure 4: Version of the network-level module using full:embed

   At the moment, this code is accepted by the YANG compilers, but since
   the extension is not implemented, it simply ignores it.  Note that
   all the information (which modules to embed, where to embed them) is
   defined in this module.  More specifically, the line 'full:embed
   "dev-l";' states that the full schema of the 'device-level' module,
   identified by its prefix "dev-l" must be embedded at that location.
   By adding more occurrences of "full:embed" there, one can define a
   more complex schema to be embedded at that location.

Quilbeuf, et al.        Expires 5 September 2024               [Page 12]
Internet-Draft               YANG Full Embed                  March 2024

B.2.  Using YANG Schema Mount

   In this section, we show how a similar result could be attained using
   YANG Schema Mount.  The network-level module is presented in
   Figure 5.

   module network-level {
     yang-version 1.1;
     namespace "urn:network-level";
     prefix "net-l";

     import ietf-yang-schema-mount {
       prefix yangmnt;
     }

     container devices {
       list device {
         key device-id;
         leaf device-id {
           type string;
         }
         container device-contents{
           yangmnt:mount-point "device-schema";
         }
       }
     }
   }

      Figure 5: Version of the network-level module using Schema Mount

   As explained in Section 3.1, the yang-library corresponding to the
   modules to embed, as well as the data required by 'ietf-yang-mount'
   needs to be specified in some other files.  Using the 'yanglint' tool
   from libyang (https://github.com/CESNET/libyang), this module can be
   compiled to provide a tree representation as shown in Figure 6.

   module: network-level
     +--rw devices
        +--rw device* [device-id]
           +--rw device-id          string
           +--mp device-contents
              +--rw hostname/    string
              +--ro cpu-usage/?  int8

        Figure 6: Full tree of both network- and device-level using
                                Schema Mount

Quilbeuf, et al.        Expires 5 September 2024               [Page 13]
Internet-Draft               YANG Full Embed                  March 2024

   The command for obtaining that schema is 'yanglint -f tree -p . -x
   extension-data.xml -Y network-level-yanglib.xml yang/network-
   level.yang', assuming all the YANG modules and the two xml files are
   in the current folder.  The file 'network-level-yanglib.xml' contains
   the YANG Library data for the network-level module.  The file
   'extension-data.xml' contains the YANG Library data defining the
   schema to use at the mount point, as well as the data required by
   YANG Schema Mount.  Both are reproduced in Appendix B.3.

B.3.  Support Files

   The code of the 'device-level' module is given in Figure 7.  Then the
   data files 'network-level-yanglib.xml' and 'extension_data.xml' are
   provided.  These files are needed to compile the Schema Mount version
   of our example with yanglint.

   module device-level {
     yang-version 1.1;
     namespace "urn:device-level";
     prefix mnt;

     leaf hostname {
       type string;
       mandatory true;
     }
     leaf cpu-usage {
       type int8;
       config false;
     }
   }

                     Figure 7: device-level YANG module

   <CODE BEGINS> file "network-level-yanglib.xml"
   <yang-library xmlns="urn:ietf:params:xml:ns:yang:ietf-yang-library"
        xmlns:ds="urn:ietf:params:xml:ns:yang:ietf-datastores">
      <module-set>
        <name>main-set</name>
        <module>
          <name>ietf-datastores</name>
          <revision>2018-02-14</revision>
          <namespace>
              urn:ietf:params:xml:ns:yang:ietf-datastores
          </namespace>
        </module>
        <module>
          <name>ietf-yang-library</name>
          <revision>2019-01-04</revision>

Quilbeuf, et al.        Expires 5 September 2024               [Page 14]
Internet-Draft               YANG Full Embed                  March 2024

          <namespace>
              urn:ietf:params:xml:ns:yang:ietf-yang-library
          </namespace>
        </module>
        <module>
          <name>ietf-yang-schema-mount</name>
          <revision>2019-01-14</revision>
          <namespace>
              urn:ietf:params:xml:ns:yang:ietf-yang-schema-mount
          </namespace>
        </module>
        <module>
          <name>network-level</name>
          <namespace>urn:network-level</namespace>
        </module>
        <import-only-module>
          <name>ietf-yang-types</name>
          <revision>2013-07-15</revision>
          <namespace>
              urn:ietf:params:xml:ns:yang:ietf-yang-types
          </namespace>
        </import-only-module>
        <import-only-module>
          <name>ietf-inet-types</name>
          <revision>2013-07-15</revision>
          <namespace>
              urn:ietf:params:xml:ns:yang:ietf-inet-types
          </namespace>
        </import-only-module>
      </module-set>
      <schema>
        <name>main-schema</name>
        <module-set>main-set</module-set>
      </schema>
      <datastore>
        <name>ds:running</name>
        <schema>main-schema</schema>
      </datastore>
      <datastore>
        <name>ds:operational</name>
        <schema>main-schema</schema>
      </datastore>
      <content-id>1</content-id>
    </yang-library>
    <modules-state
      xmlns="urn:ietf:params:xml:ns:yang:ietf-yang-library">
      <module-set-id>2</module-set-id>
    </modules-state>

Quilbeuf, et al.        Expires 5 September 2024               [Page 15]
Internet-Draft               YANG Full Embed                  March 2024

   <CODE ENDS>

   <CODE BEGINS> file "extension_data.xml"
   <yang-library xmlns="urn:ietf:params:xml:ns:yang:ietf-yang-library"
                xmlns:ds="urn:ietf:params:xml:ns:yang:ietf-datastores">
       <module-set>
           <name>mountee-set</name>
           <module>
               <name>device-level</name>
               <namespace>urn:device-level</namespace>
           </module>
           <module>
               <name>ietf-datastores</name>
               <revision>2018-02-14</revision>
               <namespace>
                   urn:ietf:params:xml:ns:yang:ietf-datastores
               </namespace>
           </module>
           <module>
               <name>ietf-yang-library</name>
               <revision>2019-01-04</revision>
               <namespace>
                   urn:ietf:params:xml:ns:yang:ietf-yang-library
               </namespace>
           </module>
           <import-only-module>
               <name>ietf-yang-types</name>
               <revision>2013-07-15</revision>
               <namespace>
                   urn:ietf:params:xml:ns:yang:ietf-yang-types
               </namespace>
           </import-only-module>
           <import-only-module>
               <name>ietf-inet-types</name>
               <revision>2013-07-15</revision>
               <namespace>
                   urn:ietf:params:xml:ns:yang:ietf-inet-types
               </namespace>
           </import-only-module>
       </module-set>
       <schema>
           <name>test-schema</name>
           <module-set>mountee-set</module-set>
       </schema>
       <datastore>
           <name>ds:running</name>
           <schema>test-schema</schema>
       </datastore>

Quilbeuf, et al.        Expires 5 September 2024               [Page 16]
Internet-Draft               YANG Full Embed                  March 2024

       <datastore>
           <name>ds:operational</name>
           <schema>test-schema</schema>
       </datastore>
       <content-id>2</content-id>
   </yang-library>
   <modules-state
       xmlns="urn:ietf:params:xml:ns:yang:ietf-yang-library">
       <module-set-id>2</module-set-id>
   </modules-state>
   <schema-mounts
       xmlns="urn:ietf:params:xml:ns:yang:ietf-yang-schema-mount">
       <mount-point>
           <module>network-level</module>
           <label>device-schema</label>
           <shared-schema/>
       </mount-point>
   </schema-mounts>
   <CODE ENDS>

Acknowledgements

   Thanks to Ladislav Lhotka and Ignacio Dominguez Martinez-Casanueva
   for their reviews and comments.

Authors' Addresses

   Jean Quilbeuf
   Huawei
   Email: jean.quilbeuf@huawei.com

   Benoit Claise
   Huawei
   Email: benoit.claise@huawei.com

   Thomas Joubert
   Huawei
   Email: thomas.joubert1@huawei-partners.com

Quilbeuf, et al.        Expires 5 September 2024               [Page 17]