Project Name:

• Proposed name for the project: OpenSource Access Manager

• Proposed name for the repository: osam

Project description:

Description:

OpenSource Access Manager is a vendor agnostic operation suite for managing consumer broadband network elements and capabilities disaggregated from proprietary monolithic Access Network hardware and Element Management Systems (EMS).

A key component to simplify multi-vendor support is a mediation layer currently under development called VOLTHA (ONF open source project).  VOLTHA uses low-level abstraction of the network device to provide a simplified approach to higher level management and analytics.  Currently xPON and G.FAST are the initial products under active development in collaboration with ONF. 

Scope:

OpenSource Access Manager is a domain specific module for ONAP consisting of the OA&M User interface, flows, web services and microservices in support of virtualized multi-access network for consumer broadband services.  At a high level it divides into global and localized functions to operate at large scale and performance for edge networks.  The major components of Access Module that do not exist in ONAP today are the user interface (UI), the carrier grade access controller and hardware abstraction though OSAM-HA (ONF: VOLTHAFor Casablanca, OSAM will showcase the management of the Access Peripheral POD (located in Telco Central Offices) as a PNF. Should provide monitoring capability and support 100’s of thousands of Access Peripheral POD deployment in Telco office.

Subscriber management/activation will be contained within the POD and outside the scope of ONAP.

OpenSource Access Manager module for ONAP consisting of the OA&M User interface flows, web services and microservices in support of virtualized multi-access network for consumer broadband services.  At a high level, it divides into global and localized functions to operate at large scale and performance for edge networks.  The major components of Access Module that do not exist in ONAP today are the user interface (UI).  Access specific data models, services, and flows will be built on existing ONAP components and may feed additional requirements.  The infrastructure elements, services, flows, data collection processes will be utilized and existing or planned feature sets should not be impacted.

Below are the functions of access network needed on top of the infrastructure services that are already provided as part of ONAP.  The requirements for Access will be isolated to the Access Module to not impact the core ONAP capabilities and deliverables.

...

OSAM

A work effort in ONAP for bridging the Open Networking Foundation (ONF) work into ONAP. Part of this was to create a higher order UI for the Access Network, Service Models, Work Flows, Policies, etc.  The goal of the project is to build out dependencies for future support of

...

3rd party virtualized network services for the access network.

...

OSAM-Control

...

OSAM-HA

...

OSAM-Collector Agent

...

OSAM-Analytic Agent

...

OSAM-UI

...

Access network is broken down into central and edge deployments.  Some functions of the control and management will be located centrally and some may be located at the edge in support of access.

Central Compute

• User interfaces in support of access.
  • Common ONAP interfaces (Portal, SDC, VID, OOM, CLAMP, CLI) will be reused
  • UI for Broadband Subscriber Access Network devices and Services
  • Reuse of ElasticStack (Kibana, Log Stash and Elastic Search)
• Reuse of the common ONAP functions (In addition to above - limited to the context of access)
  • AAI
  • DCAE
  • SO 
  • DMaaP
  • AAF
  • Policy
   

Generally Edge Compute (Could be with Central Compute)

• User interfaces in support of access.
  • Common ONAP interfaces (Portal, SDC, VID, OOM, CLAMP, CLI) will be reused
  • UI for Broadband Subscriber Access Network devices and Services
  • Reuse of ElasticStack (Kibana, Log Stash and Elastic Search)
• Reuse of the common ONAP functions (In addition to above)
  • DCAE
  • SO 
  • DMaaP
  • AAI
  • Policy
  • APP-C
  • SDN-C
  • Multi-Cloud VIM
• Access Specific Functions
  • DSC- OSAM - Control for Dynamic Control & User Plane
    • Incudes the subscriber Virtual Tenant Network
    • Authentication Tenants
    • Subscriber DHCP Relay
    • Subscriber BNG Associations 
  • OSAM - HA - Network Abstraction Layer for Access Devices
  • FreeRADIUS for Subscriber 802.1X authentication
  • OpenLDAP for Subscriber policies and configurations 
  • OSAM Collector for DCAE
  • OSAM Analytics for DCAE

User stories/Requirements

• Access Network services will operate as containers generally in an edge cloud environment utilizing Docker containers.
• Edge Network services will utilize Kubernetes and K8 models
• Virtualized Access containers will be deployed and lifecycle managed by ONAP core components
• Services provided for the Virtual Access Network will be orchestrated through SO
• VNF Management functions will be controlled by APPC
• Inventory for the access domain will be modeled for AAI
  • Tenant service relationships will be modeled in AAI between OSAM - Control and OSAM - HA
  • Broadband Subscriber profiles will be modeled for AAI
  • AAI will be the DOR for the Broadband Subscriber profiles, but pulled to a domain specific OpenLDAP system
• TOSCA resource models, K8's, Service Models, Images will be created for the OSAM components
• OSAM-UI (Suite of Docker based microservices)
• OSAM-Control (Karaf based Controller)
• OSAM-HA (Suite of Docker based microservices)
  • VOLTHA Core, NETCONF Server, REST Ser 
• FreeRADIUS
• OpenLDAP
• OSAM Collector Agent
• OSAM Analytics Agent 
• Subscriber Broadband Service  
• Access related flows will be modeled in BMPN2 for the SO
• SDC will distribute
  • SDC→SO: Distribute the Service Template(s)
  • SDC→AAI: Distribute the Inventory Model(s)
  • SDC→SDNC: Distribute the network underlay connectivity
  • SDC→APPC: Distribute the Directed Graph(s)
  • SDC→Policy: Distribute the policy Template(s)
    • Initial focus will be limited to Threshold Crossing Analytics
  • SDC→DCAE: Distribute Configuration(s)
  • SDC→DMaaP: Distribute the topic and partition configuration(s) 
• SO Flows
• Add/Update/Remove Broadband Subscriber
• Add/Remove VNFs
• Migrate Broadband Subscriber Services
• Scale Up/Down OSAM-Control and OSAM-HA

OSAM

A work effort in ONAP for bridging the Open Networking Foundation (ONF) work into ONAP. Part of this was to create a higher order UI for the Access Network, Service Models, Work Flows, Policies, etc.  The goal of the project is to build out dependencies for future support of 3rd party virtualized network services for the access network.

OSAM-Control (DSC: Domain Specific Controller)

A Domain Specific Controller (DSC) that provides Dynamic Control & User Plane for subscriber related flows. Framework for tenant services that support core subscriber services and flow control. Initial implementation is based on ONF projects.

• Integration of existing Domain specific controller for broadband subscriber services 
• Provides dynamic control & user plane capabilities
• Provides REST/OpenAPI Spec Interfaces
• Provides 802.1X for RADIUS authentication
• Provides the DHCP Proxy and Client Agent
  • This may differ by implementation
• Provides the mapping from the Subscriber to the BNG 
• Log data provided by Kafka. 
  • Data will be mediated through a VES converter (OPNFV) to the DCAE Collector agent  

OSAM-HA

Provides hardware abstraction layer for the physical network device providing modular protocol and device interfaces.  Initial implementation is Open Networking Foundation (ONF) project VOLTHA.

• Integration of existing Domain Specific abstraction layer that provides uniform access to Broadband Access hardware
• Provides REST/OpenAPI Spec and NETCONF/YANG Interfaces/Models
• Log data provided by Kafka. 
  • Data will be mediated through a VES converter (OPNFV) to the DCAE Collector agent  

• VOLTHA hardware abstraction providing disaggregation of many of the functions currently performed by OLT hardware

  • Protocol Abstraction and Multi-Access API uniformity

  • Device persistence

  • Data Harmonization

OSAM-Collector Agent

Collector agent is a instance built off the DCAE collector agent framework. 

• Built off of the DCAE collector agent framework
• Receives the VES data from the OSAM-Control and OSAM-HA
• OSAM-Control→Kafka→VES Adapter→DCAE Collector Agent→DCAE
• OSAM-HA→Kafka→VES Adapter→DCAE Collector Agent→DCAE
• Provides data to DCAE

OSAM-Analytics Agent

Analytics agent is a instance built off the DCAE analytics agent framework. 

• Built off of the DCAE collector agent framework
• Receives the VES data from the OSAM-Control and OSAM-HA
• Provides Analytics for Access and interacts with the Policy Framework
• Existing Threshold Crossing analytics and policies will be reused and models will be built to reference a scaling SO developed OSAM 

OSAM-UI

OSAM-UI provides an implementation of a centralized management interface for the access network device and services targeted for edge and deep edge deployments.12

• User interface provides capabilities for operations to manage and diagnose problems in the access network.
• Provides a view of the relationship of broadband subscriber services and health of the service chain
• Provides a centralized view of the access network deployed at edge compute locations
• User interface will leverage the Portal SDK.
• Security will utilize groups and roles created in AAF
• Interface to AAI APIs to pull OSAM Network Resources
• Ability for operations to build and deploy advanced services utilizing Node-Red that directly interact with the OSAM-UI
• Interface allows for the bulk execution of flows against many devices and services selected in the OSAM-UI against an enabled service
  • Services are automatically enabled through the management UI using OpenAPI specs generated from Node-Red
• A view of error details for functions/devices streaming with related hot links into the low level details (e.g. Abstraction Layer, OLT, Port, ONU, ONU Uplink Port, ONU UNI Ports, DPU,  CPE, MicroServices, and future components)
  • Advanced text and regular expression based filters based on device names or event details
  • Time range based filters
• Customizations
  • Customizations by a user, group or system level
  • Context sensitive interface changes driven by exposed APIs
  • Ability to store and share views
  • Ability for a user to load multiple views at the same time
• Single application for Network visualization with integrated  analytics from DCAE, Elastic Stack and Grafana
  • Operational dashboard showing geographic distribution of the network and services health (“Heat Map”)
  • Established links between devices/service management and the graphical representations
•  Interface for scheduling and coordinating access related devices and software
  • Firmware Release Management and Upgrades
  • Snapshot management of Access devices and configurations
  • This will be utilized for comparison, restoral and migration activities
  • VNF Service Versioning Management at a collection or subscriber level
  • User Migration flows in coordination with Firmware and VNF release management
  • Rollback and notification under failure conditions or forced action
  • Ability to create collections of subscribers, VNFs, and devices
  • Configurable Maintenance Window
  • Ability to operate in serial or parallel at the collection level
  • Ability to establish dependencies prior to execution

• Support for systems, network, software, service and configuration segmentation (slicing)

  • Can be configured by Global, Site, DMA, Service Type or Device Type and each being subdivided by Release Type

  • Support different lifecycle states of software, firmware and configuration within

    • Examples Crawl, Walk, and Run methodology of deploying changes

    • Examples Development, Test, Incubation, and Production state of services

  • Software Versions, Firmware, Policies, and configurations should be configured as a package

    • Deployed for a specific set of hardware

    • Ability to manage hierarchical configuration management and version controlled

  • Tool for viewing historical changes, comparison, events, and health of a segment

Service Orchestration

• Carriers need the ability to create, update and remove broadband subscriber instances from the virtualized access components
  • The interactions with the access components will be orchestrated through SO
• Carriers need support for orchestration on the edge where limited ONAP infrastructure will exist
• The flows will interact with AAI to retrieve the inventory of the access network
•  Carriers need the ability to manage the firmware on the physical device with coordination with the disaggregated network services
• Flows will need to make coordinated events to ensure the network services are moved, restored and tested 

OpenLDAP

• OpenLDAP will store the subscriber authentication and profile information
• SO will interact with OpenLDAP for updating the subscriber data, security and service profiles
• System will be utilized as a reference implementation and not intended for production use
• This functionality is isolated from ONAP capabilities to support scale of the broadband authentication processes

Image Removed

Architecture Alignment:

OpenSource Access Manager is a domain specific management and services stack interfacing and interacting with the core ONAP capabilities that support and maintain the underlying virtual and physical infrastructure.

Image Removed

How does this project fit into the rest of the ONAP Architecture?

• ONAP manages the physical infrastructure hosting the virtual network function and the underlay network.
• Access Management will leverage many of the existing infrastructure components (AAI, DME, JSC, and Directed Graphs).
• Access Network Models, Flows and API’s will be developed as part of the project.  

How does this align with external standards/specifications?

• Alignment with the ONF, OpenAPI, BBF, IETF and ITU Standards

Are there dependencies with other open source projects?

• Integration with the VOLTHA projects in ONF
• Integration with the OSAM - Dynamic Control & User Plane

Impacts:

ONAP Components: 

...

Inventory of the devices and user services
Creation of Models in SDC
Subscribers will utilize LDAP for Access service profiles and authentication

...

Directed Graphs
VNF Management

...

Interface CLAMP from OSAM-UI (Future Release)

...

Impacts to the Control and Abstraction output to VES

...

Small impact to reuse TCA
Small impact to call SO

...

No expected impacts to the SDC Project itself in Beijing.

...

Interface VID from OSAM-UI

...

No Core SDNC Impacts

...

Access Network Components:

...

Provides Dynamic Control & User Plane
Provides setup of subscriber service flow over the underlay established by he SDN-C

...

S3P:

The project is an effort to utilize the Dynamic Control & User Plane and Hardware abstraction efforts developed with the ONF community.  OSAM is not targeted to change any of the core ONAP components.

Scale:

Access Network functions are built to cluster horizontally and scale to meet carrier performance and response requirements.

Stability:

All Access network components are designed to operate in a horizontal scale in order to provide a seamless user operation.

Security:

The reside on ONAP secured infrastructure.

Performance:

All Access Network components have been developed and tested to support high performance.  If performance issues are found during testing the application

Resources:

...

Image Added

OSAM use case will use the similar approach to 5g use-case. OSAM consists of three components which are OSAM Gateway, OSAM Core, and SEBA. OSAM Gateway and OSAM Core and SEBA will be onboard as a service to ONAP.

• OSAM Core and OSAM Gateway will be onboarded as a VNF
• SEBA will be onboarded as a PNF
• Services will be defined for OSAM CORE and OSAM Gateway
• Another service will be defined for SEBA as a PNF and OSAM Gateway as an alloted Resource
• Auto-scaling based on fault and/or performance will be done through OSAM Gateway and OSAM Core services.

ONAP will perform the following functions for OSAM use-case which are;

• Robust environment
• Scalability
• Sharing different resources on different services
• Overview of the OSAM topology (From OSAM UI)
• Storage for SEBA configuration
• Service Provisioning

Users and Benefit:

Operators benefit from OSAM use case in the following aspects:

1. service agility: more easy design of both VNF, PNF and network service, VNF onboarding, PNF onboarding, and agile service deployment.
2. resource efficiency: through ONAP platform, the VNF resources can be utilized more efficiently, as the services which contain the OSAM Core or OSAM gateway, are deployed and scaled automatically on demand.
3. operation automation and intelligence: through ONAP platform, especially integration with DCAE and policy framework, OSAM Core and OSAM Gateway VNFs and the services as a whole are expected to be managed with much less human interference and therefore will be more robust and intelligent.

OSAM ARCHITECTURE

It currently has 5 main modules which are SEBA, ONAP, OSS/BSS, OSAM Gateway and OSAM Core.

Image Added

OSAM is addressed as PNF model of 5G use case. In 5G use case, CU and DU pairs are used. In our OSAM case, we are going to use the similar approach. SEBA is going to be mapped as DU. OSAM GW(Gateway) is going to be mapped as CU.

OSAM CORE

OSAM core will be designed as a VNF. It consists of

• OSAM UI
• OSAM DB
• Portal Service Layer
• Service Flow Manager
• GW Locator
• OSAM GW Adaptor Layer

Image Added

OSAM Core is responsible for taking the required actions from OSAM UI or OSS/BSS inputs. These actions are related to technology profile management, ONT/OLT management, topology management, fcaps and subscriber management. OSAM core applies set of actions to SEBA through OSAM GW.

• OSAM UI

Technology profile management, subscriber information, service activation for the subscriber, alarm/event monitoring, ONT/OLT management and monitoring are applied from UI. OSAM UI has fully interacted with Portal Service Layer which provides PNF information and data such as technology profiles, subscribers information, ONT devices information, and OSAM network topology. In other words, Portal Service Layer provides a backend for OSAM UI with its API and callback interfaces.

• OSAM DB

OSAM DB is responsible for storing OSAM related data such as: 

• • Subscriber information and its relation with PNF
  • Id, Ip and Location information are going to be stored for **PNF**
  • OSAM Gateway information 
  • PNF relation with OSAM gateway
  • OLT information and its relation with PNF
  • ONT information(Serial Number)
  • Technology profiles and their relationship with the subscriber
  • OSAM topology
  • Subscriber information with its relation with PNF and technology profile is going to be stored
  • Alarms, events, and metrics(will be fetched from ONAP)
• Portal Framework

Portal Framework is the backend for the OSAM UI and OSS/BSS. Provides APIs and callbacks to OSAM UI and OSS/BSS. Technology profile management, ONT/OLT management, subscriber management and subscriber's service purchase operations are conveyed from Portal Framework to Service Flow Manager. PNFs(SEBAs) information and their relation with OSAM gateways are collected from GW Locator to show on OSAM UI.

• Service Flow Manager

Service Flow Manager is the coordinator module for OSAM Core. Service Flow Manager can be triggered by Portal Framework or OSAM Gateway. It decides how the incoming/outgoing requests are going to be applied or conveyed. It applies requested set of actions to OSAM DB or OSAM GW Adaptor layer. Service Flow Manager uses OSAM DB for storing information or configurations related to subscriber, ont/olt or technology profile and creating the relationship between subscriber information and pnfId. OSAM GW Adaptor layer is used for sending the information to PNF.

• GW Locator

GW Locator is responsible for locating PNFs of OSAM gateway. PNFId plays a critical role for Service Flow Manager. Also, PNF information and its relation with OSAM gateway are saved by GW Locator. PnfId, OSAM Gateway ip address and user credentials for authentication plays a mandatory role for PNF storage in OSAM DB. OSAM GW Adaptor Layer can callback to GW Locator to store OSAM Gateway and connected PNFs relation.

• OSAM GW Adaptor Layer

OSAM GW Adapter Layer is the communication layer between OSAM Core and OSAM Gateway. It interacts with GW locator and OSAM GW API services. The interaction between OSAM Gateway and Adapter Layer needs to be bidirectional. GRPC protocol is a good candidate for this purpose.  Adapter Layer conveys registered technology profiles, subscriber information and ont registration. (Can be expanded more) to OSAM Gateway from Service Flow Manager. Osam Gateway Adapter layer learns osam gateway ip address from GW Locator using pnfId.

OSAM Gateway

OSAM Gateway is another VNF running near the SEBA pods that can be implemented within the POD as a local OSAM function. OSAM Gateway is a bridge between SEBA and OSAM core. 

In OSAM use case, every SEBA(PNF) pod must be matched with OSAM Gateway. OSAM Gateway can connect to multiple SEBA pods. SEBA's bridge gateway(OSAM GW) will be decided by ONAP side. OOF module chooses OSAM Gateway according to location input parameters in ONAP runtime.

Image Added

• OSAM Core Adaptor Layer

Provides a northbound interface to OSAM Core.

API interfaces should provide the following:

• Retrieve ONT devices for PnfId
• Retrieve OLT devices for PnfId
• Delete OLT device
• Disable ONT device
• Configure Access Node(OLT/ONT)
• Subscriber information and their statuses from PNF
• Telemetry data per Subscriber and SEBA pod
• Service Profile management(Ex: technology profile)

The callback should provide the following:

• ONT, OLT and subscriber alarms
• SEBA deregistration alarm
• ONT, OLT and subscriber events

• OSAM GW Coordinator

The coordinator is responsible to deliver NEM Adaptor requests to OSAM Core adaptor and vice versa. Moreover, it decides the callback action for PM requests(etc) from NEM adaptor Layer. Such as, if telemetry data is received from SEBA. It sends to Ves Agent. If SEBA register request is received, it stores the request in distributed cache and conveys the request to OSAM core via OSAM Core Adaptor Layer. Addition to that if any request is received from OSAM Core Adaptor Layer, converts to SEBA's GRPC

format and delivers the message to SEBA pod.

• Ves Agent

Delivers telemetry data to ONAP from Ves Agent. This module is also responsible for sending telemetry data for connected SEBA pods(PNFs) as well. 

• NEM Adaptor Layer

Connection point to SEBAs. It provides a GRPC callback and APIs to communicate with multiple SEBAs.

SEBA api interface should provide the following APIs:

• ConfigureTechnologyProfile
• ConfigureAlarms
• ConfigureAccessNode(AccessNode)
• AccessNode Inventory Information
• RetrieveAccessNodeInformation(AccessNode)
• RetrieveONTDevicesOfOLT(OLT)
• DeleteOLT
• DisableONT
• ActivateBroadbandServiceForSubscriber
• UpdateBroadbandServiceForSubscriber

SEBA callback interface should provide the following:

• RegisterPoD(Capabilities)
• DeregisterPoD
• RetrieveSubscriberPlan
• RequestServiceAccessForSubscriber(ONT_SerialNumber)
• RetrieveTelemetryData
• RetrievePerformanceMonitoringData
• RetrieveAlarms
• SEBA PoD Registration
• Broadband Service Activation

• Distributed Cache

Caches the PNFId, location and Ip address information. In any OSAM GW failure can recover each other by using distributed cache.

OSS/BSS

Technology service order for a user is done from OSS/BSS.

OSAM Design Time In ONAP

• OSAM Core and OSAM Gateway are going to onboard as a VNF. VNFD is needed to be prepared for each
• SEBA is going to be onboard as a PNF. PNFD is needed to be prepared.
• OSAM needs three services for working full functionally.
• OSAM Core VF resource will be used for OSAM Core service.
• OSAM Gateway VF resource will be used for OSAM Gateway service. (In other use-cases OSAM Gateway might be in the SEBA Pod)
• For SEBA service, SEBA PNF and OSAM Gateway as an alloted resource will be used.

Impacts:

ONAP Components: 

Since the OSAM use-case is similar to 5G use-case, most impacts will be common. However, some specific design materials (such as PNFD, VNFD, configuration ) will be different due to the nature of OSAM.

• Modeling/Models

Provide OSAM Core, OSAM Gateway, and SEBA specific models

Modeling will need to be added to describe how OSAM Core and OSAM Gateway VNFs are to be instantiated, removed, healed (restart, rebuild), scaled, how metrics related are gathered, how events are received.

Modeling will need to be added to describe the connection between OSAM Gateway and SEBA, plus  OSAM Gateway and OSAM Core.

• SDC

Design OSAM Gateway, OSAM Core and SEBA network service, TOSCA based. VNF and PNF templates will be provided by OSAM community
Design Auto-healing policy  for OSAM Core and OSAM Gateway
Design or provide ansible script for PNF

How does this project fit into the rest of the ONAP Architecture?.

• Access Management will leverage the PNF management approach and existing infrastructure components (AAI, DME, JSC, and Directed Graphs).
• Access Network Models, Flows and API’s will be developed as part of the project.  

How does this align with external standards/specifications?

• Alignment with the ONF, OpenAPI, BBF, IETF and ITU Standards

Are there dependencies with other open source projects?

• Integration with the VOLTHA and SEBA projects in ONF

Resources:

• Primary Contact Person: Sumithra Bhojan (sb4846@att.com) 
• Names, gerrit IDs, and company affiliations of the committers

Outlook Contact List
VCF Contact List

Committers:

...

• Names and affiliations of any other contributors
• Project Roles (include RACI chart, if applicable)

Other Information:

• link to seed code (if applicable)
• https://github.com/opencord
• Vendor Neutral
• Meets Board policy (including IPR)

...