docs/release-notes.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. SPDX-License-Identifier: CC-BY-4.0
   3 .. ===============LICENSE_START=======================================================
   4 .. Copyright (C) 2019 AT&T Intellectual Property
   5 .. ===================================================================================
   6 .. This documentation file is distributed under the Creative Commons Attribution
   7 .. 4.0 International License (the "License"); you may not use this file except in
   8 .. compliance with the License.  You may obtain a copy of the License at
   9 ..
  10 .. http://creativecommons.org/licenses/by/4.0
  11 ..
  12 .. This file is distributed on an "AS IS" BASIS,
  13 .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 .. See the License for the specific language governing permissions and
  15 .. limitations under the License.
  16 .. ===============LICENSE_END=========================================================
  17
  18
  19 This document provides the release notes for <RELEASE> of <COMPONENT>.
  20
  21 .. contents::
  22    :depth: 3
  23    :local:
  24
  25
  26 Release Notes
  27 =============
  28
  29 Version history
  30 ---------------
  31
  32 +--------------------+--------------------+--------------------+--------------------+
  33 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
  34 |                    |                    |                    |                    |
  35 +--------------------+--------------------+--------------------+--------------------+
  36 | 2020-08-01         | 0.2.1              | Lusheng Ji         |                    |
  37 |                    |                    |                    |                    |
  38 +--------------------+--------------------+--------------------+--------------------+
  39 | 2020-06-20         | 0.2.0              | Lusheng Ji         |                    |
  40 |                    |                    |                    |                    |
  41 +--------------------+--------------------+--------------------+--------------------+
  42 | 2019-11-12         | 0.1.0              | Lusheng Ji         | First draft        |
  43 |                    |                    |                    |                    |
  44 +--------------------+--------------------+--------------------+--------------------+
  45
  46
  47 Releases
  48 --------
  49
  50 0.2.1
  51 ^^^^^
  52 **Release designation**: Bronze Maintenance Release
  53
  54 **Release Date**: 2020-08-01
  55
  56 - Added demo scripts for Bronze "Get Started" demontsrations.
  57
  58 0.2.0
  59 ^^^^^
  60
  61 **Release designation**: Bronze
  62
  63 **Release Date**: 2020-06-21
  64
  65 The 0.2.0 version of the it/dep repository hosts deployment and integration artifacts such as scripts, Helm charts, and other files used for deploying the Bronze Release of O-RAN SC software.
  66
  67 - Deployment scripts for dev-test 1-node Kubernetes cluster.
  68 - Deployment scripts and Helm charts for O-RAN Near Realtime RAN Intelligent Controller Platform.
  69 - Deployment scripts and Helm charts for O-RAN Non Realtime RAN Intelligent Controller.
  70 - Deployment scripts for O-RAN Software Management and Orchestration.
  71 - Demonstration and testing scripts for use cases.
  72
  73
  74
  75 0.1.0
  76 ^^^^^
  77 **Release designation**: Amber
  78
  79 **Release Date**: 2019-11-22
  80
  81 The Amber Release of it/dep repositoy hosts deployment and integration artifacts such as scripts, Helm charts, and other files used for deploying O-RAN SC software.
  82
  83 For Amber release this repo contains:
  84
  85 - Deployment scripts for a dev-test 1-node Kubernetes cluster.
  86 - Deployment scripts and Helm charts for Near Realtime RAN Intelligent Controller Platform.
  87 - Deployment scripts and Helm charts for infrastructure services supporting the Near Realtime RAN Intelligent Controller Platform.
  88 - Deployment scripts and Helm charts for auxiliary services and components for operating the Near Realtime RAN Intelligent Controller Platform.
  89
  90
  91
  92
  93 Feature additions
  94 -----------------
  95
  96 **JIRA BACK-LOG:**
  97
  98 +--------------------------------------+--------------------------------------+
  99 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 100 |                                      |                                      |
 101 +--------------------------------------+--------------------------------------+
 102 |                                      |                                      |
 103 |                                      |                                      |
 104 |                                      |                                      |
 105 +--------------------------------------+--------------------------------------+
 106 |                                      |                                      |
 107 |                                      |                                      |
 108 |                                      |                                      |
 109 +--------------------------------------+--------------------------------------+
 110
 111 Bug corrections
 112 ----------------
 113
 114 **JIRA TICKETS:**
 115
 116 +--------------------------------------+--------------------------------------+
 117 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 118 |                                      |                                      |
 119 +--------------------------------------+--------------------------------------+
 120 |                                      |                                      |
 121 |                                      |                                      |
 122 |                                      |                                      |
 123 +--------------------------------------+--------------------------------------+
 124 |                                      |                                      |
 125 |                                      |                                      |
 126 |                                      |                                      |
 127 +--------------------------------------+--------------------------------------+
 128
 129
 130
 131 Deliverables
 132 ------------
 133
 134 Software deliverables
 135 ^^^^^^^^^^^^^^^^^^^^^
 136
 137 The deployment artifacts can be accessed by cloning Git repository:
 138
 139   git clone https://gerrit.o-ran-sc.org/r/it/dep -b bronze
 140
 141
 142 Documentation deliverables
 143 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 144
 145 Documentation for installing, usinhg, and developing for Integraion and Testing project can be found at:
 146
 147   https://docs.o-ran-sc.org/projects/o-ran-sc-it-dep/en/latest/index.html
 148
 149
 150
 151 Known Limitations, Issues, and Workarounds
 152 ------------------------------------------
 153
 154
 155 System Limitations
 156 ^^^^^^^^^^^^^^^^^^
 157
 158
 159 Known issues
 160 ^^^^^^^^^^^^
 161
 162 **JIRA TICKETS:**
 163
 164 +--------------------------------------+--------------------------------------+
 165 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 166 |                                      |                                      |
 167 +--------------------------------------+--------------------------------------+
 168 |                                      |                                      |
 169 |                                      |                                      |
 170 |                                      |                                      |
 171 +--------------------------------------+--------------------------------------+
 172 |                                      |                                      |
 173 |                                      |                                      |
 174 |                                      |                                      |
 175 +--------------------------------------+--------------------------------------+
 176
 177 Workarounds
 178 ^^^^^^^^^^^
 179
 180
 181 References
 182 ----------
 183
 184