YANG Packages
draft-rwilton-netmod-yang-packages-00

Document Type Active Internet-Draft (individual)
Last updated 2018-12-20
Stream (None)
Intended RFC status (None)
Formats plain text xml pdf html bibtex
Yang Validation 20 errors, 0 warnings.
Additional URLs
- Yang catalog entry for ietf-yang-library-packages@2018-11-26.yang
- Yang catalog entry for ietf-yang-package-types@2018-11-26.yang
- Yang catalog entry for ietf-yang-package@2018-11-26.yang
- Yang impact analysis for draft-rwilton-netmod-yang-packages
Stream Stream state (No stream defined)
Consensus Boilerplate Unknown
RFC Editor Note (None)
IESG IESG state I-D Exists
Telechat date
Responsible AD (None)
Send notices to (None)
Network Working Group                                          R. Wilton
Internet-Draft                                       Cisco Systems, Inc.
Intended status: Standards Track                       December 20, 2018
Expires: June 23, 2019

                             YANG Packages
                 draft-rwilton-netmod-yang-packages-00

Abstract

   This document defines YANG packages, an organizational structure
   holding a set of related YANG modules, that can be used to simplify
   the conformance and sharing of YANG schema.  It describes how YANG
   instance data documents are used to define YANG packages, and how the
   YANG library information published by a server can be augmented with
   additional packaging related information.

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 June 23, 2019.

Copyright Notice

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

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

Wilton                    Expires June 23, 2019                 [Page 1]
Internet-Draft                YANG Packages                December 2018

   the Trust Legal Provisions and are provided without warranty as
   described in the Simplified BSD License.

Table of Contents

   1.  Terminology and Conventions . . . . . . . . . . . . . . . . .   2
   2.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   3
   3.  Background on YANG packaging  . . . . . . . . . . . . . . . .   4
   4.  Objectives  . . . . . . . . . . . . . . . . . . . . . . . . .   4
   5.  Package description . . . . . . . . . . . . . . . . . . . . .   5
     5.1.  Package definition rules  . . . . . . . . . . . . . . . .   6
     5.2.  Package versioning  . . . . . . . . . . . . . . . . . . .   7
     5.3.  Client server package conformance . . . . . . . . . . . .   8
     5.4.  Submodules packaging considerations . . . . . . . . . . .   8
     5.5.  Revision history  . . . . . . . . . . . . . . . . . . . .   9
     5.6.  Uniqueness of packages and global registry  . . . . . . .   9
   6.  YANG Packaging instance data  . . . . . . . . . . . . . . . .   9
   7.  YANG Packaging additions to YANG library  . . . . . . . . . .  11
     7.1.  Package List  . . . . . . . . . . . . . . . . . . . . . .  11
     7.2.  Binding from schema to package  . . . . . . . . . . . . .  11
     7.3.  Tree diagram  . . . . . . . . . . . . . . . . . . . . . .  12
   8.  YANG Packaging groupings  . . . . . . . . . . . . . . . . . .  12
   9.  YANG Modules  . . . . . . . . . . . . . . . . . . . . . . . .  14
   10. Open Questions/Issues . . . . . . . . . . . . . . . . . . . .  26
   11. Security Considerations . . . . . . . . . . . . . . . . . . .  26
   12. IANA Considerations . . . . . . . . . . . . . . . . . . . . .  27
   13. References  . . . . . . . . . . . . . . . . . . . . . . . . .  27
     13.1.  Normative References . . . . . . . . . . . . . . . . . .  27
     13.2.  Informative References . . . . . . . . . . . . . . . . .  29
   Appendix A.  Tree output for ietf-yang-library with package
                augmentations  . . . . . . . . . . . . . . . . . . .  29
   Appendix B.  Examples . . . . . . . . . . . . . . . . . . . . . .  31
     B.1.  Example IETF Network Device YANG package  . . . . . . . .  31
     B.2.  Example IETF Basic Routing YANG package . . . . . . . . .  34
     B.3.  Package import conflict resolution example  . . . . . . .  37
   Author's Address  . . . . . . . . . . . . . . . . . . . . . . . .  39

1.  Terminology and Conventions

   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.

   This document uses terminology introduced in the YANG versioning
Show full document text