e59befebc30452df5c3fb94193f4cb4e0ee3646b
[sim/o1-interface.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 .. Copyright (C) 2019 highstreet technologies GmbH and others
4
5
6 Release Notes
7 =============
8
9
10 This document provides the release notes for Amber of sim/o1-interface.
11
12 .. contents::
13    :depth: 3
14    :local:
15
16
17 Version history
18 ---------------
19
20 +--------------------+--------------------+--------------------+--------------------+
21 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
22 |                    |                    |                    |                    |
23 +--------------------+--------------------+--------------------+--------------------+
24 | 2019-11-13         | 0.0.1              |  Alex Stancu       | First draft        |
25 |                    |                    |                    |                    |
26 +--------------------+--------------------+--------------------+--------------------+
27
28
29 Summary
30 -------
31
32 The O1 interface simulator is a framework that provides simulated devices with a management plane exposed through a NETCONF/YANG interface, using the O-RAN O1 interface YANG modules.
33
34
35 Release Data
36 ------------
37 N/A
38
39 Feature Additions
40 ^^^^^^^^^^^^^^^^^
41 N/A
42
43 Bug Corrections
44 ^^^^^^^^^^^^^^^
45
46 N/A
47
48 Deliverables
49 ^^^^^^^^^^^^
50
51 Software Deliverables
52 +++++++++++++++++++++
53
54 Two docker containers are the resulting artefacts of the sim-o1-project:
55
56 * **sim-o1-interface-manager** - this image contains the NTS Manager, which handles the simulation environment;
57
58 * **sim-o1-interface-device** - this image contains a simulated device which exposes a management interface via NETCONF/YANG, implementing the O1 interface specifications.
59
60
61 Documentation Deliverables
62 ++++++++++++++++++++++++++
63
64
65 Known Limitations, Issues and Workarounds
66 -----------------------------------------
67 N/A
68
69 System Limitations
70 ^^^^^^^^^^^^^^^^^^
71 N/A
72
73 Known Issues
74 ^^^^^^^^^^^^
75 N/A
76
77 Workarounds
78 ^^^^^^^^^^^
79 N/A
80
81
82 References
83 ----------
84 `NTS Project <https://github.com/Melacon/ntsim>`_
85
86
87