Documentation stub for Hw-go
Documentation stub for Hw-go.
Signed-off-by: subhash kumar singh <subh.singh@samsung.com>
Change-Id: Ib3baa5fd811c49b107adc91b4565a7a0f7b34e5a
diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst
new file mode 100644
index 0000000..ccbdbb2
--- /dev/null
+++ b/docs/installation-guide.rst
@@ -0,0 +1,69 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+.. Copyright (c) 2021 Samsung Electronics Co., Ltd. All Rights Reserved.
+
+
+Installation Guide
+==================
+
+.. contents::
+ :depth: 3
+ :local:
+
+Abstract
+--------
+
+This document describes how to install the reference HW-go xAPP.
+
+Version history
+
++--------------------+--------------------+--------------------+--------------------+
+| **Date** | **Ver.** | **Author** | **Comment** |
+| | | | |
++--------------------+--------------------+--------------------+--------------------+
+| - |- |Rahul Banerji | - |
+| | | | |
++--------------------+--------------------+--------------------+--------------------+
+
+
+Introduction
+------------
+
+This document provides guidelines on how to install and configure the HW-go xAPP in various environments/operating modes.
+The audience of this document is assumed to have good knowledge in RIC Platform.
+
+
+Preface
+-------
+This xAPP can be run directly as a Linux binary, as a docker image, or in a pod in a Kubernetes environment. The first
+two can be used for dev testing. The last option is how an xAPP is deployed in the RAN Intelligent Controller environment.
+This document covers all three methods.
+
+
+
+
+Software Installation and Deployment
+------------------------------------
+The build process assumes a Linux environment with go >= 1.15 and has been tested on Ubuntu. For building docker images,
+the Docker environment must be present in the system.
+
+
+Build Process
+~~~~~~~~~~~~~
+The HW-go xAPP can be either tested as a Linux binary or as a docker image.
+ 1. **Linux binary**:
+ TBD
+
+ 2. **Docker Image**: From the root of the repository, run *docker --no-cache build -t <image-name> ./* .
+
+
+Deployment
+~~~~~~~~~~
+**Invoking HW-go xAPP docker container directly** (not in RIC Kubernetes env.):
+ One can include the pod.yaml for including it in k8s build. Replace the image name with one built.
+ TBD: Adding HW-go xAPP to nexus repo
+
+Testing
+--------
+
+Unit tests TBD