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

Document Type Active Internet-Draft (individual)
Last updated 2019-10-24
Stream (None)
Intended RFC status (None)
Formats plain text xml pdf htmlized bibtex
Yang Validation 17 errors, 1 warnings.
Additional URLs
- Yang catalog entry for ietf-yang-inst-data-pkg@2019-09-11.yang
- Yang catalog entry for ietf-yang-package-types@2019-09-11.yang
- Yang catalog entry for ietf-yang-package@2019-09-11.yang
- Yang catalog entry for ietf-yl-packages@2019-09-11.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                        October 23, 2019
Expires: April 25, 2020

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

Abstract

   This document defines YANG packages, a versioned organizational
   structure holding a set of related YANG modules, that collectively
   define a 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 packages
   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 April 25, 2020.

Copyright Notice

   Copyright (c) 2019 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 April 25, 2020                 [Page 1]
Internet-Draft                YANG Packages                 October 2019

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

Table of Contents

   1.  Terminology and Conventions . . . . . . . . . . . . . . . . .   3
   2.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   4
   3.  Background on YANG packages . . . . . . . . . . . . . . . . .   4
   4.  Objectives  . . . . . . . . . . . . . . . . . . . . . . . . .   5
   5.  YANG Package Definition . . . . . . . . . . . . . . . . . . .   6
     5.1.  Package definition rules  . . . . . . . . . . . . . . . .   7
     5.2.  Package versioning  . . . . . . . . . . . . . . . . . . .   7
       5.2.1.  Updating a package with a new version . . . . . . . .   8
         5.2.1.1.  Non-Backwards-compatible changes  . . . . . . . .   8
         5.2.1.2.  Backwards-compatible changes  . . . . . . . . . .   8
         5.2.1.3.  Editorial changes . . . . . . . . . . . . . . . .   9
       5.2.2.  YANG Semantic Versioning for packages . . . . . . . .   9
       5.2.3.  Revision history  . . . . . . . . . . . . . . . . . .  10
     5.3.  Package conformance . . . . . . . . . . . . . . . . . . .  10
       5.3.1.  Use of YANG semantic versioning . . . . . . . . . . .  10
       5.3.2.  Package checksums . . . . . . . . . . . . . . . . . .  11
     5.4.  Schema referential completeness . . . . . . . . . . . . .  11
     5.5.  Package name scoping and uniqueness . . . . . . . . . . .  12
       5.5.1.  Globally scoped packages  . . . . . . . . . . . . . .  12
       5.5.2.  Server scoped packages  . . . . . . . . . . . . . . .  12
     5.6.  Submodules packages considerations  . . . . . . . . . . .  13
     5.7.  Package tags  . . . . . . . . . . . . . . . . . . . . . .  13
   6.  YANG Packages instance data . . . . . . . . . . . . . . . . .  13
   7.  YANG Packages additions to YANG library . . . . . . . . . . .  15
     7.1.  Package List  . . . . . . . . . . . . . . . . . . . . . .  15
     7.2.  Binding from schema to package  . . . . . . . . . . . . .  15
     7.3.  Tree diagram  . . . . . . . . . . . . . . . . . . . . . .  16
   8.  YANG Packages Groupings . . . . . . . . . . . . . . . . . . .  18
   9.  YANG packages as schema for YANG instance data document . . .  18
   10. YANG Modules  . . . . . . . . . . . . . . . . . . . . . . . .  19
   11. Security Considerations . . . . . . . . . . . . . . . . . . .  40
   12. IANA Considerations . . . . . . . . . . . . . . . . . . . . .  41
   13. Open Questions/Issues . . . . . . . . . . . . . . . . . . . .  42
   14. Acknowledgements  . . . . . . . . . . . . . . . . . . . . . .  42
   15. References  . . . . . . . . . . . . . . . . . . . . . . . . .  42
     15.1.  Normative References . . . . . . . . . . . . . . . . . .  42
     15.2.  Informative References . . . . . . . . . . . . . . . . .  44
Show full document text