Use Case Title | CONFIGURATION & PERSISTENCY SERVICE |
Actors (and System Components) | SDC, A&AI, C&PS, Use Cases (PCI, E2E NS, A1E, Mirror), DBMS, TSDB, xNF, DCAE, DMaaP |
Description | 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: - CONFIGURATION PARAMETERS - These are configuration parameters that are used by xNFs during PnP, installation, commissioning.
- 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.
- NETWORK ELEMENT POLICY INFORMATION - NE policy type information used by micro-service.
- 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 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).
|
Points of Contact | |
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 STEP | SETUP 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 GetAll nodes is used to setup the existing xNFs that exist in the system | | RUN-TIME OPERATION | RUN-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 | (4A) ONAP PLATFORM COMPONENT INTERACTIONS | (4A) Other ONAP platform components such as the controllers might read or write information into the C&PS DB.
| | (4B) 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) - (4A/B) 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 STEP | EXCEPTIONS / 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 GetallGetAll Errors in A&AI GetallGetAll | | RUN-TIME OPERATION | EXCEPTIONS / 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
|
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 |
