Merge "OAuth2 support"
[pti/o2.git] / docs / overview.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-2022 Wind River Systems, Inc.
4
5 INF O2 Service Overview
6 =======================
7
8 This project implements a reference O-RAN O2 IMS and DMS service to
9 expose the INF platform to SMO via the O-RAN O2 interface.
10
11 In the G release, the following APIs are supported by the INF O2
12 service:
13
14 1. INF O2 service Infrastructure Management Service (IMS)
15
16    -  INF O2 service Inventory API
17
18       -  O2 service discovers following resources of INF platform to
19          answer queries from SMO
20
21          -  INF platform information
22          -  Resource Pool of the INF platform
23          -  Resources of the Resource Pool, including pserver, cpu, memory, interface, accelerator
24          -  Resource Types associated with Resources
25
26       -  INF platform Subscription and Notification
27
28          -  INF O2 service exposes Subscription API to enable SMO
29             subscribes to Notification of changes of resources
30
31       -  INF platform Deployment Management Service profile queries API
32
33          -  INF O2 service enables lookup of INF Native Kubernetes API information as part of inventory
34
35    -  INF O2 service Monitoring API
36
37       -  O2 service discovers alarms of INF platform to answer queries from SMO
38
39          -  INF alarm event record information
40
41       -  INF alarm Subscription and Notification
42
43          -  INF O2 service exposes alarm Subscription API to enable SMO
44             subscribes to Notification of changes of alarms
45