Versions Compared

Old Version 29

changes.mady.by.user Benjamin Cheung

Saved on

compared with

New Version 30

changes.mady.by.user Benjamin Cheung

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The roadmap for CPS and what will be delivered in the upcoming releases:

Image RemovedImage Added

Updated C&PS ROADMAP  

...

C&PS 2.0 - C&PS 2.0 is the stand-alone project. In R8 Honolulu, the goal is to have C&PS become its own stand-alone project. Thus, a presentation to the Architecture S/C and TSC will be made again to petition for a stand-alone project.

Updated Roadmap:Image Removed



RELEASECONTENTWIKI
R6 Frankfurt
CONFIGURATION & PERSISTENCY SERVICE
R7 Guilin

Store Real-Time Configuration Data

Update Data

Access Control

Guilin release - functional requirements proposed list#RunTimeConfigurationDatabase/DataPersistencyServiceProject

Management framework (not mgmt policy to run network, ONAP mgmt policy)

Network Elements (config info, policy for NE, A1 for NE)

R8 Honolulu

Data Recovery

Model Adaptation (Dynamic Schema)


R-Future

Data Auditing

Topology Traversal

Data History

Roll-Back

Data Syncing

Performance Optimization (Scaling)


...

Use cases define how different users interact with a system under design.  Each use case represents an action that may be performed by a user (defined in UML as an Actor with a user persona).

Image Added

The R7 Model Driven C&PS PoC diagram:

Use Case Diagram Example.pngImage RemovedImage Added

Use Case Functional Definitions

Use Case Title

Title of the Use CaseCONFIGURATION & PERSISTENCY SERVICE

Actors (and System Components)

SDC, A&AI, C&PS, Use Cases (PCI, E2E NS, A1E, Mirror), DBMS, TSDB, xNF, DCAE, DMaaP

Description

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

Configuration & Persistency Service is a platform component that is designed to serve as a data repository for Run time data that needs to be persistent. It is characterized by the following.

    DATA REPOSITORY -  The types of data that is stored in the Run-Time data storage repository for:

  1.    CONFIGURATION PARAMETERS - These are configuration parameters that are used by xNFs during PnP, installation, commissioning.
  2.    OPERATIONAL PARAMETERS - These are parameters that are derived, discovered, computed that are used by xNFs during run time AFTER the xNF becomes operational i.e. AFTER it has "booted up", been installed, configured. These operational parameters are Exo-inventory information, meaning it is information that doesn't belong in A&AI.
  3.    NETWORK ELEMENT POLICY INFORMATION - NE policy type information used by micro-service.
  4.    APPLICATION INFORMATION - Information related to operational parameter.

    DATA LAKE - Architecturally, the Configuration & Persistency Service is designed to be a common services data layer which can serve as a data lake to other run time entities (ONAP components or external tools).

    C&PS FUNCTIONS - The Configuration & Persistency Service enables functionality to be performed by other entities. It will ENABLE the capability of another components or external tools within/or external to ONAP to perform the functions.

  •         CONFIGURATION MANAGEMENT FUNCTIONS - Enables OSS configuration, optimization, and LCM operations.
  •         SYNCING - The Configuration & Persistency Service enables the ability to sync data between initial and delta changes ONAP & the xNFs.
  •         DATA RECOVERY - It will allow for the recovery of data once a source of truth is defined.
  •         UPDATES - It will allow for updates, delta changes, and incremental updates to be performed.
  •         RESTORATION - It will allow for the recovery and restoration of data to a fall back point.
  •         DATA HISTORY - See a history of changes in data including versioning of the data, updates, roll back, restoration, and time series management.
  •         AUDITING - Auditing of parameters against a "golden" template. It itself stores & provides the data for auditing. Consistency checks.
  •         ROLL BACK - It will allow for rollback back to "save points" or recovery points.
  •         ACCESS CONTROL - A security topic, which allows the definition of policies, of who and what they can update.
  •         TOPOLOGY TRAVERSAL - It will enable the ability for something to traverse the relationship between data elements.
  •         MODEL ADAPTION - Allows for the adaptation or transformation of models from other sources (e.g. ORAN or 3GPP models).

Points of Contact

Use Case Lead: Benjamin Cheung  Tony Finnerty  Joanne Liu Rudel

