Documentation for tr-069-adapter

[oam/tr069-adapter.git] / docs / overview.rst

diff --git a/docs/overview.rst b/docs/overview.rst
index 1e210bf..ed1e045 100644 (file)
--- a/docs/overview.rst
+++ b/docs/overview.rst
@@ -1,6 +1,6 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.\r
 .. SPDX-License-Identifier: CC-BY-4.0\r
-.. Copyright (C) 2020 highstreet technologies and CommScope Inc.\r
+.. Copyright (C) 2020 CommScope Inc.\r
 \r
 TR069 Adapter Overview\r
 ======================================\r
@@ -37,15 +37,17 @@ Scope
 \r
 The TR069 Adapter enables any TR-069 compliant device to be managed in the \r
 ONAP Environment by translating TR-069 messages (SOAP) to O-RAN O1 interface \r
-messages for NetConf/YANG, VES and vice versa. The TR-069 Adapter also \r
-supports translation of object models between TR Models (TR-196, TR-181) \r
-to  O-RAN O1 interface Yang Models.\r
+messages for NetConf/YANG and vice versa. Also converting TR-069 BootStrap, \r
+Alarm Value changes to VES pnfRegstration and VES Faults respectively. \r
+The TR-069 Adapter also  supports translation of object models between \r
+TR Models (TR-196, TR-181) to  O-RAN O1 interface Yang Models.\r
 \r
 \r
 TR-069Adapter Overview\r
 ----------------------\r
 \r
-The following image shows how the BBF-TR069 Device, TR-069Adapter, SDN-R, and DMaap are connected.Each component depicted in the image is briefly described further below:\r
+The following image shows how the BBF-TR069 Device, TR-069Adapter, SDN-R, and DMaap are connected. \r
+Each component depicted in the image is briefly described further below:\r
 \r
 \r
 .. image:: _static/TR-069AdapterOverview.png\r
@@ -54,7 +56,8 @@ The following image shows how the BBF-TR069 Device, TR-069Adapter, SDN-R, and DM
 Maria DB\r
 --------\r
 \r
-The Maria DB container instance is used to support data persistence for the TR-069Adapter, such as Factory Table, Initial PnP Config Table, TR-069 Session and Device Connection Request URL information.\r
+The Maria DB container instance is used to support data persistence for the TR-069Adapter covering \r
+Initial PnP Configuration Data, TR-069 Session Data and Device Connection Request URL information.\r
 \r
 ACS\r
 ---\r
@@ -64,15 +67,15 @@ The Auto Configuration Service (ACS) Module is used to communicate with the Devi
 Factory\r
 -------\r
 \r
-This module supports Rest APIs to authenticate Device TR-069 sessions using basic authentication. It also supports REST APIs to import a Factory Equipment  file which contains Device authentication information. \r
+This module supports Rest APIs to authenticate Device TR-069 sessions using basic authentication. \r
 \r
 Initial Config\r
 --------------\r
 \r
-This module supports importing 3GPP Config XML for Device. The configurations from XML are used to provision as Initial PnP Parameters to devices as part of BootStrap. This module also supports REST APIs to import Config XML which contains Device Initial PnP Configurations. The initial PnP Parameters are optional and could be used to emulate PnP using TR-069Adapter.\r
+This module supports importing 3GPP Configuration XML (3GPP TS 32.594) for Device. The configurations from XML are used to provision as Initial PnP Parameters to devices as part of BootStrap. This module also supports REST APIs to import Config XML which contains Device Initial PnP Configurations. The initial PnP Parameters are optional and could be used to emulate PnP using TR-069Adapter.\r
 \r
-Mapper\r
-------\r
+TR-069 to NETCONF Mapper\r
+------------------------\r
 \r
 The main function of this mapper is to map the request between NETCONF server and ACS (conversion of NETCONF protocol specific message to TR-069 message and vice versa) and to forward notifications to the VES Notifier.\r
 \r