Bronze Release Notes
[it/test.git] / docs / release-notes.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. SPDX-License-Identifier: CC-BY-4.0
3 .. ===============LICENSE_START=======================================================
4 .. Copyright (C) 2019 AT&T Intellectual Property      
5 .. ===================================================================================
6 .. This documentation file is distributed under the Creative Commons Attribution 
7 .. 4.0 International License (the "License"); you may not use this file except in 
8 .. compliance with the License.  You may obtain a copy of the License at
9 ..
10 .. http://creativecommons.org/licenses/by/4.0
11 ..
12 .. This file is distributed on an "AS IS" BASIS,
13 .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 .. See the License for the specific language governing permissions and
15 .. limitations under the License.
16 .. ===============LICENSE_END=========================================================
17
18
19 This document provides the release notes for the Bronze Release of the it/test repository.
20
21 .. contents::
22    :depth: 3
23    :local:
24
25
26 Release Notes
27 =============
28
29 Version history
30 ---------------
31
32
33 +--------------------+--------------------+--------------------+--------------------+
34 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
35 |                    |                    |                    |                    |
36 +--------------------+--------------------+--------------------+--------------------+
37 | 2020-06-16         | 0.1.1              | Bharath B          | Bronze version     |
38 |                    |                    |                    |                    |
39 +--------------------+--------------------+--------------------+--------------------+
40 | 2019-11-29         | 0.1.0              | Bharath B          | First draft        |
41 |                    |                    |                    |                    |
42 +--------------------+--------------------+--------------------+--------------------+
43
44
45
46 Summary
47 -------
48
49 The Bronze Release of it/test repository contains:
50
51 - 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: 
52         • Substantial rework of the ric-robot-framework tree to make it more user-friendly
53         • Added an XApp specifically for testing purposes; currently only used for A1 mediator tests
54         • Tests for many more RIC components
55         • Support for tests which execute commands in pods
56         • Bugfixes and functionality upgrades to existing tests
57         • Improved documentation
58 - A workload generator that is used to benchmark the RIC (no change since Amber)
59
60
61
62
63 Release Data
64 ------------
65
66 +--------------------------------------+--------------------------------------+
67 | **Project**                          | End-to-End (E2E) Testing             |
68 |                                      |                                      |
69 +--------------------------------------+--------------------------------------+
70 | **Repo/commit-ID**                   | it/test                              |
71 |                                      |                                      |
72 +--------------------------------------+--------------------------------------+
73 | **Release designation**              | Bronze                               |
74 |                                      |                                      |
75 +--------------------------------------+--------------------------------------+
76 | **Release date**                     | 2020-06-16                           |
77 |                                      |                                      |
78 +--------------------------------------+--------------------------------------+
79 | **Purpose of the delivery**          | Bronze release                       |
80 |                                      |                                      |
81 +--------------------------------------+--------------------------------------+
82
83
84
85
86 Feature additions
87 -------------------
88
89 **JIRA BACK-LOG:**
90
91 +--------------------------------------+--------------------------------------+
92 | **JIRA REFERENCE**                   | **SLOGAN**                           |
93 |                                      |                                      |
94 +--------------------------------------+--------------------------------------+
95 |                                      |                                      |
96 |                                      |                                      |
97 |                                      |                                      |
98 +--------------------------------------+--------------------------------------+
99 |                                      |                                      |
100 |                                      |                                      |
101 |                                      |                                      |
102 +--------------------------------------+--------------------------------------+
103
104 Bug corrections
105 ----------------
106
107 **JIRA TICKETS:**
108
109 +--------------------------------------+--------------------------------------+
110 | **JIRA REFERENCE**                   | **SLOGAN**                           |
111 |                                      |                                      |
112 +--------------------------------------+--------------------------------------+
113 |                                      |                                      |
114 |                                      |                                      |
115 |                                      |                                      |
116 +--------------------------------------+--------------------------------------+
117 |                                      |                                      |
118 |                                      |                                      |
119 |                                      |                                      |
120 +--------------------------------------+--------------------------------------+
121
122 Deliverables
123 -------------
124
125
126
127 Software deliverables
128 ---------------------
129
130 - Stand-alone light-weight robot container: nexus3.o-ran-sc.org:10002/o-ran-sc/it-test-nanobot:0.0.3    
131 - Full-fledged robot container with GUI: nexus3.o-ran-sc.org:10002/o-ran-sc/it-test-ric-robot:0.2.0
132
133 Documentation deliverables
134 ---------------------------
135
136 - release notes present in it/test/docs
137
138 Known Limitations, Issues, and Workarounds
139 ------------------------------------------
140
141 System Limitations
142 ------------------
143
144
145 Known issues
146 ------------------
147
148 **JIRA TICKETS:**
149
150 +--------------------------------------+--------------------------------------+
151 | **JIRA REFERENCE**                   | **SLOGAN**                           |
152 |                                      |                                      |
153 +--------------------------------------+--------------------------------------+
154 |                                      |                                      |
155 |                                      |                                      |
156 |                                      |                                      |
157 +--------------------------------------+--------------------------------------+
158 |                                      |                                      |
159 |                                      |                                      |
160 |                                      |                                      |
161 +--------------------------------------+--------------------------------------+
162
163 Workarounds
164 ------------------
165
166
167
168
169 References
170 -----------
171
172
173
174
175