Gitiles
Code Review Sign In
gerrit.nordix.org / oransc / it / otf / 7d885231f62e79ed6c1f6a46c4e8421cfc80d86d / . / docs / release-notes.rst
blob: b151888fdd7f861132f74deb9c922cde4d91eba6 [file] [log] [blame]
wriderf9def9a2019-11-07 18:29:38 -0500[diff] [blame]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
7Release-Notes
8=============
9
10
Rohan Patel14086742019-11-12 16:51:56 -0500[diff] [blame]11This document provides the release notes for Amber Release of Open Test Framework (OTF).
wriderf9def9a2019-11-07 18:29:38 -0500[diff] [blame]12
13.. contents::
14 :depth: 3
15 :local:
16
17
18Version history
19---------------
20
21+--------------------+--------------------+--------------------+--------------------+
22| **Date** | **Ver.** | **Author** | **Comment** |
23| | | | |
24+--------------------+--------------------+--------------------+--------------------+
Rohan Patel14086742019-11-12 16:51:56 -0500[diff] [blame]25| 2019-11-12 | 0.1.0 | Rohan Patel (AT&T) | First draft |
wriderf9def9a2019-11-07 18:29:38 -0500[diff] [blame]26| | | | |
27+--------------------+--------------------+--------------------+--------------------+
28| | 0.1.1 | | |
29| | | | |
30+--------------------+--------------------+--------------------+--------------------+
31| | 1.0 | | |
32| | | | |
33+--------------------+--------------------+--------------------+--------------------+
34
35
36Summary
37-------
38
Rohan Patel14086742019-11-12 16:51:56 -0500[diff] [blame]39This 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.
wriderf9def9a2019-11-07 18:29:38 -0500[diff] [blame]40
41
42
43
44Release Data
45------------
wriderf9def9a2019-11-07 18:29:38 -0500[diff] [blame]46
wriderf9def9a2019-11-07 18:29:38 -0500[diff] [blame]47
48+--------------------------------------+--------------------------------------+
Rohan Patel14086742019-11-12 16:51:56 -0500[diff] [blame]49| **Project** | OTF |
wriderf9def9a2019-11-07 18:29:38 -0500[diff] [blame]50| | |
51+--------------------------------------+--------------------------------------+
Rohan Patel14086742019-11-12 16:51:56 -0500[diff] [blame]52| **Repo/commit-ID** | it/otf |
wriderf9def9a2019-11-07 18:29:38 -0500[diff] [blame]53| | |
54+--------------------------------------+--------------------------------------+
55| **Release designation** | E.g. Arno RC2 |
56| | |
57+--------------------------------------+--------------------------------------+
58| **Release date** | E.g. 2015-04-16 |
59| | |
60+--------------------------------------+--------------------------------------+
Rohan Patel14086742019-11-12 16:51:56 -0500[diff] [blame]61| **Purpose of the delivery** | |
wriderf9def9a2019-11-07 18:29:38 -0500[diff] [blame]62| | |
63+--------------------------------------+--------------------------------------+
64
65
66
67
68Feature Additions
69^^^^^^^^^^^^^^^^^
wriderf9def9a2019-11-07 18:29:38 -0500[diff] [blame]70
wriderf9def9a2019-11-07 18:29:38 -0500[diff] [blame]71
72**JIRA BACK-LOG:**
73
74+--------------------------------------+--------------------------------------+
75| **JIRA REFERENCE** | **SLOGAN** |
76| | |
77+--------------------------------------+--------------------------------------+
Rohan Patel14086742019-11-12 16:51:56 -0500[diff] [blame]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 |
wriderf9def9a2019-11-07 18:29:38 -0500[diff] [blame]85| | |
86+--------------------------------------+--------------------------------------+
Rohan Patel14086742019-11-12 16:51:56 -0500[diff] [blame]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 |
wriderf9def9a2019-11-07 18:29:38 -0500[diff] [blame]97| | |
98+--------------------------------------+--------------------------------------+
99
100Bug Corrections
101^^^^^^^^^^^^^^^
102
103**JIRA TICKETS:**
104
105+--------------------------------------+--------------------------------------+
106| **JIRA REFERENCE** | **SLOGAN** |
107| | |
108+--------------------------------------+--------------------------------------+
109| | |
110| | |
111| | |
112+--------------------------------------+--------------------------------------+
113| | |
114| | |
115| | |
116+--------------------------------------+--------------------------------------+
117
118Deliverables
119^^^^^^^^^^^^
120
121Software Deliverables
122+++++++++++++++++++++
123
Rohan Patel14086742019-11-12 16:51:56 -0500[diff] [blame]124Code: https://gerrit.o-ran-sc.org/r/gitweb?p=it/otf.git;a=summary
125
126Repository contains several applications:
wriderf9def9a2019-11-07 18:29:38 -0500[diff] [blame]127
128
Rohan Patel14086742019-11-12 16:51:56 -0500[diff] [blame]129oran-ric-test-head:
130 - VTH that enables interaction with xAPP manager
131 - Functionality includes list, deploy, delete xApps
132
133otf-aaf-credential-generator:
134 - contains helm chart for AAF information
135
136otf-camunda:
137 - Test Control Unit Engine
138 - Application handles deployment and execution of OTF test strategies
139
140otf-cert-secret-builder:
141 - contains helm chart for certificate and credential information
142
143otf-frontend:
144 - OTF Portal / GUI
145 - Application provides portal for OTF and allows users to deploy, execute, schedule, and view test executions
146
147otf-ping-test=head:
148 - VTH that capability to ping a server
149
150otf-robot-test-head:
151 - VTH that enables the execution of Robot tests
152
153otf-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
157otf-sst-test-head:
158 - VTH that enables ssh capability to remote server
159
160
161
162Instructions on how to build and run these applications can be found in the otf-installation.txt file located in the it/otf repository.
wriderf9def9a2019-11-07 18:29:38 -0500[diff] [blame]163
164Documentation Deliverables
165++++++++++++++++++++++++++
166
Rohan Patel14086742019-11-12 16:51:56 -0500[diff] [blame]167OTF Documentation can be found in the link below:
wriderf9def9a2019-11-07 18:29:38 -0500[diff] [blame]168
Rohan Patel14086742019-11-12 16:51:56 -0500[diff] [blame]169Documentation: https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=10715484
wriderf9def9a2019-11-07 18:29:38 -0500[diff] [blame]170
Rohan Patel14086742019-11-12 16:51:56 -0500[diff] [blame]171The videos and documents located here contain information about how to use the OTF platform, create and execute tests, and troubleshoot workflows.
wriderf9def9a2019-11-07 18:29:38 -0500[diff] [blame]172
173
174Known Limitations, Issues and Workarounds
175-----------------------------------------
176
177System Limitations
178^^^^^^^^^^^^^^^^^^
wriderf9def9a2019-11-07 18:29:38 -0500[diff] [blame]179
180
181Known Issues
182^^^^^^^^^^^^
wriderf9def9a2019-11-07 18:29:38 -0500[diff] [blame]183
wriderf9def9a2019-11-07 18:29:38 -0500[diff] [blame]184
185**JIRA TICKETS:**
186
187+--------------------------------------+--------------------------------------+
188| **JIRA REFERENCE** | **SLOGAN** |
189| | |
190+--------------------------------------+--------------------------------------+
191| | |
192| | |
193| | |
194+--------------------------------------+--------------------------------------+
195| | |
196| | |
197| | |
198+--------------------------------------+--------------------------------------+
199
200Workarounds
201^^^^^^^^^^^
202
wriderf9def9a2019-11-07 18:29:38 -0500[diff] [blame]203
204
205References
206----------
wriderf9def9a2019-11-07 18:29:38 -0500[diff] [blame]207
208