Release image 0.4.15
[ric-plt/rtmgr.git] / docs / release-notes.rst
1 ..
2 ..  Copyright (c) 2019 AT&T Intellectual Property.
3 ..  Copyright (c) 2019 Nokia.
4 ..
5 ..  Licensed under the Creative Commons Attribution 4.0 International
6 ..  Public License (the "License"); you may not use this file except
7 ..  in compliance with the License. You may obtain a copy of the License at
8 ..
9 ..    https://creativecommons.org/licenses/by/4.0/
10 ..
11 ..  Unless required by applicable law or agreed to in writing, documentation
12 ..  distributed under the License is distributed on an "AS IS" BASIS,
13 ..  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 ..
15 ..  See the License for the specific language governing permissions and
16 ..  limitations under the License.
17 ..
18
19
20 Release-Notes
21 =============
22
23
24 This document provides the release notes for O-RAN SC Amber Release of ric-plt/rtmgr.
25
26 .. contents::
27    :depth: 3
28    :local:
29
30 Version history
31 ---------------
32
33 Version 1.0.0, November 12, 2019
34 --------------------------------
35 * Populates the RMR routing table between the RIC platform component pairs E2Term,Subscription Manager and E2Term,E2Manager
36 * Queries xAppManager for the deployed xApps and populates the RMR routing table between the xApps,Subscription Manager
37 * Populates routes based on the subscription ID between xApps,Subscription Manager
38
39 Components
40 ----------
41 * /api: contains Swagger spec files
42 * /manifest: contains deployment files (Kubernetes manifests, Helm chart)
43 * /cmd: contains go project's main file
44 * /pkg: contains go project's internal packages
45 * /test: contains CI/CD testing files (scripts, mocks, manifests)
46 * Dockerfile: contains main docker file
47 * container-tag.yaml: contains CI specific container tag information
48 * run_rtmgr.sh: shell script to run rtmgr (requires environment variables to be set)
49
50 Current implementation provides support for the followings:
51
52 * NBI:
53   * __httpGet__: simple HTTP GET interface. Expects an URL where it gets the xApps' list in JSON format
54   * __httRESTful__: provides REST API endpoints towards RIC manager components. Expects REST port and url where the HTTP service will be started to listen on.
55
56 * RPE:
57   * __rmr__: creates routing policies formatted for RIC RMR
58
59 * SDL:
60   * __file__: stores xApp data in container's local filesystem (or in a mountpoint)
61   * (backlog) __sdl__: Shared Data Library to Redis database
62
63 * SBI:
64   * __nngpub__: distributes RPE created policies via NNG Pub channel
65   * __nngpipe__: distributes RPE created policies via NNG Pipeline channel
66
67
68 Limitations
69 -----------