PMS, Enabling json schema validation
[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-12-14         | 0.3.0              | Zhe Huang          |                    |
37 |                    |                    |                    |                    |
38 +--------------------+--------------------+--------------------+--------------------+
39 | 2020-08-01         | 0.2.1              | Lusheng Ji         |                    |
40 |                    |                    |                    |                    |
41 +--------------------+--------------------+--------------------+--------------------+
42 | 2020-06-20         | 0.2.0              | Lusheng Ji         |                    |
43 |                    |                    |                    |                    |
44 +--------------------+--------------------+--------------------+--------------------+
45 | 2019-11-12         | 0.1.0              | Lusheng Ji         | First draft        |
46 |                    |                    |                    |                    |
47 +--------------------+--------------------+--------------------+--------------------+
48
49
50 Releases
51 --------
52
53 0.3.0
54 ^^^^^
55
56 **Release designation**: Cherry
57
58 **Release Date**: 2020-12-14
59
60 The 0.3.0 version of the it/dep repository hosts deployment and integration artifacts such as scripts, Helm charts, and other files used for deploying the Cherry Release of O-RAN SC software.
61
62 - Provide Helm 3 support for near-realtime RIC and AUX.
63 - Deployment scripts for O-DU high project.
64 - Deployment scripts for smo project.
65 - Add rApp Catalogue and enrichmentservice helm charts for non-realtime RIC.
66 - Update the deployment recipes for all the O-RAN SC software to use the Cherry release images.
67
68 0.2.1
69 ^^^^^
70 **Release designation**: Bronze Maintenance Release
71
72 **Release Date**: 2020-08-01
73
74 - Added demo scripts for Bronze "Get Started" demontsrations.
75
76 0.2.0
77 ^^^^^
78
79 **Release designation**: Bronze
80
81 **Release Date**: 2020-06-21
82
83 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.
84
85 - Deployment scripts for dev-test 1-node Kubernetes cluster.
86 - Deployment scripts and Helm charts for O-RAN Near Realtime RAN Intelligent Controller Platform.
87 - Deployment scripts and Helm charts for O-RAN Non Realtime RAN Intelligent Controller.
88 - Deployment scripts for O-RAN Software Management and Orchestration.
89 - Demonstration and testing scripts for use cases.
90
91
92
93 0.1.0
94 ^^^^^
95 **Release designation**: Amber
96
97 **Release Date**: 2019-11-22
98
99 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.
100
101 For Amber release this repo contains:
102
103 - Deployment scripts for a dev-test 1-node Kubernetes cluster.
104 - Deployment scripts and Helm charts for Near Realtime RAN Intelligent Controller Platform.
105 - Deployment scripts and Helm charts for infrastructure services supporting the Near Realtime RAN Intelligent Controller Platform.
106 - Deployment scripts and Helm charts for auxiliary services and components for operating the Near Realtime RAN Intelligent Controller Platform.
107
108
109
110
111 Feature additions
112 -----------------
113
114 **JIRA BACK-LOG:**
115
116 +--------------------------------------+--------------------------------------+
117 | **JIRA REFERENCE**                   | **SLOGAN**                           |
118 |                                      |                                      |
119 +--------------------------------------+--------------------------------------+
120 |                                      |                                      |
121 |                                      |                                      |
122 |                                      |                                      |
123 +--------------------------------------+--------------------------------------+
124 |                                      |                                      |
125 |                                      |                                      |
126 |                                      |                                      |
127 +--------------------------------------+--------------------------------------+
128
129 Bug corrections
130 ----------------
131
132 **JIRA TICKETS:**
133
134 +--------------------------------------+--------------------------------------+
135 | **JIRA REFERENCE**                   | **SLOGAN**                           |
136 |                                      |                                      |
137 +--------------------------------------+--------------------------------------+
138 |                                      |                                      |
139 |                                      |                                      |
140 |                                      |                                      |
141 +--------------------------------------+--------------------------------------+
142 |                                      |                                      |
143 |                                      |                                      |
144 |                                      |                                      |
145 +--------------------------------------+--------------------------------------+
146
147
148
149 Deliverables
150 ------------
151
152 Software deliverables
153 ^^^^^^^^^^^^^^^^^^^^^
154
155 The deployment artifacts can be accessed by cloning Git repository:
156
157   git clone https://gerrit.o-ran-sc.org/r/it/dep -b cherry
158
159
160 Documentation deliverables
161 ^^^^^^^^^^^^^^^^^^^^^^^^^^
162
163 Documentation for installing, usinhg, and developing for Integraion and Testing project can be found at: 
164
165   https://docs.o-ran-sc.org/projects/o-ran-sc-it-dep/en/latest/index.html
166
167
168
169 Known Limitations, Issues, and Workarounds
170 ------------------------------------------
171
172
173 System Limitations
174 ^^^^^^^^^^^^^^^^^^
175
176
177 Known issues
178 ^^^^^^^^^^^^
179
180 **JIRA TICKETS:**
181
182 +--------------------------------------+--------------------------------------+
183 | **JIRA REFERENCE**                   | **SLOGAN**                           |
184 |                                      |                                      |
185 +--------------------------------------+--------------------------------------+
186 |                                      |                                      |
187 |                                      |                                      |
188 |                                      |                                      |
189 +--------------------------------------+--------------------------------------+
190 |                                      |                                      |
191 |                                      |                                      |
192 |                                      |                                      |
193 +--------------------------------------+--------------------------------------+
194
195 Workarounds
196 ^^^^^^^^^^^
197
198
199 References
200 ----------
201
202