Release pti-o2imsdms 2.0.1 image

[pti/o2.git] / docs / overview.rst

diff --git a/docs/overview.rst b/docs/overview.rst
index 036e77c..4ab4f1d 100644 (file)
--- a/docs/overview.rst
+++ b/docs/overview.rst
@@ -1,46 +1,45 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. SPDX-License-Identifier: CC-BY-4.0
-.. Copyright (C) 2021 Wind River Systems, Inc.
+.. Copyright (C) 2021-2022 Wind River Systems, Inc.
 
 INF O2 Service Overview
 =======================
 
-This project implements a reference O2 IMS and DMS service to expose O2 interface to SMO.
+This project implements a reference O-RAN O2 IMS and DMS service to
+expose the INF platform to SMO via the O-RAN O2 interface.
 
-In the E release, the following API of O2 interface is enabled:
+In the G release, the following APIs are supported by the INF O2
+service:
 
-1. O-Cloud registration and inventory query
+1. INF O2 service Infrastructure Management Service (IMS)
 
-   - O2 service discovers INF platform as O-Cloud, register the O-Cloud to SMO with provisioned SMO O2 endpoint.
+   -  INF O2 service Inventory API
 
-     - Provision SMO O2 endpoint
+      -  O2 service discovers following resources of INF platform to
+         answer queries from SMO
 
-     - Register INF as O-Cloud to SMO via SMO O2 endpoint
+         -  INF platform information
+         -  Resource Pool of the INF platform
+         -  Resources of the Resource Pool, including pserver, cpu, memory, interface, accelerator
+         -  Resource Types associated with Resources
 
-   - O2 service discovers following resources of INF platform to answer queries from SMO
+      -  INF platform Subscription and Notification
 
-     - O-Cloud information
+         -  INF O2 service exposes Subscription API to enable SMO
+            subscribes to Notification of changes of resources
 
-     - Resource Pool of the O-Cloud
+      -  INF platform Deployment Management Service profile queries API
 
-     - Resources of the Resource Pool, including pserver, cpu, memory, port, interface
+         -  INF O2 service enables lookup of INF Native Kubernetes API information as part of inventory
 
-     - kubernetes API endpoint as Deployment Management Service
+   -  INF O2 service Monitoring API
 
+      -  O2 service discovers alarms of INF platform to answer queries from SMO
 
-2. Deployment Management Service
+         -  INF alarm event record information
 
-   - O2 service expose DMS on behalf of kubernetes API endpoint hosted by INF platform, which support NfDeployment described by Helm charts
+      -  INF alarm Subscription and Notification
 
-     - Management of NfDeploymentDescriptor
+         -  INF O2 service exposes alarm Subscription API to enable SMO
+            subscribes to Notification of changes of alarms
 
-     - Management of NfDeployment
-
-
-3. Subscription and Notification
-
-   - O2 service exposes Subscription API to enable SMO subscribes to Notification of changes of resources
-
-     - Management of Subscriptions
-
-     - Notification delivery via Rest API provided by specific Subscriptions