README.md

   1 # O-RAN-SC Hello World Xapp in Python
   2
   3 This repository contains open-source code for a prototype python xAPP for near real-time
   4 RAN Intelligent Controller which makes use of python Xapp Framework.
   5
   6 This xAPP aims to provide basic implementation of :
   7
   8 1. A1 interfaces interactions
   9
  10 2. Read-write operations into a persistent storage.
  11
  12 3. xAPP Configuration management
  13
  14 4. RMR Health Check
  15
  16 5. xAPP SDL Check
  17
  18 6. Raising alarms
  19
  20 7. Generating metrics (TBD)
  21
  22 8. E2 Interface intereactions (TBD)
  23
  24
  25 Introduction
  26 ------------
  27
  28 This document provides guidelines on how to install and configure the HW Python xAPP in various environments/operating modes.
  29 The audience of this document is assumed to have good knowledge in RIC Platform.
  30
  31
  32 Preface
  33 -------
  34 This xAPP can be run directly as a Linux binary, as a docker image, or in a pod in a Kubernetes environment.  The first
  35 two can be used for dev testing. The last option is how an xAPP is deployed in the RAN Intelligent Controller environment.
  36 This covers all three methods.
  37
  38 1. Docker
  39
  40 2. Linux Binary
  41
  42 3. Kubernetes
  43
  44
  45 :
  46 Software Installation and Deployment
  47 ------------------------------------
  48 The build process assumes a Linux environment with python >= 3.8  and  has been tested on Ubuntu. For building docker images,
  49 the Docker environment must be present in the system.
  50
  51
  52 ##Build Process
  53
  54 The HW xAPP can be either tested as a Linux binary or as a docker image.
  55    1. **Linux binary**:
  56       TBD
  57
  58    2. **Docker Image**: From the root of the repository, run   *docker --no-cache build -t <image-name> ./* .
  59
  60
  61 ##Deployment
  62
  63 **Invoking  xAPP docker container directly** (not in RIC Kubernetes env.):
  64         One can include the pod.yaml for including it in k8s build. Replace the image name with one built.
  65         TBD: Adding hw-python to nexus repo
  66
  67
  68 Testing
  69 --------
  70
  71 Unit tests TBD
  72
  73
  74 ## License
  75
  76 ```
  77
  78    Copyright (c) 2020 Samsung Electronics Co., Ltd. All Rights Reserved.
  79
  80    Licensed under the Apache License, Version 2.0 (the "License");
  81    you may not use this file except in compliance with the License.
  82    You may obtain a copy of the License at
  83
  84        http://www.apache.org/licenses/LICENSE-2.0
  85
  86    Unless required by applicable law or agreed to in writing, software
  87    distributed under the License is distributed on an "AS IS" BASIS,
  88    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  89    See the License for the specific language governing permissions and
  90    limitations under the License.
  91
  92 ```