agent/yang/o-ran-sc-ric-xapp-desc-v1.yang

   1 module o-ran-sc-ric-xapp-desc-v1 {
   2     yang-version 1.1;
   3     namespace "urn:o-ran:ric:xapp-desc:1.0";
   4     prefix rxad;
   5
   6     organization
   7         "O-RAN Software Community";
   8     contact
   9         "www.o-ran.org";
  10     description
  11         "This module defines a generic xApp descriptor used for xApp lifecycle management
  12
  13         Copyright 2020 the O-RAN Alliance.
  14
  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
  18
  19         http://www.apache.org/licenses/LICENSE-2.0
  20
  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.";
  26
  27     revision 2020-01-29 {
  28         description
  29             "initial revision";
  30         reference
  31             "O-RAN-OAM-Interface-Specification (O1)";
  32     }
  33
  34     // LCM: Generic xApp descriptor passed to xApp Manager (or OCO) during xApp deployment/undeployment
  35     grouping xapp-descriptor {
  36         leaf name {
  37             type string;
  38             mandatory true;
  39             description
  40                 "Name of the xApp in helm chart";
  41         }
  42         leaf release-name {
  43             type string;
  44             description
  45                 "Name of the xapp to be visible in Kubernetes";
  46         }
  47         leaf version {
  48             type string;
  49             description
  50                 "The exact xapp helm chart version to install";
  51         }
  52         leaf namespace {
  53             type string;
  54             description
  55                 "Name of the namespace to which xApp is deployed in Kubernetes";
  56         }
  57         leaf override-file {
  58             type string;
  59             description
  60                 "JSON string of override file for 'helm install' command";
  61         }
  62         description
  63             "xApp descriptor";
  64     }
  65
  66     grouping xapp-status {
  67         leaf name {
  68             type string;
  69             description
  70                 "Name of the xApp in helm chart";
  71         }
  72         leaf status {
  73             type boolean;
  74             description
  75                 "The status of xApp: true=healthy false=not-healthy";
  76         }
  77         description
  78             "xApp health status";
  79     }
  80
  81     // Top-level (root) managed object
  82     container ric {
  83         container xapps {
  84             list xapp {
  85                 key "name";
  86                 uses xapp-descriptor;
  87                 description
  88                     "xApp descriptor";
  89             }
  90             description
  91                 "List of xApps to be managed";
  92         }
  93         container health {
  94             config false;
  95             list status {
  96                 key "name";
  97                 uses xapp-status;
  98                 description
  99                     "The status of xApp";
 100             }
 101             description
 102                 "State data of the xApps";
 103         }
 104         description
 105             "Root object for xApp management and status";
 106     }
 107 }