1 module o-ran-sc-ric-xapp-desc-v1 {
3 namespace "urn:o-ran:ric:xapp-desc:1.0";
7 "O-RAN Software Community";
11 "This module defines a generic xApp descriptor used for xApp lifecycle management
13 Copyright 2020 the O-RAN Alliance.
15 Licensed under the Apache License, Version 2.0 (the 'License');
16 you may not use this file except in compliance with the License.
17 You may obtain a copy of the License at
19 http://www.apache.org/licenses/LICENSE-2.0
21 Unless required by applicable law or agreed to in writing, software
22 distributed under the License is distributed on an 'AS IS' BASIS,
23 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
24 See the License for the specific language governing permissions and
25 limitations under the License.";
31 "O-RAN-OAM-Interface-Specification (O1)";
34 // LCM: Generic xApp descriptor passed to xApp Manager (or OCO) during xApp deployment/undeployment
35 grouping xapp-descriptor {
40 "Name of the xApp in helm chart";
45 "Name of the xapp to be visible in Kubernetes";
50 "The exact xapp helm chart version to install";
55 "Name of the namespace to which xApp is deployed in Kubernetes";
60 "JSON string of override file for 'helm install' command";
65 "configuration of the xapp";
71 typedef health-status {
75 "The health status not available";
79 "The xApp is healthy";
83 "The xApp is not healthy";
90 grouping xapp-status {
94 "Name of the xApp visible in Kubernetes";
99 "The status of the xApp pod: running, restarted, etc";
104 "The health status of xApp: healthy, not-healthy, unavailable";
107 "xApp health status";
110 // Top-level (root) managed object
115 uses xapp-descriptor;
120 "List of xApps to be managed";
128 "The status of xApp";
131 "State data of the xApps";
133 container configuration {
138 uses xapp-descriptor;
143 "List of xApps for which config to be extracted";
146 "config get data of the xApps";
149 "Root object for xApp management and status";