YANG Packages
draft-ietf-netmod-yang-packages-01

Document Type Active Internet-Draft (netmod WG)
Authors Robert Wilton  , Reshad Rahman  , Joe Clarke  , Jason Sterne  , Bo Wu 
Last updated 2020-11-02
Replaces draft-rwilton-netmod-yang-packages
Stream IETF
Intended RFC status (None)
Formats plain text xml pdf htmlized (tools) htmlized bibtex
Yang Validation 22 errors, 3 warnings.
Additional Resources
- Yang catalog entry for ietf-yang-inst-data-pkg@2020-01-21.yang
- Yang catalog entry for ietf-yang-package-instance@2020-01-21.yang
- Yang catalog entry for ietf-yang-package-types@2020-01-21.yang
- Yang catalog entry for ietf-yang-packages@2020-01-21.yang
- Yang catalog entry for ietf-yl-packages@2020-01-21.yang
- Yang impact analysis for draft-ietf-netmod-yang-packages
- Mailing list discussion
Stream WG state WG Document
Document shepherd No shepherd assigned
IESG IESG state I-D Exists
Consensus Boilerplate Unknown
Telechat date
Responsible AD (None)
Send notices to (None)
Network Working Group                                     R. Wilton, Ed.
Internet-Draft                                                 R. Rahman
Intended status: Standards Track                               J. Clarke
Expires: May 6, 2021                                 Cisco Systems, Inc.
                                                               J. Sterne
                                                                   Nokia
                                                              B. Wu, Ed.
                                                                  Huawei
                                                        November 2, 2020

                             YANG Packages
                   draft-ietf-netmod-yang-packages-01

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 packages: are represented on
   a server, can be defined in offline YANG instance data files, and can
   be used to define the schema associated with YANG instance data
   files.

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 May 6, 2021.

Copyright Notice

   Copyright (c) 2020 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

Wilton, et al.             Expires May 6, 2021                  [Page 1]
Internet-Draft                YANG Packages                November 2020

   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
   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  . . . . . . . . . . . . . . . . . . .   8
       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  . . . . . . . . . .   9
         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.3.3.  The relationship between packages and datastores  . .  12
     5.4.  Schema referential completeness . . . . . . . . . . . . .  13
     5.5.  Package name scoping and uniqueness . . . . . . . . . . .  14
       5.5.1.  Globally scoped packages  . . . . . . . . . . . . . .  14
       5.5.2.  Server scoped packages  . . . . . . . . . . . . . . .  14
     5.6.  Submodules packages considerations  . . . . . . . . . . .  14
     5.7.  Package tags  . . . . . . . . . . . . . . . . . . . . . .  14
     5.8.  YANG Package Usage Guidance . . . . . . . . . . . . . . .  15
       5.8.1.  Use of deviations in YANG packages  . . . . . . . . .  15
       5.8.2.  Use of features in YANG modules and YANG packages . .  16
     5.9.  YANG package core definition  . . . . . . . . . . . . . .  16
   6.  Package Instance Data Files . . . . . . . . . . . . . . . . .  17
   7.  Package Definitions on a Server . . . . . . . . . . . . . . .  18
     7.1.  Package List  . . . . . . . . . . . . . . . . . . . . . .  18
     7.2.  Tree diagram  . . . . . . . . . . . . . . . . . . . . . .  19
   8.  YANG Library Package Bindings . . . . . . . . . . . . . . . .  19
Show full document text