Add release file for it-otf-ping-test-head:0.0.1
[it/otf.git] / docs / release-notes.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 ..
4 .. Copyright (C) 2019 AT&T Intellectual Property
5
6
7 Release-Notes
8 =============
9
10
11 This document provides the release notes for Amber Release of Open Test Framework (OTF).
12
13 .. contents::
14    :depth: 3
15    :local:
16
17
18 Version history
19 ---------------
20
21 +--------------------+--------------------+--------------------+--------------------+
22 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
23 |                    |                    |                    |                    |
24 +--------------------+--------------------+--------------------+--------------------+
25 | 2019-11-12         | 0.1.0              | Rohan Patel (AT&T) | First draft        |
26 |                    |                    |                    |                    |
27 +--------------------+--------------------+--------------------+--------------------+
28 |                    | 0.1.1              |                    |                    |
29 |                    |                    |                    |                    |
30 +--------------------+--------------------+--------------------+--------------------+
31 |                    | 1.0                |                    |                    |
32 |                    |                    |                    |                    |
33 +--------------------+--------------------+--------------------+--------------------+
34
35
36 Summary
37 -------
38
39 This release will include the initial commit of the OTF platform code. Applications include otf-frontend, otf-service-api, otf-camunda, and several virtual test head microservices (ping, ssh, robot, ric). In addition setup documentation and installation guides are included to build docker containers and helm charts for deployment. 
40
41
42
43
44 Release Data
45 ------------
46
47
48 +--------------------------------------+--------------------------------------+
49 | **Project**                          | OTF                                  |
50 |                                      |                                      |
51 +--------------------------------------+--------------------------------------+
52 | **Repo/commit-ID**                   | it/otf                               |
53 |                                      |                                      |
54 +--------------------------------------+--------------------------------------+
55 | **Release designation**              | E.g. Arno RC2                        |
56 |                                      |                                      |
57 +--------------------------------------+--------------------------------------+
58 | **Release date**                     | E.g. 2015-04-16                      |
59 |                                      |                                      |
60 +--------------------------------------+--------------------------------------+
61 | **Purpose of the delivery**          |                                      |
62 |                                      |                                      |
63 +--------------------------------------+--------------------------------------+
64
65
66
67
68 Feature Additions
69 ^^^^^^^^^^^^^^^^^
70
71
72 **JIRA BACK-LOG:**
73
74 +--------------------------------------+--------------------------------------+
75 | **JIRA REFERENCE**                   | **SLOGAN**                           |
76 |                                      |                                      |
77 +--------------------------------------+--------------------------------------+
78 | INT-34                               | Contribute OTF seed code to Linux    |
79 |                                      | Foundation                           |
80 +--------------------------------------+--------------------------------------+
81 | INT-35                               | Deploy one operational OTF instance  |
82 |                                      | in O-RAN SC lab                      |
83 +--------------------------------------+--------------------------------------+
84 | INT-36                               | Develop one VTH                      |
85 |                                      |                                      |
86 +--------------------------------------+--------------------------------------+
87 | INT-37                               | Create one test strategy for         |
88 |                                      | End-to-End Integration/Demo          |
89 +--------------------------------------+--------------------------------------+
90 | INT-38                               | Create one test instance             |
91 |                                      |                                      |
92 +--------------------------------------+--------------------------------------+
93 | INT-39                               | Demonstrate OTF test execution       |
94 |                                      |                                      |
95 +--------------------------------------+--------------------------------------+
96 | INT-40                               | Documentation OTF and education      |
97 |                                      |                                      |
98 +--------------------------------------+--------------------------------------+
99
100 Bug Corrections
101 ^^^^^^^^^^^^^^^
102
103 **JIRA TICKETS:**
104
105 +--------------------------------------+--------------------------------------+
106 | **JIRA REFERENCE**                   | **SLOGAN**                           |
107 |                                      |                                      |
108 +--------------------------------------+--------------------------------------+
109 |                                      |                                      |
110 |                                      |                                      |
111 |                                      |                                      |
112 +--------------------------------------+--------------------------------------+
113 |                                      |                                      |
114 |                                      |                                      |
115 |                                      |                                      |
116 +--------------------------------------+--------------------------------------+
117
118 Deliverables
119 ^^^^^^^^^^^^
120
121 Software Deliverables
122 +++++++++++++++++++++
123
124 Code: https://gerrit.o-ran-sc.org/r/gitweb?p=it/otf.git;a=summary
125
126 Repository contains several applications:
127
128
129 oran-ric-test-head:     
130         - VTH that enables interaction with xAPP manager
131         - Functionality includes list, deploy, delete xApps
132         
133 otf-aaf-credential-generator:      
134         - contains helm chart for AAF information
135         
136 otf-camunda:
137         - Test Control Unit Engine       
138         - Application handles deployment and execution of OTF test strategies        
139         
140 otf-cert-secret-builder:      
141         - contains helm chart for certificate and credential information
142         
143 otf-frontend:        
144         - OTF Portal / GUI
145         - Application provides portal for OTF and allows users to deploy, execute, schedule, and view test executions
146         
147 otf-ping-test=head:    
148         - VTH that capability to ping a server
149      
150 otf-robot-test-head:    
151         - VTH that enables the execution of Robot tests
152     
153 otf-service-api:
154         - Test Control Unit API
155         - Application exposes apis that allow clients to execute test instances, create test instances, and query execution status. 
156     
157 otf-sst-test-head:    
158         - VTH that enables ssh capability to remote server
159     
160
161
162 Instructions on how to build and run these applications can be found in the otf-installation.txt file located in the it/otf repository.
163
164 Documentation Deliverables
165 ++++++++++++++++++++++++++
166
167 OTF Documentation can be found in the link below:
168
169 Documentation: https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=10715484
170
171 The videos and documents located here contain information about how to use the OTF platform, create and execute tests, and troubleshoot workflows.
172
173
174 Known Limitations, Issues and Workarounds
175 -----------------------------------------
176
177 System Limitations
178 ^^^^^^^^^^^^^^^^^^
179
180
181 Known Issues
182 ^^^^^^^^^^^^
183
184
185 **JIRA TICKETS:**
186
187 +--------------------------------------+--------------------------------------+
188 | **JIRA REFERENCE**                   | **SLOGAN**                           |
189 |                                      |                                      |
190 +--------------------------------------+--------------------------------------+
191 |                                      |                                      |
192 |                                      |                                      |
193 |                                      |                                      |
194 +--------------------------------------+--------------------------------------+
195 |                                      |                                      |
196 |                                      |                                      |
197 |                                      |                                      |
198 +--------------------------------------+--------------------------------------+
199
200 Workarounds
201 ^^^^^^^^^^^
202
203
204
205 References
206 ----------
207
208