Fix: INF-253 o2 api failed after too many queries (part 2)

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

diff --git a/docs/overview.rst b/docs/overview.rst
index 036e77c..00b9ea8 100644 (file)
--- a/docs/overview.rst
+++ b/docs/overview.rst
@@ -5,42 +5,44 @@
 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 E 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 provisioning API
 
-     - Provision SMO O2 endpoint
+     - Provision SMO O2 endpoint into INF O2 service
 
-     - Register INF as O-Cloud to SMO via SMO O2 endpoint
+     - O2 service discovers INF platform and registers INF platform to SMO via the provisioned SMO O2 endpoint
 
-   - O2 service discovers following resources of INF platform to answer queries from SMO
+   - INF O2 service Inventory API
 
-     - O-Cloud information
+     - O2 service discovers following resources of INF platform to answer queries from SMO
 
-     - Resource Pool of the O-Cloud
+       - INF platform information
 
-     - Resources of the Resource Pool, including pserver, cpu, memory, port, interface
+       - Resource Pool of the INF platform
 
-     - kubernetes API endpoint as Deployment Management Service
+       - Resources of the Resource Pool, including pserver, cpu, memory, port, interface
 
+       - Resource Types associated with Resources
 
-2. Deployment Management Service
+    - INF platform Subscription and Notification
 
-   - O2 service expose DMS on behalf of kubernetes API endpoint hosted by INF platform, which support NfDeployment described by Helm charts
+      - INF O2 service exposes Subscription API to enable SMO subscribes to Notification of changes of resources
 
-     - Management of NfDeploymentDescriptor
+    - INF platform Deployment Management Service Endpoint discovery API
 
-     - Management of NfDeployment
+      - INF O2 service enables lookup of INF O2 DMS endpoints via DeploymentManagementService resource as part of inventory
 
+2. INF O2 service Deployment Management Service (DMS)
 
-3. Subscription and Notification
+   - INF O2 service discovers kubernetes clusters hosted by INF platform, exposes them as Deployment Management Services via DMS endpoints
 
-   - O2 service exposes Subscription API to enable SMO subscribes to Notification of changes of resources
+   - The exposed DMS endpoint supports Lifecycle Management of NfDeployment which represents CNF described in helm chart, the API supports APIs below:
 
-     - Management of Subscriptions
+     - Management of NfDeploymentDescriptor
 
-     - Notification delivery via Rest API provided by specific Subscriptions
+     - Management of NfDeployment