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-02-02         | 0.1.1              | Lusheng Ji         | Amber maintenance  |
  37 |                    |                    |                    |                    |
  38 +--------------------+--------------------+--------------------+--------------------+
  39 | 2019-11-12         | 0.1.0              | Lusheng Ji         | First draft        |
  40 |                    |                    |                    |                    |
  41 +--------------------+--------------------+--------------------+--------------------+
  42
  43
  44 Summary
  45 -------
  46
  47 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.
  48
  49 For Amber release this repo contains:
  50
  51 - Deployment scripts for a dev-test 1-node Kubernetes cluster.
  52 - Deployment scripts and Helm charts for Near Realtime RAN Intelligent Controller Platform.
  53 - Deployment scripts and Helm charts for infrastructure services supporting the Near Realtime RAN Intelligent Controller Platform.
  54 - Deployment scripts and Helm charts for auxiliary services and components for operating the Near Realtime RAN Intelligent Controller Platform.
  55
  56
  57
  58 Release Data
  59 ------------
  60
  61 +--------------------------------------+--------------------------------------+
  62 | **Project**                          | Integration and Testing              |
  63 |                                      |                                      |
  64 +--------------------------------------+--------------------------------------+
  65 | **Repo/commit-ID**                   | it/dep                               |
  66 |                                      |                                      |
  67 +--------------------------------------+--------------------------------------+
  68 | **Release designation**              | Amber                                |
  69 |                                      |                                      |
  70 +--------------------------------------+--------------------------------------+
  71 | **Release date**                     | 2020-02-02 (Maintenance)             |
  72 |                                      |                                      |
  73 |                                      +--------------------------------------+
  74 |                                      | 2019-11-22 (First Release)           |
  75 |                                      |                                      |
  76 +--------------------------------------+--------------------------------------+
  77 | **Purpose of the delivery**          | First release                        |
  78 |                                      |                                      |
  79 +--------------------------------------+--------------------------------------+
  80
  81
  82
  83
  84 Feature additions
  85 -------------------
  86
  87 **JIRA BACK-LOG:**
  88
  89 +--------------------------------------+--------------------------------------+
  90 | **JIRA REFERENCE**                   | **SLOGAN**                           |
  91 |                                      |                                      |
  92 +--------------------------------------+--------------------------------------+
  93 |                                      |                                      |
  94 |                                      |                                      |
  95 |                                      |                                      |
  96 +--------------------------------------+--------------------------------------+
  97 |                                      |                                      |
  98 |                                      |                                      |
  99 |                                      |                                      |
 100 +--------------------------------------+--------------------------------------+
 101
 102 Bug corrections
 103 ----------------
 104
 105 **JIRA TICKETS:**
 106
 107 +--------------------------------------+--------------------------------------+
 108 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 109 |                                      |                                      |
 110 +--------------------------------------+--------------------------------------+
 111 |                                      |                                      |
 112 |                                      |                                      |
 113 |                                      |                                      |
 114 +--------------------------------------+--------------------------------------+
 115 |                                      |                                      |
 116 |                                      |                                      |
 117 |                                      |                                      |
 118 +--------------------------------------+--------------------------------------+
 119
 120 Deliverables
 121 -------------
 122
 123
 124
 125 Software deliverables
 126 ---------------------
 127
 128 The deployment artifacts can be accessed by cloning the Amber branch of the Git repository:
 129 git clone -b Amber https://gerrit.o-ran-sc.org/r/it/dep
 130
 131
 132 Documentation deliverables
 133 ---------------------------
 134
 135 Documentation for installing, usinhg, and developing for Integraion and Testing project can be found at:
 136 https://docs.o-ran-sc.org/projects/o-ran-sc-it-dep/en/latest/index.html
 137
 138 Known Limitations, Issues, and Workarounds
 139 ------------------------------------------
 140
 141 System Limitations
 142 ------------------
 143
 144
 145 Known issues
 146 ------------------
 147
 148 **JIRA TICKETS:**
 149
 150 +--------------------------------------+--------------------------------------+
 151 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 152 |                                      |                                      |
 153 +--------------------------------------+--------------------------------------+
 154 |                                      |                                      |
 155 |                                      |                                      |
 156 |                                      |                                      |
 157 +--------------------------------------+--------------------------------------+
 158 |                                      |                                      |
 159 |                                      |                                      |
 160 |                                      |                                      |
 161 +--------------------------------------+--------------------------------------+
 162
 163 Workarounds
 164 ------------------
 165
 166
 167
 168
 169 References
 170 -----------
 171
 172
 173
 174