516a823fbcab37854187f80ad9f70fa16743e2d6
[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 the sim/o1-interface project.
11
12 .. contents::
13    :depth: 3
14    :local:
15
16
17 Version history
18 ---------------
19
20 +--------------------+--------------------+--------------------+--------------------+
21 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
22 |                    |                    |                    |                    |
23 +--------------------+--------------------+--------------------+--------------------+
24 | 2020-06-08         | 0.6.1              |  Alex Stancu       | Bronze release     |
25 |                    |                    |                    |                    |
26 +--------------------+--------------------+--------------------+--------------------+
27 | 2019-11-13         | 0.0.1              |  Alex Stancu       | First draft - Amber|
28 |                    |                    |                    |                    |
29 +--------------------+--------------------+--------------------+--------------------+
30
31
32 Summary
33 -------
34
35 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.
36
37
38 Release Data
39 ------------
40 N/A
41
42 Feature Additions
43 ^^^^^^^^^^^^^^^^^
44 * IPv6 for the simulated devices
45 * NETCONF CallHome for the simulated devices
46 * Manual notification generation
47 * Custom naming of the simulated devices
48
49 Bug Corrections
50 ^^^^^^^^^^^^^^^
51 * `ssh-connections` and `tls-connections` leafs are now removed from the simulator-config
52 * `fault-notification-delay-period` has now the attribute `ordered-by user`
53
54 Deliverables
55 ^^^^^^^^^^^^
56
57 Software Deliverables
58 +++++++++++++++++++++
59
60 The following docker containers are the resulting artefacts of the sim-o1-project:
61
62 * **o-ran-sc/ntsim-manager** - this image contains the NTS Manager, which handles the simulation environment;
63
64 * **o-ran-sc/ntsim-o-ran-ru-fh** - this image contains a simulated device which exposes a management interface via NETCONF/YANG, implementing the O1 FH interface specifications;
65
66 * **o-ran-sc/ntsim-o-ran-sc-o-ran-ru** - this image contains a simulated device which exposes a management interface via NETCONF/YANG, implementing the O-RAN-SC O-RU Management interface defined by the OAM project;
67
68 * **o-ran-sc/ntsim-x-ran** - this image contains a simulated device which exposes a management interface via NETCONF/YANG, implementing the X-RAN Management interface.
69
70
71 Documentation Deliverables
72 ++++++++++++++++++++++++++
73
74
75 Known Limitations, Issues and Workarounds
76 -----------------------------------------
77 N/A
78
79 System Limitations
80 ^^^^^^^^^^^^^^^^^^
81 N/A
82
83 Known Issues
84 ^^^^^^^^^^^^
85 N/A
86
87 Workarounds
88 ^^^^^^^^^^^
89 N/A
90
91
92 References
93 ----------
94 `NTS Project <https://github.com/Melacon/ntsim>`_
95
96
97