ASD PoC Use Cases & Requirements

Owned by Byung-Woo Jun
Last updated: Oct 19, 2021
4 min read

****** Note: PoC use cases & requirements for the Jakarta release ******

Use Case Overview & Description

The goal here is to enhance the ONAP CNF platform to support 1) Application Service Descriptor (ASD) CNF modeling specification, packaging, onboarding, design and orchestration. The PoC requirements want to prove how the ONAP platform does support ASD-aligned CNF provisioning, installation, configuration, update and monitoring. 

ASD Specification and Packaging Goals

ASD is a common, simplified deployment descriptor for ONAP, O-RAN (NFs, xApps and rApps) aiming to:

  • Quickly leverage enhancements in Kubernetes while minimizing development and integration efforts

  • Avoid duplication of attributes/properties included in Helm Charts

  • Descriptor format is not requiring a particular deployment tool(e.g., Helm)

  • Leverage established packaging standards (e.g., SOL004 with ASD as a top-level deployment artifact)

ASD PoC Goals for Jakarta

  • ASD onboarding to SDC, including:

    • Allow SDC designers to customize/add custom properties ? e.g., defining input parameters, adding custom properties...

    • Store original vendor packages

    • Store enhanced ASD descriptors

    • Transforming onboarding ASD packages into internal ASD model

      • Proposal: use the ASD model as SDC internal model

  • SDC Resource and Service Design with ASD-aligned CNF resources

  • SDC distribution to ONAP Runtime components

    • Store enhanced/internal ASD Descriptors in Catalog Manager

    • Store Helm Charts in Helm Chart Repository

    • Store Images in Image Repository

  • Model-driven Orchestration for ASD-aligned models

    • Dispatch workflows (CNF Manager) based on models and requests

    • Demonstrate how ASD, input parameters and Helm Charts are processed by the CNF Manager

      • Resolve K8 resources based on input parameters and Cloud Artifacts

      • Get placement decisions by leveraging ONAP platform capabilities

      • Deploy ASD-aligned CNF to Kubernetes

Use Case Key Information

TOPIC

DESCRIPTION

WIKI PAGE

Requirements Proposal

This is a link to the requirements proposal made on the Requirements Sub-committee



Architecture S/C info

Information on the Architecture sub-committee presentation



Prior Project "Base" Wiki

Link to the "base" wiki for the Use Case, or work from a prior release.

TOSCA Defined Control Loop PoC in ONAP Rel G and in Rel H

Requirements Jira (REQ-###) Ticket

Link to the REQ Jira ticket for this use case



Key Use Case Leads & Contacts

USE CASE LEAD:  @Byung-Woo Jun (Ericsson), @Marian Darula (Ericsson), @Thinh Nguyenphu (Unlicensed) (Nokia)

USE KEY CONTACTS: @Byung-Woo Jun (Ericsson), @Marian Darula (Ericsson), @Thinh Nguyenphu (Unlicensed) (Nokia)



Meetings Register & Recordings

Link to Use Case Team meetings, Orchestration Scenarios



BUSINESS DRIVER

Executive Summary - We would like to enhance the ONAP orchestration platform to support ASD-aligned modeling and pacaking onboarding, design, distribution, deployment and configuration.

Business Impact - Enables operators and service providers to design and onboard their CNF models and packaging, and to orchestrate their CNFs by leveraging open-source cloud native tools

Business Markets - All operators and service providers that are using ONAP for CNF automation.

Funding/Financial Impacts - Reduction in operations expense from using simplified CNF modeling and standard packaging.  Reduction in capital expense from vendors using a simplified modeling and standard packaging methodology.

Organization Mgmt, Sales Strategies - There is no additional organizational management or sales strategies for this requirement outside of a service providers "normal" ONAP deployment and its attendant organizational resources from a service provider. 

Development Status

PROJECT

PTL

User Story / Epic

Requirement

A&AI

@William Reehil





AAF

@Jonathan Gathman





APPC

@Takamune Cho





CLAMP

@Gervais-Martial Ngueko





CC-SDK

@Dan Timoney





CPS

@Toine Siebelink





DCAE

@Vijay Kumar





DMaaP

@Mandar Sawant (Old) → @Fiachra Corcoran (New)





External API

@Adrian OSullivan





HOLMES

@Guangrong Fu





MODELING

@Hui Deng





Multi-VIM /

Cloud

@Bin Yang





OOF

@krishna moorthy





OOM

@Sylvain Desbureaux





POLICY

@James Hahn





PORTAL

@Sunder Tattavarada





SDN-C

@Dan Timoney





SDC

@Michael Morris 

x



SO

@Seshu Kumar Mudiganti

x



VID

@Ikram Ikramullah





VF-C

@Yuanhong Deng





VNFRQTS

@Steven wright





VNF-SDK

@victor gao (Old) →

@Former user (Deleted)  (New)





CDS

@Yuriy Malakov







USE CASE DIAGRAM



Use Case Functional Definitions

Use Case Title

Title of the Use Case

Actors (and System Components)

The list of Actors and System Components that participate in the Use Case

Description

Short overview of the Use Case

Points of Contact

Authors and maintainers of the Use Case.

Use Case Lead, Key Use Case members and code contributors.

Preconditions

A list of conditions that are assumed to be true before the Use Case is invoked

Includes description of Information Consumed

Triggers / Begins when

Describes the trigger for beginning the Use Case

Steps / Flows (success)

Describes the sequence of steps and interactions that occur during the Use Case (may include: description, data exchanges, functionality, state changes)

Interaction diagrams may be included or referenced

Post-conditions

The expected results of the execution of the Use Case

Includes description of Information Produced

Alternate / Exception Paths

Description of any exceptions or special process that could occur during Use Case

Related Use Cases

List of the Use Cases referenced by this Use Case

Assumptions

Describes any assumptions that are made for this use case

Tools / References / Artifacts

List of any tools or reference material associated with this Use Case as well as any JIRA trace-ability.

List of any associated diagrams or modelling artifacts associated with the Use Case



component

Impact description

JIRA Tickets



component

Impact description

JIRA Tickets



SDC

ASD Package Format with Helm Charts

  • Identify current VNF/CNF package format constraints in SDC

  • Propose an ASD package format

Package Mapping

  • onboarding ASD package to internal ASD package mapping

ASD Mapping

  • onboarding ASD to internal ASD mapping

  • a new flow to map ASD to SDC AID model

Artifact Management

  • Design-time catalog update to associate artifacts to an ASD

  • Run0time catalog update to associate artifacts to a PNF

Helm Chart Management

  • Extract Helm charts and store them to the target Helm Repository

Image Management

  • Extract Images and store them to the target Image Repository





SO

ASDC_Handler

  • Based on the ASD Resource Type, handle the Catalog DB storage management differently

SO Workflow

  • Create/Manage Service including ASD-based CNFs

  • Process Model Info & decide flows

  • ...







SO-CNFM

CNF Manager





AAI

Schema update

Interface update as needed





Administration

Configure K8S Cluster

  • Register/Add K8S cluster to AAI

Note: auto discovery of K8S Cluster is a stretch goal













TESTING

Current Status

  1. Testing Blockers

  2. High visibility bugs

  3. Other issues for testing that should be seen at a summary level

  4. Where possible, always include JIRA links



End to End flow to be Tested

**This should be a summary level Sequence diagram done in Gliffy** 



Test Cases and Status



1

There should be a test case for each item in the sequence diagram

NOT YET TESTED

2

create additional requirements as needed for each discreet step

COMPLETE

3

Test cases should cover entire Use Case

PARTIALLY COMPLETE





Reference