From: Alex Stancu Date: Mon, 15 Jun 2020 10:07:42 +0000 (+0300) Subject: Add release notes information. X-Git-Tag: 0.6.1~1 X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?p=sim%2Fo1-interface.git;a=commitdiff_plain;h=58ab2804474c6776a3cc95cb3693e219b953db21 Add release notes information. Issue-ID: SIM-20 Change-Id: I004b13cd067b65d7578c4d99993f88d950599fce Signed-off-by: Alex Stancu --- diff --git a/docs/release-notes.rst b/docs/release-notes.rst index e59befe..516a823 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -7,7 +7,7 @@ Release Notes ============= -This document provides the release notes for Amber of sim/o1-interface. +This document provides the release notes for the sim/o1-interface project. .. contents:: :depth: 3 @@ -21,7 +21,10 @@ Version history | **Date** | **Ver.** | **Author** | **Comment** | | | | | | +--------------------+--------------------+--------------------+--------------------+ -| 2019-11-13 | 0.0.1 | Alex Stancu | First draft | +| 2020-06-08 | 0.6.1 | Alex Stancu | Bronze release | +| | | | | ++--------------------+--------------------+--------------------+--------------------+ +| 2019-11-13 | 0.0.1 | Alex Stancu | First draft - Amber| | | | | | +--------------------+--------------------+--------------------+--------------------+ @@ -38,12 +41,15 @@ N/A Feature Additions ^^^^^^^^^^^^^^^^^ -N/A +* IPv6 for the simulated devices +* NETCONF CallHome for the simulated devices +* Manual notification generation +* Custom naming of the simulated devices Bug Corrections ^^^^^^^^^^^^^^^ - -N/A +* `ssh-connections` and `tls-connections` leafs are now removed from the simulator-config +* `fault-notification-delay-period` has now the attribute `ordered-by user` Deliverables ^^^^^^^^^^^^ @@ -51,11 +57,15 @@ Deliverables Software Deliverables +++++++++++++++++++++ -Two docker containers are the resulting artefacts of the sim-o1-project: +The following docker containers are the resulting artefacts of the sim-o1-project: + +* **o-ran-sc/ntsim-manager** - this image contains the NTS Manager, which handles the simulation environment; + +* **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; -* **sim-o1-interface-manager** - this image contains the NTS Manager, which handles the simulation environment; +* **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; -* **sim-o1-interface-device** - this image contains a simulated device which exposes a management interface via NETCONF/YANG, implementing the O1 interface specifications. +* **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. Documentation Deliverables diff --git a/ntsimulator/README.md b/ntsimulator/README.md index 0e956ed..f2f101e 100644 --- a/ntsimulator/README.md +++ b/ntsimulator/README.md @@ -116,7 +116,7 @@ module: network-topology-simulator * **is-netconf-available** - if set to 'True', NETCONF notifications will be sent when a random fault notification is generated, The NETCONF notification that is being sent is currently *o-ran-fm:alarm-notif*; if set to 'False', NETCONF notifications are not being sent out; * **is-ves-available** - if set to 'True', VES *faultNotification* messages will be sent when a random fault notification is generated; if set to 'False', VES *faultNotification* messages are not generated; * **controller-details** - this container groups the configuration related to the ODL based SDN controller that the simulated devices can connect to; -* **controller-ip** - the IP address of the ODL based SDN controller where the simulated devices can be mounted. Only IPv4 is supported currently; +* **controller-ip** - the IP address of the ODL based SDN controller where the simulated devices can be mounted. Both IPv4 and IPv6 are supported; * **controller-port** - the port of the ODL based SDN controller; * **netconf-call-home-port** - the NETCONF Call Home port of the ODL based SDN controller; * **controller-username** - the username to be used when connecting to the ODL based SDN controller; @@ -238,6 +238,7 @@ services: ControllerPort: 8181 ControllerUsername: "admin" ControllerPassword: "admin" + IPv6Enabled: "true" ``` @@ -274,6 +275,7 @@ services: * **ControllerUsername** - this can change the default value of the **controller-username** leaf used by the NTS Manager. The default is `admin`. * **ControllerPassword** - this can change the default value of the **controller-password** leaf used by the NTS Manager. The default is `admin`. * **NetconfCallHome** - this can change the default value of the **netconf-call-home** leaf used by the NTS Manager. The default is `false`. + * **IPv6Enabled**: if this is set to `true`, IPv6 is enabled. **Please note that for a working configuration, it is the user responsibility to correctly configure the Docker daemon to work with IPv6, prior to starting the NTS Manager!** After modifying the `docker-compose.yml` file with values specific to your host, the NTS Manager can be started by running the command `docker-compose up` from the **scripts** folder.