From a150d9243834e85774b763ebbf067096de49ba39 Mon Sep 17 00:00:00 2001 From: Bharath Date: Fri, 29 Nov 2019 11:45:22 -0500 Subject: [PATCH] add release notes and overview rsts Signed-off-by: Bharath Change-Id: I3059bda98bcc49370b1f78912ce493693ee474ab --- docs/overview.rst | 25 +++++++- docs/release-notes.rst | 166 +++++++++++++++++++++++++++++++++++++++++++++++-- 2 files changed, 182 insertions(+), 9 deletions(-) diff --git a/docs/overview.rst b/docs/overview.rst index 6e43ac4..1e6c384 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -1,9 +1,28 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. SPDX-License-Identifier: CC-BY-4.0 +.. ===============LICENSE_START======================================================= +.. Copyright (C) 2019 AT&T Intellectual Property +.. =================================================================================== +.. This documentation file is distributed under the Creative Commons Attribution +.. 4.0 International License (the "License"); you may not use this file except in +.. compliance with the License. You may obtain a copy of the License at .. -.. Copyright (C) 2019 AT&T Intellectual Property - +.. http://creativecommons.org/licenses/by/4.0 +.. +.. This file is distributed on an "AS IS" BASIS, +.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +.. See the License for the specific language governing permissions and +.. limitations under the License. +.. ===============LICENSE_END========================================================= Overview -====================== +======== + +The Amber Release of it/test repository contains: +- Test automation scripts written using the robot frameworkDeployment scripts for a dev-test 1-node Kubernetes cluster. +- A functional simulator for the E2 protocol that acts as gNB used to test the RIC. +- A workload generator that is used to benchmark the RIC + + + diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 45465bd..6ad97dd 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -1,12 +1,166 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. SPDX-License-Identifier: CC-BY-4.0 -.. Copyright (C) 2019 AT&T Intellectual Property +.. ===============LICENSE_START======================================================= +.. Copyright (C) 2019 AT&T Intellectual Property +.. =================================================================================== +.. This documentation file is distributed under the Creative Commons Attribution +.. 4.0 International License (the "License"); you may not use this file except in +.. compliance with the License. You may obtain a copy of the License at +.. +.. http://creativecommons.org/licenses/by/4.0 +.. +.. This file is distributed on an "AS IS" BASIS, +.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +.. See the License for the specific language governing permissions and +.. limitations under the License. +.. ===============LICENSE_END========================================================= + + +This document provides the release notes for the Amber Release of the it/test repository. + +.. contents:: + :depth: 3 + :local: + + +Release Notes +============= + +Version history +--------------- + + ++--------------------+--------------------+--------------------+--------------------+ +| **Date** | **Ver.** | **Author** | **Comment** | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ +| 2019-11-29 | 0.1.0 | Bharath B | First draft | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ + + +Summary +------- + +The Amber Release of it/test repository contains: + +- Test automation scripts written using the robot frameworkDeployment scripts for a dev-test 1-node Kubernetes cluster. +- A functional simulator for the E2 protocol that acts as gNB used to test the RIC. +- A workload generator that is used to benchmark the RIC + + + + +Release Data +------------ + ++--------------------------------------+--------------------------------------+ +| **Project** | End-to-End (E2E) Testing | +| | | ++--------------------------------------+--------------------------------------+ +| **Repo/commit-ID** | it/test | +| | | ++--------------------------------------+--------------------------------------+ +| **Release designation** | Amber | +| | | ++--------------------------------------+--------------------------------------+ +| **Release date** | 2019-11-29 | +| | | ++--------------------------------------+--------------------------------------+ +| **Purpose of the delivery** | First release | +| | | ++--------------------------------------+--------------------------------------+ + + + + +Feature additions +------------------- + +**JIRA BACK-LOG:** + ++--------------------------------------+--------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++--------------------------------------+--------------------------------------+ +| | | +| | | +| | | ++--------------------------------------+--------------------------------------+ +| | | +| | | +| | | ++--------------------------------------+--------------------------------------+ + +Bug corrections +---------------- + +**JIRA TICKETS:** + ++--------------------------------------+--------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++--------------------------------------+--------------------------------------+ +| | | +| | | +| | | ++--------------------------------------+--------------------------------------+ +| | | +| | | +| | | ++--------------------------------------+--------------------------------------+ + +Deliverables +------------- + + + +Software deliverables +--------------------- + +- Stand-alone light-weight robot container: nexus3.o-ran-sc.org:10002/o-ran-sc/it-test-nanobot:0.0.1 +- Full-fledged robot container with GUI: nexus3.o-ran-sc.org:10002/o-ran-sc/it-test-ric-robot:0.2.0 + +Documentation deliverables +--------------------------- + +- release notes present in it/test/docs + +Known Limitations, Issues, and Workarounds +------------------------------------------ + +System Limitations +------------------ + + +Known issues +------------------ + +**JIRA TICKETS:** + ++--------------------------------------+--------------------------------------+ +| **JIRA REFERENCE** | **SLOGAN** | +| | | ++--------------------------------------+--------------------------------------+ +| | | +| | | +| | | ++--------------------------------------+--------------------------------------+ +| | | +| | | +| | | ++--------------------------------------+--------------------------------------+ + +Workarounds +------------------ + + + + +References +----------- + -RIC E2E Testing Repo Release Notes -================================== -Version 1.0.0, 12 Nov 2019 --------------------------- -* Initial version -- 2.16.6