...
- Proposed name for the project:
RunTimeConfigDB
ConfigPersistencySvc
- Proposed name for the repository:
RunTimeConfigDB
ConfigPersistencySvc
PROJECT DESCRIPTION
The RunTime Config DB 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. The RunTime Config DB It is characterized by the following purpose statements:
PURPOSE OF RUNTIME CONFIG DBCONFIGURATION & PERSISTENCY SERVICE:
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 installation & commissioning. Configuration parameters are typically used before the xNF has been brought up or is operational. For example, a 5G Network configuration parameter for a PNFs that sets the mechanical tilt which is a configuration setting upon installation.
(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, configur. For example, in 5G Network, 5G PNFs may need to adjust a tower electrical antenna tilt. These operational parameters are Exo-inventory information, meaning it is information that doesn't belong in A&AI. In principle, some parameters might be both configuration and operational parameters depending on how they are used.
- (3) POLICY INFORMATION - This type of information stores policy information that orchestrates how ONAP shall operate. For example, Policy, CLAMP Control Loops, and Operational View type information.
- (4) APPLICATION INFORMATION - Information related to operational parameter.
- DATA LAKE - Architecturally, the RunTime Config DB 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).
- ENABLED FUNCTION - The RunTime Config DB 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 RunTime Config DB 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 - It will allow an operator to see a history of changes in data. This will includes the versioning of the data, which is also associated with updates, roll back, restoration.
- AUDITING - It will allow for auditing of configuration and parameters against a "golden" template. It itself stores & provides the data for another thing to perform the 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 - Depending on the schemas used to define the DB data elements; it allows for the adaptation or transformation of models from other sources (e.g. ORAN or 3GPP models).
- Configuration Management FUNCTIONS - Enables OSS configuration, optimization, and LCM operations.
- CENTRAL/DISTRIBUTED - Because it is a common service, it is part of an ONAP installation, so it could be deployed with either an Edge ONAP installation or a centralized ONAP installation. The DB shall be designed to accommodate distributed operation as part of its role in the ONAP installation.
...
Functionality supported by a RunTime Config DB Configuration & Persistency Service
The Configuration & Persistency Service The RunTime Config DB does several functions:
- RECEIVE INFORMATION - This is the ability to receive information from a source, for example DMaaP, which contains information that needs to be incorporated into the data base.
- WRITE INFORMATION - Configuration, operational and policy information is written into the database. Data received is written to the database via database write operations.
- PUBLISH CHANGES - When changes occur to the database, it shall have the capability to publish changes. This will take the form of notifications on the DMaaP bus to allow other subscribers to become aware of changes.
- REFERENTIAL INTEGRITY - When element updates occur, the component shall be able to maintain referential integrity. If elements are removed from the database, then associations or connections between elements may change and need to be updated.
- INGEST PACKAGES - SDC CSAR parser - Get SDC CSAR Service Package - getting key artifacts from vendor provided onboarded packages (CSAR).
- LOGICAL OBJECTS - The database shall support logical objects that are not PNFs, VNFs, or ANFs. These are objects that are elements that may logically represent entities that may need to be kept track of. An example might be a cell (carrier-sector) within a wireless RAN network.
- ASSOCIATIONS - These are "linkages" between elements within elements (or data records) in the database. So this database is a relational database in the connective sense of a relational database (as opposed to the composition sense of a relational database).
- CARDINALITY RULES - This allows for the specification of a cardinality of element associations.
- LINKING RESTRICTIONS - There may be rules which allow you to specify restrictions on the kind of associations that can be made.
- SYNCHRONIZATION - Real-time Synchronization allows for the database to reflect the state of the network. This also includes syncing with A&AI elements. A&AI is a real-time view of the resources and services available to ONAP to use. Thus, when a xNF gets created or deleted, these changes must be reflected also in the database.
- HEURISTICS ACCESS RULES - There could be some rules or heuristics to allow particular data to be written and to control access, and who may have access.
- DATA INTEGRITY & RECOVERY - within scope of the project are aspects of integrity & recovery such as data recovery, backup & export, restoration, database roll-back and data history
SEED CODE
RunTime Config DB Configuration & Persistency Service code will be based on seed code implementing the design tool and cockpit.
...
SHARED SERVICE - The diagram below shows how the RunTime Config DB the Configuration & Persistency Service project fits into the overall ONAP architecture as a shared (common) service serving as a data layer for other ONAP components.
A&AI INDEPENDENCE - The RunTime Config DB The Configuration & Persistency Service stores information that is conceptual distinct from A&AI. The data is related because the DB also needs to keep track of the existence of xNFs; and A&AI is the master of resources & services. For more information about how information from A&AI is "synced" with the RunTime Config DB the Configuration & Persistency Service see the Operational Description section below.
DATA LAYER - Architecture conclusions is that this component should serve as a data layer to other components and be a data lake serving as a repository for storing run-time information. It shall also be within the shared services part of the architecture. Architecture concluded that this project should be an independent component in ONAP platform.
SCOPE (Type of Info Stored) - The type of information stored in the RunTime Config DB the Configuration & Persistency Service is run-time configuration, operational, and policy information.
ARCHITECTURE CONSISTENCY - The project is consistent with a data-centric ONAP architecture.
...
ASSOCIATIONS - These are "linkages" between elements within elements (or data records) in the database. Thus, this database is a relational database in the connective sense of a relational database (as opposed to the composition sense of a relational database).
CARDINALITY RULES - This allows for the specification of a cardinality of element associations. For example, one PNF might have a limit to the number of associated logical elements, such as a Logical Cell that it is allowed to have.
LINKING RESTRICTIONS - There may be rules which allow a operator to specify restrictions on the kind of associations that can be made. For example, an operator might want a particular kind of PNF to link to a specific kind of Logical object, such as a cell.
- DATA LAYER - This project is meant to serve as a data layer to other ONAP components. This means that it will be an intermediary for a component to write and access data.
- PERSISTENCY - The Runtime Config DB The Configuration & Persistency Service is meant to store data persistently, which means that it can hold data over time without losing it.
- SYNCHRONIZATION - The concept of synchronization is the ability to align data between the database and something else, such as an external source, or a xNF. For example, the RunTime Config DB the Configuration & Persistency Service needs to synchronize to A&AI view of the available resources in the system. See the section on Synchronization below.
- STORAGE vs OWNERSHIP - The Database STORES data, provides persistency, and gives access to data. The information is created, defined and used by other ONAP components. The OWNERSHIP and life cycle management is the responsibility of that other ONAP component. The DB stores the data but does not own the data. The result is that other ONAP components can freely access that data without other components creating new APIs. Thus, components don't have to have own data rather the database serves as steward of the data.
- ACCESS CHARACTERISTICS - Historical data and current data do not necessarily share the same characteristics & requirements. There might be multiple data base technologies that underlie the operation of the service.
...