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 | 2020-06-16         | 0.1.2              | Jackie Chen (AT&T) | new VTH development|
  29 |                    |                    |                    |                    |
  30 +--------------------+--------------------+--------------------+--------------------+
  31 |                    | 1.0                |                    |                    |
  32 |                    |                    |                    |                    |
  33 +--------------------+--------------------+--------------------+--------------------+
  34
  35
  36 Summary
  37 -------
  38
  39 This release(0.1.2) will include new VTHs that were developed for oran community.The following are VTHs were developed:
  40
  41     - dmaap
  42     - A1-mediator
  43     - smo-o1
  44     - SDNC
  45     - A1-policy-manager
  46
  47 Most of the vth were built according to health-check use cases(Workflow #2,#3,#4) via: https://wiki.o-ran-sc.org/display/RSAC/Health-Check+Use+Case
  48
  49
  50
  51 Release Data
  52 ------------
  53
  54
  55 +--------------------------------------+--------------------------------------+
  56 | **Project**                          | OTF                                  |
  57 |                                      |                                      |
  58 +--------------------------------------+--------------------------------------+
  59 | **Repo/commit-ID**                   | it/otf                               |
  60 |                                      |                                      |
  61 +--------------------------------------+--------------------------------------+
  62 | **Release designation**              | Bronze                               |
  63 |                                      |                                      |
  64 +--------------------------------------+--------------------------------------+
  65 | **Release date**                     | 2020-06-16                           |
  66 |                                      |                                      |
  67 +--------------------------------------+--------------------------------------+
  68 | **Purpose of the delivery**          | update repo with VTHs                |
  69 |                                      |                                      |
  70 +--------------------------------------+--------------------------------------+
  71
  72
  73
  74
  75 Feature Additions
  76 ^^^^^^^^^^^^^^^^^
  77
  78
  79 **JIRA BACK-LOG:**
  80
  81 +--------------------------------------+--------------------------------------+
  82 | **JIRA REFERENCE**                   | **SLOGAN**                           |
  83 |                                      |                                      |
  84 +--------------------------------------+--------------------------------------+
  85 |                                      |                                      |
  86 |                                      |                                      |
  87 +--------------------------------------+--------------------------------------+
  88
  89 Bug Corrections
  90 ^^^^^^^^^^^^^^^
  91
  92 **JIRA TICKETS:**
  93
  94 +--------------------------------------+--------------------------------------+
  95 | **JIRA REFERENCE**                   | **SLOGAN**                           |
  96 |                                      |                                      |
  97 +--------------------------------------+--------------------------------------+
  98 |                                      |                                      |
  99 |                                      |                                      |
 100 |                                      |                                      |
 101 +--------------------------------------+--------------------------------------+
 102 |                                      |                                      |
 103 |                                      |                                      |
 104 |                                      |                                      |
 105 +--------------------------------------+--------------------------------------+
 106
 107 Deliverables
 108 ^^^^^^^^^^^^
 109
 110 Software Deliverables
 111 +++++++++++++++++++++
 112
 113 Code: https://gerrit.o-ran-sc.org/r/gitweb?p=it/otf.git;a=summary
 114
 115 Repository contains several applications:
 116
 117
 118 oran-ric-test-head:
 119         - VTH that enables interaction with xAPP manager
 120         - Functionality includes list, deploy, delete xApps
 121
 122 otf-aaf-credential-generator:
 123         - contains helm chart for AAF information
 124
 125 otf-camunda:
 126         - Test Control Unit Engine
 127         - Application handles deployment and execution of OTF test strategies
 128
 129 otf-cert-secret-builder:
 130         - contains helm chart for certificate and credential information
 131
 132 otf-frontend:
 133         - OTF Portal / GUI
 134         - Application provides portal for OTF and allows users to deploy, execute, schedule, and view test executions
 135
 136 otf-ping-test=head:
 137         - VTH that capability to ping a server
 138
 139 otf-robot-test-head:
 140         - VTH that enables the execution of Robot tests
 141
 142 otf-service-api:
 143         - Test Control Unit API
 144         - Application exposes apis that allow clients to execute test instances, create test instances, and query execution status.
 145
 146 otf-sst-test-head:
 147         - VTH that enables ssh capability to remote server
 148
 149 dmaap-vth:
 150     - VTH used to subscribe and publish topics/message via dmaap api
 151
 152 a1-mediator-vth:
 153     - VTH used to communicate with A1-mediator
 154     - Built according to: https://gerrit.o-ran-sc.org/r/gitweb?p=ric-plt/a1.git;a=blob;f=a1/openapi.yaml
 155     - Functionality includes:
 156         - health-check on A1
 157         - list registered policy types
 158         - GET,DELETE,PUT policy types
 159         - list policy instance
 160         - GET,DELETE,PUT policy instance
 161         - Retrieve policy instance status
 162
 163 smo-o1-vth:
 164     - Performs health checks to verify that O1 interface is alive by getting alarm list
 165
 166 a1-policy-manager-vth:
 167     - Used to communicate with A1 policy management service api
 168     - Built according to: https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric/en/latest/policy-agent-api.html#policy-agent-api
 169     - Has all functionality that is available in the above link. The vth will require the action and method necessary information e.g. query values and json data and forward the request to the service
 170
 171 a1-sdnc-vth:
 172     - Used to communicate with SDNC A1 Controller api
 173     - built according to: https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric/en/latest/sdnc-a1-controller-api.html
 174     - Has all functionality that is available in the above link. The vth will require the action and method necessary information e.g. query values and json data and forward the request to the service
 175
 176 Instructions on how to build and run these applications can be found in the otf-installation.txt file located in the it/otf repository.
 177
 178 Documentation Deliverables
 179 ++++++++++++++++++++++++++
 180
 181 OTF Documentation can be found in the link below:
 182
 183 Documentation: https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=10715484
 184
 185 The videos and documents located here contain information about how to use the OTF platform, create and execute tests, and troubleshoot workflows.
 186
 187
 188 Known Limitations, Issues and Workarounds
 189 -----------------------------------------
 190
 191 System Limitations
 192 ^^^^^^^^^^^^^^^^^^
 193
 194
 195 Known Issues
 196 ^^^^^^^^^^^^
 197
 198
 199 **JIRA TICKETS:**
 200
 201 +--------------------------------------+--------------------------------------+
 202 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 203 |                                      |                                      |
 204 +--------------------------------------+--------------------------------------+
 205 |                                      |                                      |
 206 |                                      |                                      |
 207 |                                      |                                      |
 208 +--------------------------------------+--------------------------------------+
 209 |                                      |                                      |
 210 |                                      |                                      |
 211 |                                      |                                      |
 212 +--------------------------------------+--------------------------------------+
 213
 214 Workarounds
 215 ^^^^^^^^^^^
 216
 217
 218
 219 References
 220 ----------
 221
 222