Bump up patch version 2.0.5
[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.3 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 | 2024-06-15 | 2.0.4    | Jon Zhang, Jackie Huang, Joshua Kraitberg    | J Release   |
24 +------------+----------+----------------------------------------------+-------------+
25 | 2023-12-15 | 2.0.3    | Jon Zhang, Jackie Huang                      | I Release   |
26 +------------+----------+----------------------------------------------+-------------+
27 | 2023-06-15 | 2.0.2    | Jon Zhang, Jackie Huang                      | H Release   |
28 +------------+----------+----------------------------------------------+-------------+
29 | 2022-12-15 | 2.0.1    | Bin Yang, Jon Zhang, Jackie Huang, David Liu | G Release   |
30 +------------+----------+----------------------------------------------+-------------+
31 | 2022-06-15 | 1.0.1    | Bin Yang, Jon Zhang                          | F Release   |
32 +------------+----------+----------------------------------------------+-------------+
33 | 2021-12-15 | 1.0.0    | Bin Yang, Jon Zhang                          | E Release   |
34 +------------+----------+----------------------------------------------+-------------+
35
36 Version 2.0.4, 2024-06-15
37 -------------------------
38
39 -  Upgrade Monitoring API
40
41    -  Support SMO's requests of alarm event acknowledgment and clearing
42
43 -  Support mTLS for API endpoint
44
45    -  Support mutual TLS for API endpoint
46
47 -  Support authentication with OAuth2 token of API
48
49    -  Support OAuth2 token for API authentication
50
51 -  Other updates
52
53    -  Bugs fixed
54
55 Version 2.0.3, 2023-12-15
56 -------------------------
57
58 -  Bugs fixed
59 -  Updated base image plus Python to 3.11
60
61 Version 2.0.2, 2023-06-15
62 -------------------------
63
64 -  Upgrade Inventory API
65
66    -  Support capabilities attribute of the DMS query to support the
67       PlugFest with SMO integration
68
69 -  Update the Subscription and Notification part
70
71    -  Adding the oAuth2 configuration for the O2 service query the SMO
72    -  Registration and notification to SMO support oAuth2 verification
73    -  Rewrite the subscription filter part
74
75 -  Specification compliance
76
77    -  Compliance to "O-RAN.WG6.O2IMS-INTERFACE-R003-v04.00"
78    -  Adding InfrastructureInventoryObject abstract class
79
80 -  Other updates
81
82    -  Bugs fixed
83
84 Version 2.0.1, 2022-12-15
85 -------------------------
86
87 -  Upgrade Inventory API, and add Monitoring API
88
89    -  Support HTTPS/TLS for API endpoint
90    -  Support authentication with token of API
91    -  Add "api_version" query in base API
92    -  Add "O2IMS_InfrastructureMonitoring" API part
93    -  Support Attribute-based selectors, and API query filter parameters
94       following the specification
95    -  Updating error handling of all the API queries
96
97 -  Update the Subscription and Notification part
98
99    -  Notification SMO and register O-Cloud when the application starts
100       with SMO configuration
101    -  Support subscription inventory change or alarm notification with
102       the filter parameter
103
104 -  Specification compliance
105
106    -  Compliance to "O-RAN.WG6.O2IMS-INTERFACE\ 2v03.0"
107    -  Updating modeling, including ResourcePool, ResourceInfo,
108       DeploymentManager, ResourceType, Notification, O-Cloud,
109       AlarmEventRecord, AlarmDictorary, and AlarmDefinition
110    -  Adding Accelerators as a resource; adding virtual resource type
111
112 -  Other updates
113
114    -  Add configuration file load at application starts
115    -  Fix bugs
116    -  Replace POC O2DMS APIs with Kubernetes Native API Profile for
117       Containerized NFs
118
119 Version 1.0.1, 2022-06-15
120 -------------------------
121
122 -  Add Distributed Cloud(DC) supported
123
124    -  Enable multiple ResourcePool support in DC mode
125    -  Enable multiple DeploymentManager support in DC mode
126
127 -  Add O2 DMS profiles
128
129    -  Support native_k8sapi profile that can get native Kubernetes API
130       information
131    -  Support SOL018 specification, it includes native Kubernetes API
132       profile and Helm CLI profile, "sol018", and "sol018_helmcli"
133
134 Version 1.0.0, 2021-12-15
135 -------------------------
136
137 -  Initial version (E release)
138 -  Add O2 IMS for INF platform
139
140    -  Enable INF platform registration to SMO
141    -  Enable O2 infrastructure inventory service API
142    -  Enable O2 Subscription service API
143    -  Enable O2 Notification service to notify SMO about the resource
144       changes
145
146 -  ADD O2 DMS for INF platform
147
148    -  A PoC which enables Lifecycle management of NfDeployment
149       represents CNF described with helm chart
150    -  Add Lifecycle Management API for NfDeploymentDescriptor which
151       represents a helm chart for NfDeployment
152    -  Add Lifecycle Management API for NfDeployment