Documentation Non-RT RIC
Change-Id: Ieab1859e26c874f48c35555c33a93f9f7ccb1b12
Issue-ID: NONRTRIC-47
Signed-off-by: maximesson <maxime.bonneau@est.tech>
diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst
index 36ac802..63829e2 100644
--- a/docs/developer-guide.rst
+++ b/docs/developer-guide.rst
@@ -20,9 +20,8 @@
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 @@
Credentials: admin/Kp8bJ4SXszM0WXlhak3eHlcse2gAw84vaoGGmJvUy2U
-*************************************
Near-RT RIC Simulator Developer Guide
-*************************************
+=====================================
Prerequisites
-------------
@@ -83,9 +81,8 @@
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 f78a5ee..995f4eb 100644
--- a/docs/installation-guide.rst
+++ b/docs/installation-guide.rst
@@ -15,6 +15,9 @@
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 @@
| **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 @@
+--------------------+--------------------+--------------------+--------------------+
-Introduction
-------------
-
-.. <INTRODUCTION TO THE SCOPE AND INTENTION OF THIS DOCUMENT AS WELL AS TO THE SYSTEM TO BE INSTALLED>
-
-.<EXAMPLE>:
-
-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
--------
-.. <DESCRIBE NEEDED PREREQUISITES, PLANNING, ETC.>
-
-<EXAMPLE>:
-
-Before starting the installation of <project name>, some planning must precede.
-
-.. note:any preperation you need before setting up sotfware and hardware
-
-
-Hardware Requirements
----------------------
-.. <PROVIDE A LIST OF MINIMUM HARDWARE REQUIREMENTS NEEDED FOR THE INSTALL>
-
-<EXAMPLE>:
-
-Following minimum hardware requirements must be met for installation of <project name>:
-
-+--------------------+----------------------------------------------------+
-| **HW Aspect** | **Requirement** |
-| | |
-+--------------------+----------------------------------------------------+
-| **# of servers** | |
-+--------------------+----------------------------------------------------+
-| **CPU** | |
-| | |
-+--------------------+----------------------------------------------------+
-| **RAM** | |
-| | |
-+--------------------+----------------------------------------------------+
-| **Disk** | |
-| | |
-+--------------------+----------------------------------------------------+
-| **NICs** | |
-| | |
-| | |
-| | |
-| | |
-| | |
-+--------------------+----------------------------------------------------+
-
-
-
-Software Installation and Deployment
-------------------------------------
-.. <DESCRIBE THE FULL PROCEDURES FOR THE INSTALLATION OF THE O-RAN COMPONENT INSTALLATION AND DEPLOYMENT>
-
-<EXAMPLE>:
-
-This section describes the installation of the <project name> installation on the reference hardware.
-
-
-
-References
-----------
-.. <PROVIDE NEEDED/USEFUL REFERENCES>
-
-
-
diff --git a/docs/overview.rst b/docs/overview.rst
index 8c2e816..df0966c 100644
--- a/docs/overview.rst
+++ b/docs/overview.rst
@@ -52,6 +52,8 @@
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 @@
| 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 0359af4..14a2490 100644
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -6,7 +6,7 @@
=============
-This document provides the release notes for <RELEASE> of <COMPONENT>.
+This document provides the release notes for Amber release of Non-RT RIC.
.. contents::
:depth: 3
@@ -20,7 +20,7 @@
| **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 @@
Summary
-------
-<SUMMARIZE THE RELEASE - THE CONTENT - AND OTHER IMPORTANT HIGH LEVEL PROPERTIES>
+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
------------
-<STATE RELEVANT RELEASE DATA/RECORDS>
-
-<EXAMPLE>:
+--------------------------------------+--------------------------------------+
-| **Project** | E.g. project |
+| **Project** | Non-RT RIC |
| | |
+--------------------------------------+--------------------------------------+
-| **Repo/commit-ID** | E.g. genesis/adf634a0d4..... |
+| **Repo/commit-ID** | TBC |
| | |
+--------------------------------------+--------------------------------------+
-| **Release designation** | E.g. Arno RC2 |
+| **Release designation** | Amber |
| | |
+--------------------------------------+--------------------------------------+
-| **Release date** | E.g. 2015-04-16 |
+| **Release date** | 2019-XX-XX |
| | |
+--------------------------------------+--------------------------------------+
-| **Purpose of the delivery** | |
+| **Purpose of the delivery** | Introducing Non-RT RIC |
| | |
+--------------------------------------+--------------------------------------+
-
-Feature Additions
-^^^^^^^^^^^^^^^^^
-<STATE ADDED FEATURES BY REFERENCE TO JIRA>
-
-<EXAMPLE>:
-
-**JIRA BACK-LOG:**
-
-+--------------------------------------+--------------------------------------+
-| **JIRA REFERENCE** | **SLOGAN** |
-| | |
-+--------------------------------------+--------------------------------------+
-| | |
-| | |
-| | |
-+--------------------------------------+--------------------------------------+
-| | |
-| | |
-| | |
-+--------------------------------------+--------------------------------------+
-
-Bug Corrections
-^^^^^^^^^^^^^^^
-
-**JIRA TICKETS:**
-
-+--------------------------------------+--------------------------------------+
-| **JIRA REFERENCE** | **SLOGAN** |
-| | |
-+--------------------------------------+--------------------------------------+
-| | |
-| | |
-| | |
-+--------------------------------------+--------------------------------------+
-| | |
-| | |
-| | |
-+--------------------------------------+--------------------------------------+
-
-Deliverables
-^^^^^^^^^^^^
-
-Software Deliverables
-+++++++++++++++++++++
-
-<STATE WHAT SOFTWARE DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
-
-
-
-Documentation Deliverables
-++++++++++++++++++++++++++
-
-<STATE WHAT DOCUMENTATION DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
-
-
-
-
-Known Limitations, Issues and Workarounds
------------------------------------------
-
-System Limitations
-^^^^^^^^^^^^^^^^^^
-<STATE ALL RELEVANT SYSTEM LIMITATIONS, IF THERE IS ANY>
-
-
-
-Known Issues
-^^^^^^^^^^^^
-<STATE ALL KNOWN ISSUES WITH JIRA REFERENCE>
-
-<EXAMPLE>:
-
-**JIRA TICKETS:**
-
-+--------------------------------------+--------------------------------------+
-| **JIRA REFERENCE** | **SLOGAN** |
-| | |
-+--------------------------------------+--------------------------------------+
-| | |
-| | |
-| | |
-+--------------------------------------+--------------------------------------+
-| | |
-| | |
-| | |
-+--------------------------------------+--------------------------------------+
-
-Workarounds
-^^^^^^^^^^^
-
-<STATE ALL KNOWN WORKAROUNDS TO THE ISSUES STATED ABOVE, IF THERE IS ANY>
-
-
-
-
-References
-----------
-<STATE RELEVANT REFERENCES FOR THIS RELEASE/VERSION>
-
-
-
-