Title of the Use CaseConfiguration Persistence SERVICE

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

Configuration Persistence 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.

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

Short overview of the Use Case

Authors and maintainers of the Use Case.

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

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

Includes description of Information Consumed

    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 Persistence 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).

    CPS FUNCTIONS - The Configuration Persistence 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 Persistence 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.
•         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 of entire DB to "save points" or recovery points.
•         RESTORATION - It will allow for the recovery and restoration of data records to a fall back point.
•         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

Use Case Lead: Benjamin Cheung  Tony Finnerty  Joanne Liu Rudel

Key Use Case Members: Toine Siebelink  Former user (Deleted)  johnsont

Code Contributors: (same as above)

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.

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

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

The expected results of the execution of the Use Case

Includes description of Information Produced

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

List of the Use Cases referenced by this Use Case

Describes any assumptions that are made for this use case

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

Steps in Basic Operation and setup of C&PS.

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) - (4A/B) above in the flow steps results in updates of C&PS or the interacting entity successfully retrieving information from C&PS DB.

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

These are associated use cases or requirements depending on CPS