Update docs

Issue-ID: INF-247

Signed-off-by: Bin Yang <bin.yang@windriver.com>
Change-Id: I962b63b989c7b99173b6a74e5ef547671cb58372
(cherry picked from commit f69bcfa4e53700f89b2a82456602f472f92f40a8)

diff --git a/docs/overview.rst b/docs/overview.rst
index 036e77c..1378d51 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 O2 IMS and DMS service to expose INF platform to SMO via O2 interface.
 
-In the E release, the following API of O2 interface is enabled:
+In the E release, the following APIs are supported by INF O2 service:
 
-1. O-Cloud registration and inventory query
+1. O-Cloud Infrastructure Management Service
 
-   - O2 service discovers INF platform as O-Cloud, register the O-Cloud to SMO with provisioned SMO O2 endpoint.
+   - O-Cloud 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 as O-Cloud and register INF as O-Cloud to SMO via the provisioned SMO O2 endpoint
 
-   - O2 service discovers following resources of INF platform to answer queries from SMO
+   - O-Cloud Inventory API
 
-     - O-Cloud information
+     - O2 service discovers following resources of INF platform to answer queries from SMO
 
-     - Resource Pool of the O-Cloud
+       - O-Cloud information
 
-     - Resources of the Resource Pool, including pserver, cpu, memory, port, interface
+       - Resource Pool of the O-Cloud
 
-     - 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
+    - O-Cloud Subscription and Notification
 
-   - O2 service expose DMS on behalf of kubernetes API endpoint hosted by INF platform, which support NfDeployment described by Helm charts
+      - O2 service exposes Subscription API to enable SMO subscribes to Notification of changes of resources
 
-     - Management of NfDeploymentDescriptor
+    - O-Cloud Deployment Management Service Endpoint discovery API
 
-     - Management of NfDeployment
+      - O2 service enables lookup of O-Cloud DMS endpoints via DeploymentManagementService resource as part of inventory
 
+2. Deployment Management Service
 
-3. Subscription and Notification
+   - O2 service discovers kubernetes clusters hosted by INF platform, exposes them as Deployment Management Services via O-Cloud 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

diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index 0988143..c97068c 100644 (file)
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -1,13 +1,13 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. SPDX-License-Identifier: CC-BY-4.0
-.. Copyright (C) 2019 Wind River Systems, Inc.
+.. Copyright (C) 2021 Wind River Systems, Inc.
 
 
 Release-notes
 =============
 
 
-This document provides the release notes for 5.0.0 of RTP O2 service.
+This document provides the release notes for 1.0.0 of INF O2 service.
 
 .. contents::
    :depth: 3
@@ -32,8 +32,8 @@ Version 1.0.0, 2021-12-15
   - Enable O-Cloud registration to SMO
   - Enable O2 infrastructure inventory service API
   - Enable O2 Subscription service API
-  - Enable O2 Notification service
+  - Enable O2 Notification service to notify SMO about the resource changes
 - ADD O2 DMS for INF platform
-  - A PoC which enables NfDeployment described with helm charts
-  - Add Lifecycle Management API for NfDeploymentDescriptor
+  - A PoC which enables Lifecycle management of NfDeployment represents CNF described with helm chart
+  - Add Lifecycle Management API for NfDeploymentDescriptor which represents a helm chart for NfDeployment
   - Add Lifecycle Management API for NfDeployment