From 780b2bff6684aa0b514088f9e291441692f29b3e Mon Sep 17 00:00:00 2001 From: maximesson Date: Tue, 12 Nov 2019 16:09:02 +0100 Subject: [PATCH] Documentation Non-RT RIC Change-Id: Ieab1859e26c874f48c35555c33a93f9f7ccb1b12 Issue-ID: NONRTRIC-47 Signed-off-by: maximesson --- .readthedocs.yaml | 14 ++--- docs/developer-guide.rst | 9 ++-- docs/installation-guide.rst | 77 ++------------------------- docs/overview.rst | 4 +- docs/release-notes.rst | 124 ++++---------------------------------------- 5 files changed, 27 insertions(+), 201 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index b45b11d2..095222ac 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -1,16 +1,16 @@ --- -version 2 +version: 2 formats: - - htmlzip + - htmlzip build: - image: latest + image: latest python: - version: 3.7 - install: - - requirements: docs/requirements-docs.txt + version: 3.7 + install: + - requirements: docs/requirements-docs.txt sphinx: - configuration: docs/conf.py + configuration: docs/conf.py diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index 36ac802d..63829e26 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -20,9 +20,8 @@ A1 Mediation: 1. SDNC Controller 2. Near-RT RIC Simulator -********************************** SDNC A1 Controller Developer Guide -********************************** +================================== This document provides a quickstart for developers of the O-RAN SC A1 Controller SDNC Application @@ -59,9 +58,8 @@ The SDNC url to access the Northbound API, Credentials: admin/Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U -************************************* Near-RT RIC Simulator Developer Guide -************************************* +===================================== Prerequisites ------------- @@ -83,9 +81,8 @@ The backend server listens for requests at this URL: The backend server publishes live API documentation at the URL http://localhost:8080/swagger-ui.html -*************** End-to-end call -*************** +=============== In order to make a complete end-to-end call, follow the instructions given in this `guide`_. diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst index f78a5eec..995f4ebd 100644 --- a/docs/installation-guide.rst +++ b/docs/installation-guide.rst @@ -15,6 +15,9 @@ Abstract This document describes how to install the Non-RT RIC dashboard, its dependencies and required system resources. +This work is in progress. For now, it is possible to use the Non-RT RIC dashboard. Please visit the `api-docs page`_ for more on how to deploy it and use it. + +.. _api-docs page: ./api-docs.html Version history @@ -22,7 +25,7 @@ Version history | **Date** | **Ver.** | **Author** | **Comment** | | | | | | +--------------------+--------------------+--------------------+--------------------+ -| 20XX-XX-XX | 0.1.0 | | First draft | +| 2019-11-12 | 0.1.0 | Maxime Bonneau | First draft | | | | | | +--------------------+--------------------+--------------------+--------------------+ | | 0.1.1 | | | @@ -34,76 +37,4 @@ Version history +--------------------+--------------------+--------------------+--------------------+ -Introduction ------------- - -.. - -.: - -This document describes the supported software and hardware configurations for the reference component as well as providing guidelines on how to install and configure such reference system. - -The audience of this document is assumed to have good knowledge in RAN network and Linux system. - - -Preface -------- -.. - -: - -Before starting the installation of , some planning must precede. - -.. note:any preperation you need before setting up sotfware and hardware - - -Hardware Requirements ---------------------- -.. - -: - -Following minimum hardware requirements must be met for installation of : - -+--------------------+----------------------------------------------------+ -| **HW Aspect** | **Requirement** | -| | | -+--------------------+----------------------------------------------------+ -| **# of servers** | | -+--------------------+----------------------------------------------------+ -| **CPU** | | -| | | -+--------------------+----------------------------------------------------+ -| **RAM** | | -| | | -+--------------------+----------------------------------------------------+ -| **Disk** | | -| | | -+--------------------+----------------------------------------------------+ -| **NICs** | | -| | | -| | | -| | | -| | | -| | | -+--------------------+----------------------------------------------------+ - - - -Software Installation and Deployment ------------------------------------- -.. - -: - -This section describes the installation of the installation on the reference hardware. - - - -References ----------- -.. - - - diff --git a/docs/overview.rst b/docs/overview.rst index 8c2e8161..df0966ca 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -52,6 +52,8 @@ Moreover, there are functional requirements regarding the A1 interface: 4. A1 interface shall support feedback from Near-RT RIC for monitoring AI/ML model performance. 5. A1 interface shall support the policy/intents feedback from Near-RT RIC to Non-RT RIC. +.. _a1_policy_procedure: + A1 policy procedure ------------------- @@ -69,4 +71,4 @@ As for A-release, the methods are as follows: | Delete policy | DELETE | | +---------------------+--------------------------+--------------------------+ | Notify policy | POST | POST | -+---------------------+--------------------------+--------------------------+ \ No newline at end of file ++---------------------+--------------------------+--------------------------+ diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 0359af41..14a24903 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -6,7 +6,7 @@ Release-Notes ============= -This document provides the release notes for of . +This document provides the release notes for Amber release of Non-RT RIC. .. contents:: :depth: 3 @@ -20,7 +20,7 @@ Version history | **Date** | **Ver.** | **Author** | **Comment** | | | | | | +--------------------+--------------------+--------------------+--------------------+ -| 20XX-XX-XX | 0.1.0 | | First draft | +| 2019-11-12 | 0.1.0 | Maxime Bonneau | First draft | | | | | | +--------------------+--------------------+--------------------+--------------------+ | | 0.1.1 | | | @@ -34,136 +34,32 @@ Version history Summary ------- - +For Amber release, there is only a dashboard available. Non-RT RIC does not support R-apps yet. +The Non-RT RIC is not yet fully compliant with the A1 specifications for this release. Find out which methods are available `here`_. +.. _here: a1_policy_procedure Release Data ------------ - -: - -+--------------------------------------+--------------------------------------+ -| **Project** | E.g. project | -| | | -+--------------------------------------+--------------------------------------+ -| **Repo/commit-ID** | E.g. genesis/adf634a0d4..... | -| | | -+--------------------------------------+--------------------------------------+ -| **Release designation** | E.g. Arno RC2 | -| | | +--------------------------------------+--------------------------------------+ -| **Release date** | E.g. 2015-04-16 | +| **Project** | Non-RT RIC | | | | +--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | | +| **Repo/commit-ID** | TBC | | | | +--------------------------------------+--------------------------------------+ - - - - -Feature Additions -^^^^^^^^^^^^^^^^^ - - -: - -**JIRA BACK-LOG:** - -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | +| **Release designation** | Amber | | | | +--------------------------------------+--------------------------------------+ -| | | -| | | +| **Release date** | 2019-XX-XX | | | | +--------------------------------------+--------------------------------------+ -| | | -| | | +| **Purpose of the delivery** | Introducing Non-RT RIC | | | | +--------------------------------------+--------------------------------------+ -Bug Corrections -^^^^^^^^^^^^^^^ - -**JIRA TICKETS:** - -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| | | -| | | -| | | -+--------------------------------------+--------------------------------------+ -| | | -| | | -| | | -+--------------------------------------+--------------------------------------+ - -Deliverables -^^^^^^^^^^^^ - -Software Deliverables -+++++++++++++++++++++ - - - - - -Documentation Deliverables -++++++++++++++++++++++++++ - - - - - - -Known Limitations, Issues and Workarounds ------------------------------------------ - -System Limitations -^^^^^^^^^^^^^^^^^^ - - - - -Known Issues -^^^^^^^^^^^^ - - -: - -**JIRA TICKETS:** - -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| | | -| | | -| | | -+--------------------------------------+--------------------------------------+ -| | | -| | | -| | | -+--------------------------------------+--------------------------------------+ - -Workarounds -^^^^^^^^^^^ - - - - - - -References ----------- - - - -- 2.16.6