Key Use Case Members: Toine Siebelink  user-4e793  theodore johnson

Code Contributors: (same as above)

Preconditions

DEPLOYMENT - The C&PS container/project is deployed and up and running.

AUTHENTICATION - Authentication is performed by C&PS to allow access and interaction with other ONAP platform components.

Triggers / Begins when

(See "Flow Step" for Design Time Activities, and Initial Database Setup below in the Steps/flows)

Steps / Flows (success)

Steps in Basic Operation and setup of C&PS.

SETUP FLOW STEPSETUP STEP DESCRIPTION
DESIGN TIME ACTIVITIES (SD&C) (SETUP)

(Design time), (Setup DB) Yang Model development ORAN specification Yang Model in line with 3GPP. SQL structure.

SDC CSAR LISTENER (SETUP)The C&PS project listens for the Service CSAR packages which contain the schemas for resources associated with those services.

INITIAL DATABASE SETUP

(Run Time)

The C&PS Database is initially setup.
INITIAL A&AI GETALL (SETUP)Initial A&AI Getall nodes is used to setup the existing xNFs that exist in the system
RUN-TIME OPERATIONRUN-TIME DESCRIPTION
(1) STND DEFINED VES UPDATE

(1) Standard defined VES event comes in through VES event, VES listener.

This is then published onto DMaaP and C&PS get for that topic, namespace 3GPP_Configuration to write updates to the C&PS Database.

Information coming into the C&PS via Stnd-Defined VES need to be "mapped" to the appropriate xNF and record.

(2) A&AI SYNCHRONIZATION

(2) A&AI Updates are made in order to update the existing xNF in the system

if a xNF is created or deleted the corresponding records in C&PS DB need to be created/deleted.

A&AI publishes onto DMaaP when an A&AI event occurs which updates the active xNFs available to the network.

(3) MICRO-SERVICE UPDATE(3) Micro-services can update information in C&PS DB

(4) ONAP PLATFORM

COMPONENT INTERACTIONS

(4a) Other ONAP platform components such as the controllers might read or write information into the C&PS DB.


(5) EXTERNAL ENTITIES (4b) External entities can interact with the C&PS DB through External API



Post-conditions

SETUP OF C&PS - C&PS database is setup with initial schema

RUN-TIME OPERATION OF C&PS - the above run-time types of actions/operations (1) - (4) above in the flow steps results in updates of C&PS or the interacting entity successfully retrieving information from C&PS DB.

Alternate / Exception Paths

The following describes error cases or conditions for each of the flow steps above:

SETUP FLOW STEPEXCEPTIONS / ALTERNATE / CORNER CASES / ERRORS
DESIGN TIME ACTIVITIES (SD&C) (SETUP)Problems in SD&C
SDC CSAR LISTENER (SETUP)

If the SDC CSAR package is irretrievable from DMaaP.

If there is an Error in the SDC CSAR package

INITIAL DATABASE SETUP

(Run Time)

YANG models, schema setup problems

Setting up the C&PS DB errors.

INITIAL A&AI GETALL (SETUP)

Inability to perform A&AI Getall

Errors in A&AI Getall

RUN-TIME OPERATIONEXCEPTIONS / ALTERNATE / CORNER CASES / ERRORS
(1) STND DEFINED VES UPDATE

Inability to get VES event from namespace DMaaP Bus

Errors within the Stnd-Def VES event

(2) A&AI SYNCHRONIZATION

Inability to perform A&AI Event update

Errors in A&AI Event Update

(3) MICRO-SERVICE UPDATE

Inability of micro-service to update C&PS DB

Errors in C&PS DB Update

(4A) ONAP PLATFORM COMPONENT

Inability of component to update C&PS DB

Errors in C&PS DB Update

(4B) EXTERNAL ENTITIES

Inability of entity to update C&PS DB

Errors in C&PS DB Update

Errors in API/interface interaction problem.


Related Use Cases

These are associated use cases or requirements depending on C&PS

Use CaseLink or Description
OOF SON PCI Use Case

The OOF SON PCI is a 5G RAN Wireless use case spanning R3 through R7 and beyond:

R7 OOF SON Use Case

End to End Network Slicing

E2E Network slicing is a 5G RAN Wireless application

E2E Network Slicing Use Case in R7 Guilin

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

...