Merge "Add O2 IMS compliance automation test scripts."
[it/test.git] / docs / release-notes.rst
index 694d2d9..8331678 100644 (file)
@@ -1,77 +1,90 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+.. ===============LICENSE_START=======================================================
+.. Copyright (C) 2019 AT&T Intellectual Property      
+.. ===================================================================================
+.. This documentation file is distributed under the Creative Commons Attribution 
+.. 4.0 International License (the "License"); you may not use this file except in 
+.. compliance with the License.  You may obtain a copy of the License at
+..
 .. http://creativecommons.org/licenses/by/4.0
 ..
-.. Copyright (C) 2019 AT&T Intellectual Property
-
+.. This file is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+.. ===============LICENSE_END=========================================================
 
-Release-Notes
-=============
 
-
-This document provides the release notes for <RELEASE> of <COMPONENT>.
+This document provides the release notes for the Bronze Release of the it/test repository.
 
 .. contents::
    :depth: 3
    :local:
 
 
+Release Notes
+=============
+
 Version history
 ---------------
 
+
 +--------------------+--------------------+--------------------+--------------------+
 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
-| 20XX-XX-XX         | 0.1.0              |                    | First draft        |
+| 2020-06-16         | 0.1.1              | Bharath B          | Bronze version     |
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
-|                    | 0.1.1              |                    |                    |
-|                    |                    |                    |                    |
-+--------------------+--------------------+--------------------+--------------------+
-|                    | 1.0                |                    |                    |
+| 2019-11-29         | 0.1.0              | Bharath B          | First draft        |
 |                    |                    |                    |                    |
 +--------------------+--------------------+--------------------+--------------------+
 
 
+
 Summary
 -------
 
-<SUMMARIZE THE RELEASE - THE CONTENT - AND OTHER IMPORTANT HIGH LEVEL PROPERTIES>
+The Bronze Release of it/test repository contains:
+
+- Test automation scripts written using the robot frameworkDeployment scripts for a dev-test 1-node Kubernetes cluster. The following improvements were made to the robot framework: 
+       • Substantial rework of the ric-robot-framework tree to make it more user-friendly
+       • Added an XApp specifically for testing purposes; currently only used for A1 mediator tests
+       • Tests for many more RIC components
+       • Support for tests which execute commands in pods
+       • Bugfixes and functionality upgrades to existing tests
+       • Improved documentation
+- A workload generator that is used to benchmark the RIC (no change since Amber)
 
 
 
 
 Release Data
 ------------
-<STATE RELEVANT RELEASE DATA/RECORDS>
-
-<EXAMPLE>:
 
 +--------------------------------------+--------------------------------------+
-| **Project**                          | E.g. project                                |
+| **Project**                          | End-to-End (E2E) Testing             |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Repo/commit-ID**                   | E.g. genesis/adf634a0d4.....         |
+| **Repo/commit-ID**                   | it/test                              |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Release designation**              | E.g. Arno RC2                        |
+| **Release designation**              | Bronze                               |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Release date**                     | E.g. 2015-04-16                      |
+| **Release date**                     | 2020-06-16                           |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
-| **Purpose of the delivery**          |                                     |
+| **Purpose of the delivery**          | Bronze release                       |
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
 
 
 
 
-Feature Additions
-^^^^^^^^^^^^^^^^^
-<STATE ADDED FEATURES BY REFERENCE TO JIRA>
-
-<EXAMPLE>:
+Feature additions
+-------------------
 
 **JIRA BACK-LOG:**
 
@@ -88,8 +101,8 @@ Feature Additions
 |                                      |                                      |
 +--------------------------------------+--------------------------------------+
 
-Bug Corrections
-^^^^^^^^^^^^^^^
+Bug corrections
+----------------
 
 **JIRA TICKETS:**
 
@@ -107,37 +120,30 @@ Bug Corrections
 +--------------------------------------+--------------------------------------+
 
 Deliverables
-^^^^^^^^^^^^
-
-Software Deliverables
-+++++++++++++++++++++
-
-<STATE WHAT SOFTWARE DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
+-------------
 
 
 
-Documentation Deliverables
-++++++++++++++++++++++++++
+Software deliverables
+---------------------
 
-<STATE WHAT DOCUMENTATION DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
+- Stand-alone light-weight robot container: nexus3.o-ran-sc.org:10002/o-ran-sc/it-test-nanobot:0.0.3   
+- Full-fledged robot container with GUI: nexus3.o-ran-sc.org:10002/o-ran-sc/it-test-ric-robot:0.2.0
 
+Documentation deliverables
+---------------------------
 
+- release notes present in it/test/docs
 
-
-Known Limitations, Issues and Workarounds
------------------------------------------
+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>:
+Known issues
+------------------
 
 **JIRA TICKETS:**
 
@@ -155,16 +161,14 @@ Known Issues
 +--------------------------------------+--------------------------------------+
 
 Workarounds
-^^^^^^^^^^^
-
-<STATE ALL KNOWN WORKAROUNDS TO THE ISSUES STATED ABOVE, IF THERE IS ANY>
+------------------
 
 
 
 
 References
-----------
-<STATE RELEVANT REFERENCES FOR THIS RELEASE/VERSION>
+-----------
+