add release notes and overview rsts
[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 Amber 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 | 2019-11-29         | 0.1.0              | Bharath B          | First draft        |
38 |                    |                    |                    |                    |
39 +--------------------+--------------------+--------------------+--------------------+
40
41
42 Summary
43 -------
44
45 The Amber Release of it/test repository contains:
46
47 - Test automation scripts written using the robot frameworkDeployment scripts for a dev-test 1-node Kubernetes cluster.
48 - A functional simulator for the E2 protocol that acts as gNB used to test the RIC.
49 - A workload generator that is used to benchmark the RIC
50
51
52
53
54 Release Data
55 ------------
56
57 +--------------------------------------+--------------------------------------+
58 | **Project**                          | End-to-End (E2E) Testing             |
59 |                                      |                                      |
60 +--------------------------------------+--------------------------------------+
61 | **Repo/commit-ID**                   | it/test                              |
62 |                                      |                                      |
63 +--------------------------------------+--------------------------------------+
64 | **Release designation**              | Amber                                |
65 |                                      |                                      |
66 +--------------------------------------+--------------------------------------+
67 | **Release date**                     | 2019-11-29                           |
68 |                                      |                                      |
69 +--------------------------------------+--------------------------------------+
70 | **Purpose of the delivery**          | First release                        |
71 |                                      |                                      |
72 +--------------------------------------+--------------------------------------+
73
74
75
76
77 Feature additions
78 -------------------
79
80 **JIRA BACK-LOG:**
81
82 +--------------------------------------+--------------------------------------+
83 | **JIRA REFERENCE**                   | **SLOGAN**                           |
84 |                                      |                                      |
85 +--------------------------------------+--------------------------------------+
86 |                                      |                                      |
87 |                                      |                                      |
88 |                                      |                                      |
89 +--------------------------------------+--------------------------------------+
90 |                                      |                                      |
91 |                                      |                                      |
92 |                                      |                                      |
93 +--------------------------------------+--------------------------------------+
94
95 Bug corrections
96 ----------------
97
98 **JIRA TICKETS:**
99
100 +--------------------------------------+--------------------------------------+
101 | **JIRA REFERENCE**                   | **SLOGAN**                           |
102 |                                      |                                      |
103 +--------------------------------------+--------------------------------------+
104 |                                      |                                      |
105 |                                      |                                      |
106 |                                      |                                      |
107 +--------------------------------------+--------------------------------------+
108 |                                      |                                      |
109 |                                      |                                      |
110 |                                      |                                      |
111 +--------------------------------------+--------------------------------------+
112
113 Deliverables
114 -------------
115
116
117
118 Software deliverables
119 ---------------------
120
121 - Stand-alone light-weight robot container: nexus3.o-ran-sc.org:10002/o-ran-sc/it-test-nanobot:0.0.1    
122 - Full-fledged robot container with GUI: nexus3.o-ran-sc.org:10002/o-ran-sc/it-test-ric-robot:0.2.0
123
124 Documentation deliverables
125 ---------------------------
126
127 - release notes present in it/test/docs
128
129 Known Limitations, Issues, and Workarounds
130 ------------------------------------------
131
132 System Limitations
133 ------------------
134
135
136 Known issues
137 ------------------
138
139 **JIRA TICKETS:**
140
141 +--------------------------------------+--------------------------------------+
142 | **JIRA REFERENCE**                   | **SLOGAN**                           |
143 |                                      |                                      |
144 +--------------------------------------+--------------------------------------+
145 |                                      |                                      |
146 |                                      |                                      |
147 |                                      |                                      |
148 +--------------------------------------+--------------------------------------+
149 |                                      |                                      |
150 |                                      |                                      |
151 |                                      |                                      |
152 +--------------------------------------+--------------------------------------+
153
154 Workarounds
155 ------------------
156
157
158
159
160 References
161 -----------
162
163
164
165
166