From: Gilles Thouenon Date: Thu, 5 Mar 2020 17:47:17 +0000 (+0100) Subject: Update documentation diagram with otn xponder X-Git-Tag: 2.0.0~137 X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=transportpce.git;a=commitdiff_plain;h=93af0da42e5e9e5b797b76c59fa568810df7f9ba Update documentation diagram with otn xponder and improve the inventory documentation. Signed-off-by: Gilles Thouenon Change-Id: I7932a107e2b8a5da77f48ee7dcce20d8be5ae417 --- diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst index 0373550b6..bc0927920 100644 --- a/docs/developer-guide.rst +++ b/docs/developer-guide.rst @@ -209,7 +209,7 @@ The database properties are supplied in the “opendaylight-release” and “op Below is the settings.xml with properties included in the distribution. The module can be rebuild from sources with different parameters. -Sample entry in settings.xml to include inventory: +Sample entry in settings.xml to declare an external inventory database: :: @@ -239,10 +239,10 @@ Sample entry in settings.xml to include inventory: -Once the project built and when karaf is started, the cfg file is generated in etc folder with the corresponding properties -supplied in settings.xml. When devices with OpenROADM 1.2.1 device model are mounted, the device listener in the inventory -module loads several device attributes to various tables as per the supplied database. -The databsase structure details can be retrieved from the file tests/inventory/initdb.sql in project sources. +Once the project built and when karaf is started, the cfg file is generated in etc folder with the corresponding +properties supplied in settings.xml. When devices with OpenROADM 1.2.1 device model are mounted, the device listener in +the inventory module loads several device attributes to various tables as per the supplied database. +The database structure details can be retrieved from the file tests/inventory/initdb.sql inside project sources. Installation scripts and a docker file are also provided. Key APIs and Interfaces diff --git a/docs/images/TransportPCE-Diagramm-Magnesium.jpg b/docs/images/TransportPCE-Diagramm-Magnesium.jpg index 388a9a3d7..dce308b29 100644 Binary files a/docs/images/TransportPCE-Diagramm-Magnesium.jpg and b/docs/images/TransportPCE-Diagramm-Magnesium.jpg differ diff --git a/docs/user-guide.rst b/docs/user-guide.rst index 9f3966d41..6cb4eac7e 100644 --- a/docs/user-guide.rst +++ b/docs/user-guide.rst @@ -52,8 +52,8 @@ TransportPCE User-Facing Features - **feature odl-transportpce-inventory** - - This feature is considered experimental. - It provides transportPCE an external connector to a MariaDB inventory currently limited to OpenROADM 1.2.1 devices. + - This feature is considered experimental. It provides transportPCE with an external connector to + a MariaDB inventory currently limited to OpenROADM 1.2.1 devices. How To Start ------------