The rApp Manager is a lifecycle management service for rApps. It gets the rApp as an ASD formatted package and lifecycle manages it based on it instance configuration. It uses ONAP ACM for lifecycle management operations and it integrates with other components for managing the rApp.
The ASD package contains the details required to create and integrate the required services/components. Each ASD package contains only one rApp and one rApp can have any number of rApp instances.
Source code repository : https://gerrit.o-ran-sc.org/r/gitweb?p=nonrtric%2Fplt%2Frappmanager.git;a=summary
rApp Data Model
The rApp Manager is integrated with the following components to support lifecycle managing the rApp.
Automation Composition Management (ACM) is a framework that supports Life Cycle Management of Automation Compositions. It supports deployment, monitoring, update and removal of Automation Compositions en-bloc, allowing users to manage their features, services, and capabilities as single logical units. More details about ACM can be found here.
ACM-R has the ability to support an unlimited number of participants and all the participants can be configured through the configuration in the rApp package.
List of participants used by rApp manager sample rApp.
- A1PMS Participant - It interacts with A1PMS of NONRTRIC. It is capable of lifecycle managing A1PMS service.
- Kserve Participant - It interacts with Kserve. It is capable of lifecycle managing Kserve inference service.
- Kubernetes Participant - It interacts with Helm/Kubernetes. It is capable of lifecycle managing Helm charts. It expects the helm charts to be available in the mentioned repository as it doesn't handle the helm chart creation in the chart repository.
- DME Participant - It interacts with DME(ICS) of NONRTRIC. It is capable of lifecycle managing DME entities.
ACM composition and instance details can be provided as part of the rApp package and the package structure can be found here.
The DME(Information Coordination Service (ICS)) is a generic service that maintains data subscriptions. Its main purpose is to decouple data consumers and data producers in a multi vendor environment. A data consumer does not need to know anything about the producers of the data. More details about DME can be found here.
It is integrated with rApp manager to enable the rApp to produce/consume specific type of data(Information Type in DME terms).
Information type, and Data producer/consumer information can be provided as part of rApp package and the package structure can be found here.
The CAPIF stands for Common API framework and it was developed by 3GPP to enable a unified Northbound API framework across 3GPP network functions, and to ensure that there is a single and harmonized approach for API development. More details about SME can be found here.
It is integrated with rApp manager to enable the rApp to expose/access/discover endpoints.
Service exposure/access related configurations can be provided as part of rApp package and the package structure can be found here.
The rApp lifecycle contains 4 states. The state and transitions are as follows,
rApp Instance States
The rApp Instance lifecycle contains 4 states. The state and transitions are as follows,
rApp Instance flow
Create rApp Instance
Deploy rApp Instance
Undeploy rApp Instance
Delete rApp Instance
Sample rApp package structure
This packaging structure is a prototype and subject to change
The sample rApp package structure shown below and the location of relevant files for each integration is provided.
CSAR File Generation
CSAR file generator is available in the rAppmanager repository here (i-release).
"rappmanager/csar-generator/resources" folder contains the resources to build the rApp package.
The contents of the "resources" directory can be modified as required and the package can be generated as shown below,
This will generate a package named "rapp.csar". It can be renamed as required.
This generated package can be used with rApp Manager to create rApp.
The scripts for the deployments of rApp Manager and its dependent components are available here (i-release).
These scripts are specifically designed for a fresh environment. Some tweaks may be required to run these in an environment where there are some existing installations
- Kubernetes Cluster (V1.24.6)
The installation scripts shown here installs all the required components.
ACM components should be configured with couple of other components for the participants to work.
In case some of the installation is already setup or not set by the installation scripts, the below environment variables can be used to set the configurations ACM through installation scripts.
Ignore the below variables if the entire environment is being setup by the following installation scripts
Address of the A1PMS.
It will be accessed from A1PMS participant.
Address of the chart repository.
It will be used by Kubernetes participant.
IP_ADDRESS: IP of the host in which
the installation scripts are running.
All components can be installed using the command below,
Individual components can be installed using the commands below,
To install the tools required for other installer scripts.
To install the ACM, and it's related components.
To install the Kserve, and it's related components.
To installs the NONRTRIC components.
The below components should be up and running for the rApp Manager integrations to work properly.
Cert Manager components
- If Kserve installation failed or end up in the below state after "install-all.sh", Try run "patch-kserve.sh" script after "install-all.sh"
To uninstall all the components