X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Finstallation-guide.rst;h=967f98336014c6a4acc2aa897018243f62bcf104;hb=refs%2Fchanges%2F30%2F6830%2F2;hp=ccbdbb2542e01e923efef776649d4edde8156127;hpb=811df74edb350c06c1878d09c519a88e1df42e92;p=ric-app%2Fhw-go.git diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst index ccbdbb2..967f983 100644 --- a/docs/installation-guide.rst +++ b/docs/installation-guide.rst @@ -15,16 +15,6 @@ Abstract This document describes how to install the reference HW-go xAPP. -Version history - -+--------------------+--------------------+--------------------+--------------------+ -| **Date** | **Ver.** | **Author** | **Comment** | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ -| - |- |Rahul Banerji | - | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ - Introduction ------------ @@ -37,7 +27,7 @@ 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. +This document covers all three methods. @@ -51,7 +41,7 @@ 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**: + 1. **Linux binary**: TBD 2. **Docker Image**: From the root of the repository, run *docker --no-cache build -t ./* . @@ -59,11 +49,12 @@ The HW-go xAPP can be either tested as a Linux binary or as a docker image. 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 +End to end deployment of `hw-go` can be referred at : + + :ref:`Deployment Guide`. + +Testing -------- Unit tests TBD