From: subhash kumar singh Date: Fri, 26 Mar 2021 09:37:55 +0000 (+0530) Subject: Documentation stub for Hw-go X-Git-Tag: 1.0.1~12 X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=811df74edb350c06c1878d09c519a88e1df42e92;hp=e363aa9373212833d797ea7d91224b8b65df201d;p=ric-app%2Fhw-go.git Documentation stub for Hw-go Documentation stub for Hw-go. Signed-off-by: subhash kumar singh Change-Id: Ib3baa5fd811c49b107adc91b4565a7a0f7b34e5a --- diff --git a/docs/_static/logo.png b/docs/_static/logo.png new file mode 100644 index 0000000..c3b6ce5 Binary files /dev/null and b/docs/_static/logo.png differ diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..07032ac --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,7 @@ +from docs_conf.conf import * + +linkcheck_ignore = [ + 'http://localhost.*', + 'http://127.0.0.1.*', + 'https://gerrit.o-ran-sc.org.*' +] diff --git a/docs/conf.yaml b/docs/conf.yaml new file mode 100644 index 0000000..04b83fc --- /dev/null +++ b/docs/conf.yaml @@ -0,0 +1,3 @@ +--- +project_cfg: oran +project: ric-app-hw-go diff --git a/docs/favicon.ico b/docs/favicon.ico new file mode 100644 index 0000000..00b0fd0 Binary files /dev/null and b/docs/favicon.ico differ diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..b181d12 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,20 @@ +.. 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.Copyright (C) 2021 + + +Welcome to O-RAN SC HW-go Documentation +======================================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + overview.rst + release-notes.rst + installation-guide.rst + user-guide.rst + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` 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 ./* . + + +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 diff --git a/docs/overview.rst b/docs/overview.rst new file mode 100644 index 0000000..e9b350d --- /dev/null +++ b/docs/overview.rst @@ -0,0 +1,27 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. Copyright (c) 2020 Samsung Electronics Co., Ltd. All Rights Reserved.Copyright (C) 2020 + + + + +HW-go xAPP Overview +==================== + +This repository contains open-source code for a prototype HW-go xAPP for near real-time +RAN Intelligent Controller which makes use of go Xapp Framework. +This xAPP aims to provide basic implementation of : + +-E2, A1 interfaces interactions. + +-Read-write operations into a persistent storage. + +-xAPP Configuration management + +-RMR Health Check + +-xAPP Health Check + +-Raising alarms + +-Generating metrics diff --git a/docs/release-notes.rst b/docs/release-notes.rst new file mode 100644 index 0000000..2767101 --- /dev/null +++ b/docs/release-notes.rst @@ -0,0 +1,85 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. SPDX-License-Identifier: CC-BY-4.0 +.. Copyright (c) 2020 Samsung Electronics Co., Ltd. All Rights Reserved.Copyright (C) 2020 + + +Release Notes +============= + + +This document provides the release notes for the Dawn Release of the HW-go xAPP. + +.. contents:: + :depth: 3 + :local: + + +Version history +--------------- + ++--------------------+--------------------+--------------------------+--------------------+ +| **Date** | **Ver.** | **Author** | **Comment** | +| | | | | ++--------------------+--------------------+--------------------------+--------------------+ +| - | - | Subhash Kumar Singh | - | +| | | | | ++--------------------+--------------------+--------------------------+--------------------+ + + + +Summary +------- + +This release of the Python HW xAPP demonstrates the following: + +-E2, A1 interfaces interactions. + +-Read-write operations into a persistent storage. + +-xAPP Configuration management + +-RMR Health Check + +-xAPP Health Check + +-Raising alarms + +-Generating metrics + + +Release Data +------------ + ++--------------------------------------+--------------------------------------+ +| **Project** | RAN Intelligent Controller | +| | | ++--------------------------------------+--------------------------------------+ +| **Repo/commit-ID** | TBD | +| | | ++--------------------------------------+--------------------------------------+ +| **Release designation** | TBD | +| | | ++--------------------------------------+--------------------------------------+ +| **Release date** | TBD | +| | | ++--------------------------------------+--------------------------------------+ +| **Purpose of the delivery** | open-source golang Hello World xAPP | +| | | +| | | ++--------------------------------------+--------------------------------------+ + +Components +---------- + +TBD + + + + +Limitations +----------- +- The HW-go xAPP doesn't have any usecase in particular to display SDL capabilities. + +- The subscription process assumes, on sending subscription request results in valid subscription response. + +- The HW-go xAPP doesn't address any RIC usecase in particular. diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt new file mode 100644 index 0000000..09a0c1c --- /dev/null +++ b/docs/requirements-docs.txt @@ -0,0 +1,5 @@ +sphinx +sphinx-rtd-theme +sphinxcontrib-httpdomain +recommonmark +lfdocs-conf diff --git a/docs/user-guide.rst b/docs/user-guide.rst new file mode 100644 index 0000000..b666b23 --- /dev/null +++ b/docs/user-guide.rst @@ -0,0 +1,28 @@ +.. 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.Copyright (C) 2021 + +============================================================================================ +HW-go xAPP (golang) +============================================================================================ +-------------------------------------------------------------------------------------------- +User's Guide +-------------------------------------------------------------------------------------------- + +Introduction +============================================================================================ + +The RIC platform provides set of functions as part of xAPP golang Framework that the xAPPs can use to accomplish their tasks. +This xAPP is envisioned to provide python xAPP developers, examples of implementing these sets of functions. +Note, HW-go xAPP does not address/implement any RIC Usecases. + +HW-go xAPP Features +============================================================================================ + +RIC Platform provides many Frameworks, APIs and libraries to aid the development of xAPPs. All xAPPs will have some custom +processing functional logic core to the xApp and some additional non-functional platform related processing using +these APIs and libraries. This xAPP attempts to show the usage of such additional platform processing using xapp RIC framework APIs and libraries. + + +The HW-go xAPP demonstrates how a golang based xApp uses the A1, and E2 interfaces and persistent database read-write operations. +