Internet-Draft | SAP Network YANG | October 2021 |
Gonzalez de Dios, et al. | Expires 25 April 2022 | [Page] |
This document defines a YANG data model for representing an abstract view of the provider network topology containing the points from which its services can be attached (e.g., basic connectivity, VPN, network slices). The data model augments the 'ietf-network' data model by adding the concept of service attachment points (SAPs). The service attachment points are the points to which network services (such as L3VPN or L2VPN) can be attached. The customer endpoint of an attachment circuits are not covered in the SAP network topology.¶
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 25 April 2022.¶
Copyright (c) 2021 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 the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License.¶
The service attachment point (SAP) is an important architectural concept in many implementations and deployments of services such as VPNs, SDWAN, or managed VoIP services. It has already been used to decide where to attach and, thus, deliver the service in the L3SM [RFC8299] and the L2SM [RFC8466].¶
This document defines a YANG network model for representing, managing, and controlling the service attachment points (SAPs). The data model augments the 'ietf-network' module [RFC8345] by adding the concept of service attachment points. The service attachment points are abstraction of the points where network services such as L3VPNs or L2VPNs can be attached.¶
This document does not make any assumption about the service provided by the network to the users. VPN services are used for illustration purposes. This concept can also be used to decide network slice SAPs [I-D.ietf-teas-ietf-network-slices].¶
In the context of Software-Defined Networking (SDN) [RFC7149][RFC7426], the defined YANG data model in this document can be used to exchange information between control elements, so as to support VPN service provision and resource management discussed in [I-D.ietf-opsawg-l3sm-l3nm][I-D.ietf-opsawg-l2nm]. Through this data model, the service orchestration layer can learn the available endpoints (i.e., SAPs) of interconnection resource of the underlying network.¶
The service orchestration layer can determine which endpoint of interconnection to add to L2VPN or L3VPN service. With the help of other data models (e.g., L3SM [RFC8299] or L2SM [RFC8466]), hierarchical control elements could determine the feasibility of an end-to-end IP connectivity or L2VPN connectivity and therefore derive the sequence of domains and the points of interconnection to use.¶
This document explains the scope and purpose of a SAP network model and its relation with the service models and describes how it can be used by a network operator. The document also shows how the topology and service models fit together.¶
The YANG data model in this document conforms to the Network Management Datastore Architecture (NMDA) [RFC8342].¶
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 assumes that the reader is familiar with the contents of [RFC6241], [RFC7950], and [RFC8309]. The document uses terms from those documents.¶
Tree diagrams used in this document follow the notation defined in [RFC8340].¶
This document uses the term "network model" defined in Section 2.1 of [RFC8969].¶
This document uses the following terms:¶
Management operations of a service provider network can be automated using a variety of means such as interfaces based on YANG modules [RFC8969]. From that standpoint, and considering the architecture depicted in Figure 1, the goal of this document is to provide a mechanism to show via a YANG-based interface an abstracted network view from the network controller to the service orchestration layer with a focus on where a service can be delivered to customers.¶
+-----------------+ | Customer | +--------+--------+ Customer Service Models | | +--------+--------+ | Service | | Orchestration | +------+---+------+ Service Network Models | | SAP Network Model | | +------+---+------+ | Network | | Controller | +--------+--------+ | +---------------------+---------------------+ | Network | +-------------------------------------------+
Let us consider the example of a typical service provider network (Figure 2), with PE and P nodes.¶
+---------+ +---------+ | PE1 | | PE2 | +---------+ +---------+ \ / +------+ | P | +------+ / \ +---------+ +---------+ | PE3 | | PE4 | +---------+ +---------+
The Service Orchestration layer does not need to know about the internals of the underlying network (e.g., P nodes). Figure 3 shows the abstract network view as seen by the Service Orchestrator. However, this view is not enough to provide to the Service Orchestration layer the information to create services in the network. The service topology need is to be able to expose the set of nodes and the attachment points associated with the nodes from which network services can be grafted (delivered).¶
+---------+ +---------+ | PE1 | | PE2 | +---------+ +---------+ +---------+ +---------+ | PE3 | | PE4 | +---------+ +---------+
The Service Orchestration layer would see a set of PEs and a set of client-facing interfaces (physical or logical) to which CEs can be connected (or are actually connected). The Service Orchestration layer can use them to setup the requested services or to commit the delivery of a service. Figure 4 depicts the SAP network topology that is maintained by the network controller and exposed to the Service Orchestration.¶
.---. .---. .---. .---. .---. +-|sap|-|sap|-|sap|-+ +-|sap|-------|sap|-+ | '---' '---' '---' | | '---' '---' | .---. | | | |sap| PE1 | | PE2 | '---' | | | | | | | +-------------------+ +-------------------+ +-------------------+ +-------------------+ | | | | | | | .---. | PE3 | | PE4 |sap| | | | '---' | .---. .---. .---. | | .---. .---. .---. | +-|sap|-|sap|-|sap|-+ +-|sap|-|sap|-|sap|-+ '---' '---' '---' '---' '---' '---'
A single SAP network topology can be used for one of multiple service types (e.g., L3VPN, EVPN). The network controller can then expose the service type(s) and associated interfaces via the SAPs.¶
As shown in Figure 5, the Service Orchestration layer will have also access to a set of Customer Service Model, e.g., an L3SM or L2SM data model in the customer-facing interface and a set of network models, e.g., L3NM and Network topology data models in the resource-facing interface. In this use case, it is assumed that the network controller is unaware of what happens beyond the PEs towards the CEs; it is only responsible for the management and control of the network between PEs.¶
.---. |CE2| '-+-' | .---. .---. .---. .---. .-+-. +-|sap|-|sap|-|sap|-+ +-|sap|-------|sap|-+ | '---' '---' '---' | | '---' '---' | .---. .---. | | | |CE1+--+sap| PE1 | | PE2 | '---' '---' | | | | | | | +-------------------+ +-------------------+ +-------------------+ +-------------------+ | | | | | | | .---. .---. | PE3 | | PE4 |sap+--+CE5| | | | '---' '---' | .---. .---. .---. | | .---. .---. .---. | +-|sap|-|sap|-|sap|-+ +-|sap|-|sap|-|sap|-+ '---' '---' '-+-' '---' '---' '---' | | .-+-. .-+-. |CE3| |CE4| '-+-' '-+-'
The SAP network model builds on the network data model defined in the 'ietf-network' module [RFC8345], augmenting the nodes with service attachment points, which anchor the links and are contained in nodes. The 'service-attachment-point' attribute defined in the SAP network model is not a tunnel termination point (TTP) nor a link, but an abstraction of the termination point defined in [RFC8345].¶
The structure of the 'ietf-sap-ntw' module is shown in Figure 6.¶
module: ietf-sap-ntw augment /nw:networks/nw:network/nw:network-types: +--rw sap-network! +--rw sap-type* identityref augment /nw:networks/nw:network/nw:node: +--rw service-attachment-point* [attachment-id] +--rw attachment-id nt:tp-id +--ro interface-type? identityref +--rw admin-status? boolean +--rw oper-status? boolean +--rw encapsulation-type? identityref +--rw sap-type* identityref +--rw service-description? string
A SAP network topology can be used for one single service type or multiple types ("sap-type"). When a SAP topology is used for many service types, the underlying nodes must support at least one of these service types. Examples of supported service types are listed below:¶
A service attachment point is identified by an interface name ("attachment-id"), an interface type ("type"), a status ("admin-status", and "oper-status"), an encapsulation type ("encapsulation-type"), one or a list of service types ("sap-type") such as L3VPN or network slice, a description of the service(s) ("service-description").¶
The SAP network model can be seen as an inventory data associated with service attachment points. The model maintains an inventory of nodes contained in a network based on [RFC8345].¶
+-------------------------+ | | | Abstract Network Model | | | +------------+------------+ | +---------+---------+ | | +------V------+ +------V------+ | Abstract | | Inventory | | Network | | Model(s) | | Topology | | e.g.,SAP | | Model | | Network | | | | Model | +-----+-------+ +-------------+ | +-----------+-----------+ | | | +----V----+ +----V----+ +----V----+ |TE Topo | |L3 Topo | |L2 Topo | | Model | | Model | | Model | ... +---------+ +---------+ +---------+
Figure 7 depicts the relationship of the SAP network model to other models. The SAP network model augments from the Network model [RFC8345] and imports Network Topology model, while other technology-specific topology models (e.g., TE Topologies model [RFC8795] or L3 Topology model [RFC8346]) augment from the Network Topology.¶
This module imports types from [RFC8343], [RFC8345], and [I-D.ietf-opsawg-vpn-common].¶
<CODE BEGINS> file "ietf-sap-ntw@2021-10-16.yang" module ietf-sap-ntw { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:ietf-sap-ntw"; prefix sap; import ietf-interfaces { prefix if; reference "RFC 8343: A YANG Data Model for Interface Management"; } import ietf-network-topology { prefix nt; reference "RFC 8345: A YANG Data Model for Network Topologies, Section 6.2"; } import ietf-network { prefix nw; reference "RFC 8345: A YANG Data Model for Network Topologies, Section 6.1"; } import ietf-vpn-common { prefix vpn-common; reference "RFC UUUU: A Layer 2/3 VPN Common YANG Model"; } organization "IETF OPSA (Operations and Management Area) Working Group "; contact "Editor: Oscar Gonzalez de Dios <mailto:oscar.gonzalezdedios@telefonica.com> Editor: Samier Barguil <mailto:samier.barguilgiraldo.ext@telefonica.com> Editor: Qin Wu <mailto:bill.wu@huawei.com> Editor: Mohamed Boucadair <mailto:mohamed.boucadair@orange.com>"; description "This YANG module defines a model for representing, managing, and controlling the Service Attachment Points (SAPs) in the network topology. Copyright (c) 2021 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 Simplified 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 (https://www.rfc-editor.org/info/rfcXXXX); see the RFC itself for full legal notices."; revision 2021-10-16 { description "Initial version"; reference "RFC XXXX: A Network YANG Model for Service Attachment Point (SAP)"; } identity service-type { description "Base identity for the service type."; } identity l3vpn { base service-type; description "L3VPN service."; reference "RFC 4364: BGP/MPLS IP Virtual Private Networks (VPNs)"; } identity enhanced-vpn { base service-type; description "Enhanced VPN (VPN+). VPN+ is an approach that is based on existing VPN and Traffic Engineering (TE) technologies but adds characteristics that specific services require over and above traditional VPNs."; reference "I-D.ietf-teas-enhanced-vpn: A Framework for Enhanced Virtual Private Network (VPN+) Services"; } identity network-slice { base service-type; description "IETF network slice. An IETF network slice is a logical network topology connecting a number of endpoints using a set of shared or dedicated network resources that are used to satisfy specific service objectives."; reference "I-D.ietf-teas-ietf-network-slices: Framework for IETF Network Slices"; } identity vpls { base service-type; description "VPLS service."; reference "RFC 4761: Virtual Private LAN Service (VPLS) Using BGP for Auto-Discovery and Signaling RFC 4762: Virtual Private LAN Service (VPLS) Using Label Distribution Protocol (LDP) Signaling"; } identity vpws { base service-type; description "Virtual Private Wire Service (VPWS) service."; reference "RFC 4664: Framework for Layer 2 Virtual Private Networks (L2VPNs), Section 3.1.1"; } identity vpws-evpn { base service-type; description "EVPN used to support VPWS service."; reference "RFC 8214: Virtual Private Wire Service Support in Ethernet VPN"; } identity pbb-evpn { base service-type; description "Provider Backbone Bridging (PBB) EVPNs service."; reference "RFC 7623: Provider Backbone Bridging Combined with Ethernet VPN (PBB-EVPN)"; } identity mpls-evpn { base service-type; description "MPLS-based EVPN service."; reference "RFC 7432: BGP MPLS-Based Ethernet VPN"; } identity vxlan-evpn { base service-type; description "VXLAN-based EVPN service."; reference "RFC 8365: A Network Virtualization Overlay Solution Using Ethernet VPN (EVPN)"; } identity virtual-network { base service-type; description "Virtual network."; reference "RFC 8453: Framework for Abstraction and Control of TE Networks (ACTN)"; } /* Other network service types may be added. */ grouping sap-information { description "Service Attachment Point (SAP) information."; list service-attachment-point { key "attachment-id"; description "The service attachment points are abstraction of the points where network services such as L3VPNs, L2VPNs, or network slices can be attached."; leaf attachment-id { type nt:tp-id; description "Indicates the name of the interface."; } leaf interface-type { type identityref { base if:interface-type; } config false; description "The type of the interface."; } leaf admin-status { type boolean; description "Indicates the administrative status of the SAP."; } leaf oper-status { type boolean; description "Indicates the operational status."; } leaf encapsulation-type { type identityref { base vpn-common:encapsulation-type; } description "Encapsulation type."; } leaf-list sap-type { type identityref { base service-type; } description "SAP type."; } leaf service-description { type string; description "A textual description of the service(s)."; } } } augment "/nw:networks/nw:network/nw:network-types" { description "Introduces a new network type for SAP network."; container sap-network { presence "Indicates SAP Network Type."; description "The presence of the container node indicates the SAP network type."; leaf-list sap-type { type identityref { base service-type; } description "Indicates a service type."; } } } augment "/nw:networks/nw:network/nw:node" { description "Parameters for the service attachment point level."; uses sap-information; } } <CODE ENDS>¶
This document registers the following namespace URI in the "ns" subregistry within the "IETF XML Registry" [RFC3688]:¶
URI: urn:ietf:params:xml:ns:yang:ietf-sap-ntw Registrant Contact: The IESG. XML: N/A, the requested URI is an XML namespace.¶
This document registers the following YANG module in the YANG Module Names registry [RFC6020] within the "YANG Parameters" registry:¶
name: ietf-sap-ntw namespace: urn:ietf:params:xml:ns:yang:ietf-sap-ntw maintained by IANA: N prefix: sap reference: RFC XXXX¶
The YANG module specified in this document defines schema for data that is designed to be accessed via network management protocols such as NETCONF [RFC6241] or RESTCONF [RFC8040]. The lowest NETCONF layer is the secure transport layer, and the mandatory-to-implement secure transport is Secure Shell (SSH) [RFC6242]. The lowest RESTCONF layer is HTTPS, and the mandatory-to-implement secure transport is TLS [RFC8446].¶
The Network Configuration Access Control Model (NACM) [RFC8341] provides the means to restrict access for particular NETCONF or RESTCONF users to a preconfigured subset of all available NETCONF or RESTCONF protocol operations and content.¶
There are a number of data nodes defined in this YANG module that are writable/creatable/deletable (i.e., config true, which is the default). These data nodes may be considered sensitive or vulnerable in some network environments. Write operations (e.g., edit-config) to these data nodes without proper protection can have a negative effect on network operations. These are the subtrees and data nodes and their sensitivity/vulnerability:¶
This subtree specifies the configurations of the nodes in a SAP network model. Unexpected changes to this subtree could lead to service disruption and/or network misbehavior.¶
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:¶
Thanks to Adrian Farrell and Daniel King for the suggestions on the names used in a previous version.¶