Initiial documentation
[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 Version history
27 ---------------
28
29 +--------------------+--------------------+--------------------+--------------------+
30 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
31 |                    |                    |                    |                    |
32 +--------------------+--------------------+--------------------+--------------------+
33 | 2019-11-12         | 0.1.0              | Lusheng Ji         | First draft        |
34 |                    |                    |                    |                    |
35 +--------------------+--------------------+--------------------+--------------------+
36
37
38 Summary
39 =======
40
41 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.
42
43 For Amber release this repo contains: 
44
45 - Deployment scripts for a dev-test 1-node Kubernetes cluster.
46 - Deployment scripts and Helm charts for Near Realtime RAN Intelligent Controller Platform.
47 - Deployment scripts and Helm charts for infrastructure services supporting the Near Realtime RAN Intelligent Controller Platform.
48 - Deployment scripts and Helm charts for auxiliary services and components for operating the Near Realtime RAN Intelligent Controller Platform.
49
50
51
52 Release Data
53 ============
54
55 +--------------------------------------+--------------------------------------+
56 | **Project**                          | Integration and Testing              |
57 |                                      |                                      |
58 +--------------------------------------+--------------------------------------+
59 | **Repo/commit-ID**                   | it/dep                               |
60 |                                      |                                      |
61 +--------------------------------------+--------------------------------------+
62 | **Release designation**              | Amber                                |
63 |                                      |                                      |
64 +--------------------------------------+--------------------------------------+
65 | **Release date**                     | 2019-11-22                           |
66 |                                      |                                      |
67 +--------------------------------------+--------------------------------------+
68 | **Purpose of the delivery**          | First release                        |
69 |                                      |                                      |
70 +--------------------------------------+--------------------------------------+
71
72
73
74
75 Feature additions
76 -------------------
77
78 **JIRA BACK-LOG:**
79
80 +--------------------------------------+--------------------------------------+
81 | **JIRA REFERENCE**                   | **SLOGAN**                           |
82 |                                      |                                      |
83 +--------------------------------------+--------------------------------------+
84 |                                      |                                      |
85 |                                      |                                      |
86 |                                      |                                      |
87 +--------------------------------------+--------------------------------------+
88 |                                      |                                      |
89 |                                      |                                      |
90 |                                      |                                      |
91 +--------------------------------------+--------------------------------------+
92
93 Bug corrections
94 ----------------
95
96 **JIRA TICKETS:**
97
98 +--------------------------------------+--------------------------------------+
99 | **JIRA REFERENCE**                   | **SLOGAN**                           |
100 |                                      |                                      |
101 +--------------------------------------+--------------------------------------+
102 |                                      |                                      |
103 |                                      |                                      |
104 |                                      |                                      |
105 +--------------------------------------+--------------------------------------+
106 |                                      |                                      |
107 |                                      |                                      |
108 |                                      |                                      |
109 +--------------------------------------+--------------------------------------+
110
111 Deliverables
112 ============
113
114
115
116 Software deliverables
117 ---------------------
118
119 The deployment artifacts can be accessed as Debian software package:
120 https://packagecloud.io/o-ran-sc/staging/packages/debian/stretch/ric-deployment-tools_2.0.0_all.deb
121
122
123 Documentation deliverables
124 ---------------------------
125
126 Documentation for installing, usinhg, and developing for Integraion and Testing project can be found at: 
127 https://o-ran-sc-doc.readthedocs.io/projects/o-ran-sc-it-dep/en/latest/index.html
128
129 Known Limitations, Issues and Workarounds
130 =========================================
131
132 System Limitations
133 ------------------
134
135
136 Known issues
137 ------------------
138
139 **JIRA TICKETS:**
140
141 +--------------------------------------+--------------------------------------+
142 | **JIRA REFERENCE**                   | **SLOGAN**                           |
143 |                                      |                                      |
144 +--------------------------------------+--------------------------------------+
145 |                                      |                                      |
146 |                                      |                                      |
147 |                                      |                                      |
148 +--------------------------------------+--------------------------------------+
149 |                                      |                                      |
150 |                                      |                                      |
151 |                                      |                                      |
152 +--------------------------------------+--------------------------------------+
153
154 Workarounds
155 ------------------
156
157
158
159
160 References
161 ==========
162
163
164
165