=============
-This document provides the release notes for <RELEASE> of <COMPONENT>.
+This document provides the release notes for Amber Release of Open Test Framework (OTF).
.. contents::
:depth: 3
| **Date** | **Ver.** | **Author** | **Comment** |
| | | | |
+--------------------+--------------------+--------------------+--------------------+
-| 20XX-XX-XX | 0.1.0 | | First draft |
+| 2019-11-12 | 0.1.0 | Rohan Patel (AT&T) | First draft |
| | | | |
+--------------------+--------------------+--------------------+--------------------+
-| | 0.1.1 | | |
+| 2020-06-16 | 0.1.2 | Jackie Chen (AT&T) | new VTH development|
| | | | |
+--------------------+--------------------+--------------------+--------------------+
| | 1.0 | | |
Summary
-------
-<SUMMARIZE THE RELEASE - THE CONTENT - AND OTHER IMPORTANT HIGH LEVEL PROPERTIES>
+This release(0.1.2) will include new VTHs that were developed for oran community.The following are VTHs were developed:
+ - dmaap
+ - A1-mediator
+ - smo-o1
+ - SDNC
+ - A1-policy-manager
+
+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
Release Data
------------
-<STATE RELEVANT RELEASE DATA/RECORDS>
-<EXAMPLE>:
+--------------------------------------+--------------------------------------+
-| **Project** | E.g. project |
+| **Project** | OTF |
| | |
+--------------------------------------+--------------------------------------+
-| **Repo/commit-ID** | E.g. genesis/adf634a0d4..... |
+| **Repo/commit-ID** | it/otf |
| | |
+--------------------------------------+--------------------------------------+
-| **Release designation** | E.g. Arno RC2 |
+| **Release designation** | Bronze |
| | |
+--------------------------------------+--------------------------------------+
-| **Release date** | E.g. 2015-04-16 |
+| **Release date** | 2020-06-16 |
| | |
+--------------------------------------+--------------------------------------+
-| **Purpose of the delivery** | |
+| **Purpose of the delivery** | update repo with VTHs |
| | |
+--------------------------------------+--------------------------------------+
Feature Additions
^^^^^^^^^^^^^^^^^
-<STATE ADDED FEATURES BY REFERENCE TO JIRA>
-<EXAMPLE>:
**JIRA BACK-LOG:**
| **JIRA REFERENCE** | **SLOGAN** |
| | |
+--------------------------------------+--------------------------------------+
-| | |
-| | |
| | |
-+--------------------------------------+--------------------------------------+
-| | |
-| | |
| | |
+--------------------------------------+--------------------------------------+
Software Deliverables
+++++++++++++++++++++
-<STATE WHAT SOFTWARE DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
-
-
+Code: https://gerrit.o-ran-sc.org/r/gitweb?p=it/otf.git;a=summary
+
+Repository contains several applications:
+
+
+oran-ric-test-head:
+ - VTH that enables interaction with xAPP manager
+ - Functionality includes list, deploy, delete xApps
+
+otf-aaf-credential-generator:
+ - contains helm chart for AAF information
+
+otf-camunda:
+ - Test Control Unit Engine
+ - Application handles deployment and execution of OTF test strategies
+
+otf-cert-secret-builder:
+ - contains helm chart for certificate and credential information
+
+otf-frontend:
+ - OTF Portal / GUI
+ - Application provides portal for OTF and allows users to deploy, execute, schedule, and view test executions
+
+otf-ping-test=head:
+ - VTH that capability to ping a server
+
+otf-robot-test-head:
+ - VTH that enables the execution of Robot tests
+
+otf-service-api:
+ - Test Control Unit API
+ - Application exposes apis that allow clients to execute test instances, create test instances, and query execution status.
+
+otf-sst-test-head:
+ - VTH that enables ssh capability to remote server
+
+dmaap-vth:
+ - VTH used to subscribe and publish topics/message via dmaap api
+
+a1-mediator-vth:
+ - VTH used to communicate with A1-mediator
+ - Built according to: https://gerrit.o-ran-sc.org/r/gitweb?p=ric-plt/a1.git;a=blob;f=a1/openapi.yaml
+ - Functionality includes:
+ - health-check on A1
+ - list registered policy types
+ - GET,DELETE,PUT policy types
+ - list policy instance
+ - GET,DELETE,PUT policy instance
+ - Retrieve policy instance status
+
+smo-o1-vth:
+ - Performs health checks to verify that O1 interface is alive by getting alarm list
+
+a1-policy-manager-vth:
+ - Used to communicate with A1 policy management service api
+ - Built according to: https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric/en/latest/policy-agent-api.html#policy-agent-api
+ - 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
+
+a1-sdnc-vth:
+ - Used to communicate with SDNC A1 Controller api
+ - built according to: https://docs.o-ran-sc.org/projects/o-ran-sc-nonrtric/en/latest/sdnc-a1-controller-api.html
+ - 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
+
+Instructions on how to build and run these applications can be found in the otf-installation.txt file located in the it/otf repository.
Documentation Deliverables
++++++++++++++++++++++++++
-<STATE WHAT DOCUMENTATION DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
+OTF Documentation can be found in the link below:
+Documentation: https://wiki.o-ran-sc.org/pages/viewpage.action?pageId=10715484
+The videos and documents located here contain information about how to use the OTF platform, create and execute tests, and troubleshoot workflows.
Known Limitations, Issues and Workarounds
System Limitations
^^^^^^^^^^^^^^^^^^
-<STATE ALL RELEVANT SYSTEM LIMITATIONS, IF THERE IS ANY>
-
Known Issues
^^^^^^^^^^^^
-<STATE ALL KNOWN ISSUES WITH JIRA REFERENCE>
-<EXAMPLE>:
**JIRA TICKETS:**
Workarounds
^^^^^^^^^^^
-<STATE ALL KNOWN WORKAROUNDS TO THE ISSUES STATED ABOVE, IF THERE IS ANY>
-
-
References
----------
-<STATE RELEVANT REFERENCES FOR THIS RELEASE/VERSION>
-
-
Code Review / it / otf.git / blobdiff