docs/installation-guide.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. SPDX-License-Identifier: CC-BY-4.0
   3 .. Copyright (c) 2020 Samsung Electronics Co., Ltd. All Rights Reserved.
   4
   5
   6 Installation Guide
   7 ==================
   8
   9 .. contents::
  10    :depth: 3
  11    :local:
  12
  13 Abstract
  14 --------
  15
  16 This document describes how to install the HelloWorld (HW) Python xAPP.
  17
  18 Version history
  19
  20 +--------------------+--------------------+--------------------+--------------------+
  21 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
  22 |                    |                    |                    |                    |
  23 +--------------------+--------------------+--------------------+--------------------+
  24 | -                  |-                   |Rahul Banerji       | -                  |
  25 |                    |                    |                    |                    |
  26 +--------------------+--------------------+--------------------+--------------------+
  27
  28
  29 Introduction
  30 ------------
  31
  32 This document provides guidelines on how to install and configure the HW Python xAPP in various environments/operating modes.
  33 The audience of this document is assumed to have good knowledge in RIC Platform.
  34
  35
  36 Preface
  37 -------
  38 This xAPP can be run directly as a Linux binary, as a docker image, or in a pod in a Kubernetes environment.  The first
  39 two can be used for dev testing. The last option is how an xAPP is deployed in the RAN Intelligent Controller environment.
  40 This document covers all three methods.
  41
  42
  43
  44
  45 Software Installation and Deployment
  46 ------------------------------------
  47 The build process assumes a Linux environment with python >= 3.8  and  has been tested on Ubuntu. For building docker images,
  48 the Docker environment must be present in the system.
  49
  50
  51 Build Process
  52 ~~~~~~~~~~~~~
  53 The HW xAPP can be either tested as a Linux binary or as a docker image.
  54    1. **Linux binary**:
  55       TBD
  56
  57    2. **Docker Image**: From the root of the repository, run   *docker --no-cache build -t <image-name> ./* .
  58
  59
  60 Deployment
  61 ~~~~~~~~~~
  62 End to end deployment of `hw-python` can be referred at :
  63
  64   :ref: `Deployment Guide`.
  65
  66 Testing
  67 --------
  68
  69 Unit tests TBD