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