Docs: update the h-release notes and the API docs
[pti/o2.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) 2021-2023 Wind River Systems, Inc.
4
5
6 Release-notes
7 =============
8
9
10 This document provides the release notes for 2.0.2 of INF O2 service.
11
12 .. contents::
13    :depth: 3
14    :local:
15
16
17 Version History
18 ---------------
19
20 +------------+----------+----------------------------------------------+-------------+
21 | **Date**   | **Ver.** | **Author**                                   | **Comment** |
22 +------------+----------+----------------------------------------------+-------------+
23 | 2023-06-15 | 2.0.2    | Jon Zhang, Jackie Huang                      | H Release   |
24 +------------+----------+----------------------------------------------+-------------+
25 | 2022-12-15 | 2.0.1    | Bin Yang, Jon Zhang, Jackie Huang, David Liu | G Release   |
26 +------------+----------+----------------------------------------------+-------------+
27 | 2022-06-15 | 1.0.1    | Bin Yang, Jon Zhang                          | F Release   |
28 +------------+----------+----------------------------------------------+-------------+
29 | 2021-12-15 | 1.0.0    | Bin Yang, Jon Zhang                          | E Release   |
30 +------------+----------+----------------------------------------------+-------------+
31
32 Version 2.0.2, 2023-06-15
33 -------------------------
34
35 -  Upgrade Inventory API
36
37    -  Support capabilities attribute of the DMS query to support the
38       PlugFest with SMO integration
39
40 -  Update the Subscription and Notification part
41
42    -  Adding the oAuth2 configuration for the O2 service query the SMO
43    -  Registration and notification to SMO support oAuth2 verification
44    -  Rewrite the subscription filter part
45
46 -  Specification compliance
47
48    -  Compliance to "O-RAN.WG6.O2IMS-INTERFACE-R003-v04.00"
49    -  Adding InfrastructureInventoryObject abstract class
50
51 -  Other updates
52
53    -  Bugs fixed
54
55 Version 2.0.1, 2022-12-15
56 -------------------------
57
58 -  Upgrade Inventory API, and add Monitoring API
59
60    -  Support HTTPS/TLS for API endpoint
61    -  Support authentication with token of API
62    -  Add "api_version" query in base API
63    -  Add "O2IMS_InfrastructureMonitoring" API part
64    -  Support Attribute-based selectors, and API query filter parameters
65       following the specification
66    -  Updating error handling of all the API queries
67
68 -  Update the Subscription and Notification part
69
70    -  Notification SMO and register O-Cloud when the application starts
71       with SMO configuration
72    -  Support subscription inventory change or alarm notification with
73       the filter parameter
74
75 -  Specification compliance
76
77    -  Compliance to "O-RAN.WG6.O2IMS-INTERFACE\ 2v03.0"
78    -  Updating modeling, including ResourcePool, ResourceInfo,
79       DeploymentManager, ResourceType, Notification, O-Cloud,
80       AlarmEventRecord, AlarmDictorary, and AlarmDefinition
81    -  Adding Accelerators as a resource; adding virtual resource type
82
83 -  Other updates
84
85    -  Add configuration file load at application starts
86    -  Fix bugs
87    -  Replace POC O2DMS APIs with Kubernetes Native API Profile for
88       Containerized NFs
89
90 Version 1.0.1, 2022-06-15
91 -------------------------
92
93 -  Add Distributed Cloud(DC) supported
94
95    -  Enable multiple ResourcePool support in DC mode
96    -  Enable multiple DeploymentManager support in DC mode
97
98 -  Add O2 DMS profiles
99
100    -  Support native_k8sapi profile that can get native Kubernetes API
101       information
102    -  Support SOL018 specification, it includes native Kubernetes API
103       profile and Helm CLI profile, "sol018", and "sol018_helmcli"
104
105 Version 1.0.0, 2021-12-15
106 -------------------------
107
108 -  Initial version (E release)
109 -  Add O2 IMS for INF platform
110
111    -  Enable INF platform registration to SMO
112    -  Enable O2 infrastructure inventory service API
113    -  Enable O2 Subscription service API
114    -  Enable O2 Notification service to notify SMO about the resource
115       changes
116
117 -  ADD O2 DMS for INF platform
118
119    -  A PoC which enables Lifecycle management of NfDeployment
120       represents CNF described with helm chart
121    -  Add Lifecycle Management API for NfDeploymentDescriptor which
122       represents a helm chart for NfDeployment
123    -  Add Lifecycle Management API for NfDeployment