NONRTRIC-946: Servicemanager - Add Kong data plane and control plane
[it/dep.git] / docs / release-notes.rst
index db17b4f..a9e1f0e 100644 (file)
@@ -23,6 +23,9 @@ This document provides the release notes for <RELEASE> of <COMPONENT>.
    :local:
 
 
+Release Notes
+=============
+
 Version history
 ---------------
 
@@ -30,56 +33,83 @@ Version history
 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
-| 20XX-XX-XX         | 0.1.0              |                    | First draft        |
+| 2020-12-14         | 0.3.0              | Zhe Huang          |                    |
+|                    |                    |                    |                    |
++--------------------+--------------------+--------------------+--------------------+
+| 2020-08-01         | 0.2.1              | Lusheng Ji         |                    |
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
-|                    | 0.1.1              |                    |                    |
+| 2020-06-20         | 0.2.0              | Lusheng Ji         |                    |
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
-|                    | 1.0                |                    |                    |
+| 2019-11-12         | 0.1.0              | Lusheng Ji         | First draft        |
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
 
 
-Summary
-=======
+Releases
+--------
 
-<SUMMARIZE THE RELEASE - THE CONTENT - AND OTHER IMPORTANT HIGH LEVEL PROPERTIES>
+0.3.0
+^^^^^
 
+**Release designation**: Cherry
 
+**Release Date**: 2020-12-14
 
+The 0.3.0 version of the it/dep repository hosts deployment and integration artifacts such as scripts, Helm charts, and other files used for deploying the Cherry Release of O-RAN SC software.
 
-Release Data
-============
-<STATE RELEVANT RELEASE DATA/RECORDS>
+- Provide Helm 3 support for near-realtime RIC and AUX.
+- Deployment scripts for O-DU high project.
+- Deployment scripts for smo project.
+- Add rApp Catalogue and enrichmentservice helm charts for non-realtime RIC.
+- Update the deployment recipes for all the O-RAN SC software to use the Cherry release images.
 
-<EXAMPLE>:
+0.2.1
+^^^^^
+**Release designation**: Bronze Maintenance Release
 
-+--------------------------------------+--------------------------------------+
-| **Project**                          | E.g. Arno/genesis/fuel@opnfv         |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-| **Repo/commit-ID**                   | E.g. genesis/adf634a0d4.....         |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-| **Release designation**              | E.g. Arno RC2                        |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-| **Release date**                     | E.g. 2015-04-16                      |
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
-| **Purpose of the delivery**          | E.g. OPNFV Internal quality assurance|
-|                                      |                                      |
-+--------------------------------------+--------------------------------------+
+**Release Date**: 2020-08-01
 
+- Added demo scripts for Bronze "Get Started" demontsrations.
 
+0.2.0
+^^^^^
 
+**Release designation**: Bronze
 
-Feature additions
--------------------
-<STATE ADDED FEATURES BY REFERENCE TO JIRA>
+**Release Date**: 2020-06-21
+
+The 0.2.0 version of the it/dep repository hosts deployment and integration artifacts such as scripts, Helm charts, and other files used for deploying the Bronze Release of O-RAN SC software.
+
+- Deployment scripts for dev-test 1-node Kubernetes cluster.
+- Deployment scripts and Helm charts for O-RAN Near Realtime RAN Intelligent Controller Platform.
+- Deployment scripts and Helm charts for O-RAN Non Realtime RAN Intelligent Controller.
+- Deployment scripts for O-RAN Software Management and Orchestration.
+- Demonstration and testing scripts for use cases.
+
+
+
+0.1.0
+^^^^^
+**Release designation**: Amber
 
-<EXAMPLE>:
+**Release Date**: 2019-11-22
+
+The Amber Release of it/dep repositoy hosts deployment and integration artifacts such as scripts, Helm charts, and other files used for deploying O-RAN SC software.
+
+For Amber release this repo contains:
+
+- Deployment scripts for a dev-test 1-node Kubernetes cluster.
+- Deployment scripts and Helm charts for Near Realtime RAN Intelligent Controller Platform.
+- Deployment scripts and Helm charts for infrastructure services supporting the Near Realtime RAN Intelligent Controller Platform.
+- Deployment scripts and Helm charts for auxiliary services and components for operating the Near Realtime RAN Intelligent Controller Platform.
+
+
+
+
+Feature additions
+-----------------
 
 **JIRA BACK-LOG:**
 
@@ -114,41 +144,38 @@ Bug corrections
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
 
-Deliverables
-============
 
-<Deliverables>
 
+Deliverables
+------------
 
 Software deliverables
----------------------
+^^^^^^^^^^^^^^^^^^^^^
 
-<STATE WHAT SOFTWARE DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
+The deployment artifacts can be accessed by cloning Git repository:
+
+  git clone https://gerrit.o-ran-sc.org/r/it/dep -b cherry
 
-<EXAMPLE>:
 
 Documentation deliverables
----------------------------
+^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-<STATE WHAT DOCUMENTATION DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
+Documentation for installing, usinhg, and developing for Integraion and Testing project can be found at: 
 
-<EXAMPLE>:
+  https://docs.o-ran-sc.org/projects/o-ran-sc-it-dep/en/latest/index.html
 
 
-Known Limitations, Issues and Workarounds
-=========================================
 
-System Limitations
-------------------
-<STATE ALL RELEVANT SYSTEM LIMITATIONS, IF THERE IS ANY>
+Known Limitations, Issues, and Workarounds
+------------------------------------------
 
 
+System Limitations
+^^^^^^^^^^^^^^^^^^
 
-Known issues
-------------------
-<STATE ALL KNOWN ISSUES WITH JIRA REFERENCE>
 
-<EXAMPLE>:
+Known issues
+^^^^^^^^^^^^
 
 **JIRA TICKETS:**
 
@@ -166,17 +193,10 @@ Known issues
 +--------------------------------------+--------------------------------------+
 
 Workarounds
-------------------
-
-<STATE ALL KNOWN WORKAROUNDS TO THE ISSUES STATED ABOVE, IF THERE IS ANY>
-
-
+^^^^^^^^^^^
 
 
 References
-==========
-<STATE RELEVANT REFERENCES FOR THIS RELEASE/VERSION>
-
-
+----------