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